Quickstart

The API v1 base URL is https://api.neural4d.com/openapi/v1. This guide uses text-to-3D to show the core workflow.

1. Set your API key

Use an account with an active paid subscription to get your key from the API key page.

2. Create a 3D generation task

Submit a prompt to generate a textured 3D model. Send your key in the Authorization: Bearer header with every request.

cURL

curl --request POST \
  --url 'https://api.neural4d.com/openapi/v1/3dmodels/generations' \
  --header "Authorization: Bearer ${YOUR_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "dreamtech/neural4d-2.5",
    "prompt": "A ceramic teapot on a white studio background",
    "with_texture": true
  }'

The API returns 202 Accepted. Save the task id for the next step.

202 Accepted

{
  "id": "normal-3d-c50fe63e-699d-4d61-93f5-2099ab159d6d",
  "status": "queued",
  "created_at": 1784044800,
  "mode": "text_to_3d",
  "model": "dreamtech/neural4d-2.5",
  "data": [
    {
      "uuid": "72e30159-a242-4491-a67c-2ad0cfc9efb6",
      "status": "queued",
      "created_at": 1784044800
    }
  ],
  "usage": {
    "credits": 30
  }
}

3. Retrieve and download the result

Replace the sample id with the value returned when you created the task, then query every few seconds. queued and processing mean the task is still running. Stop at succeeded or failed; check error if it failed.

cURL

curl --request GET \
  --url 'https://api.neural4d.com/openapi/v1/tasks/task-info?id=normal-3d-c50fe63e-699d-4d61-93f5-2099ab159d6d' \
  --header "Authorization: Bearer ${YOUR_API_KEY}"

200 OK

{
  "id": "normal-3d-c50fe63e-699d-4d61-93f5-2099ab159d6d",
  "status": "succeeded",
  "model": "dreamtech/neural4d-2.5",
  "created_at": 1784044800,
  "updated_at": 1784044842,
  "mode": "text_to_3d",
  "output": {
    "models": [
      {
        "uuid": "72e30159-a242-4491-a67c-2ad0cfc9efb6",
        "format": "glb",
        "model_urls": {
          "glb": "https://s3.neural4d.com/results/model.glb"
        },
        "thumbnail_urls": {
          "front": "https://s3.neural4d.com/results/t1.png"
        },
        "mesh_quality": "standard",
        "pose": "auto",
        "target_polycount": 500000,
        "topology": "triangle",
        "with_texture": true,
        "with_pbr": false,
        "image_enhancement": false,
        "mode": "text_to_3d",
        "status": "succeeded",
        "created_at": 1784044800,
        "updated_at": 1784044842
      }
    ]
  },
  "usage": {
    "credits": 30
  }
}

Download models from model_urls and view the thumbnail at thumbnail_urls.front. thumbnail_urls is {} until available. Retrieve the task again when the URLs expire. model_urls only includes original generation files, unaffected by format conversions: glb for triangle models and obj for quad models. Textured quad models also return mtl if the material file has been generated. Texture maps are in texture_urls. More examples: 3D generation parameters · Complete task response · Upload a reference file.

Get started

API reference

1. Set your API key

2. Create a 3D generation task

3. Retrieve and download the result

​1. Set your API key

​2. Create a 3D generation task

​3. Retrieve and download the result

1. Set your API key

2. Create a 3D generation task

3. Retrieve and download the result