Skip to main content
POST

Authorizations

string
default:"Bearer ${YOUR_API_KEY}"
required
Neural4D API key using the Bearer scheme.

Body application/json

enum<string>
required
Public model identifier. Available option: dreamtech/neural4d-2.5.
string
required
Text describing the model to generate. Must not be empty and is limited to 500 characters.
boolean
default:false
Whether to generate a texture. When false, the task creates only a mesh.
boolean
default:false
Whether to generate PBR materials. When true, with_texture must be true.
enum<string>
default:"standard"
Mesh quality: standard, high, or extra_high.
enum<string>
default:"triangle"
Mesh topology: triangle or quad.
integer
default:500000
Target face count. Triangle standard supports 100,000–500,000 and defaults to 500,000. Triangle high and extra_high support 500,000–1,000,000 and default to 1,000,000. Quad supports 1,000–100,000 and defaults to 50,000. Triangle counts increase in steps of 1,000; quad counts increase in steps of 100.
enum<string>
default:"auto"
Character pose: auto, A-pose, or T-pose.
integer
default:1
Number of models to generate, from 1 to 4.

Response

Identify errors by error.code.
Successful requests return 202 Accepted, a batch task ID, and generated child items. A batch image request creates one child item per image. For example, two images produce two items in data.
string
required
Batch task ID for this generation request. Use it to retrieve task status.
enum<string>
required
Batch task status. Available options: queued, processing, succeeded, failed.
integer<int64>
required
Unix timestamp in seconds when the batch task was created.
enum<string>
required
Generation mode. Available options: text_to_3d (text), image_to_3d (single image), batch_image_to_3d (batch images), multi_view_to_3d (multi-view images).
string
required
Public model identifier used for this generation.
object[]
required
Generated child items created by this request.
object
Request billing information when available, including credits charged in credits.