Skip to main content
POST
Generate model with image

Authorizations

Authorization
string
header
default:YOUR_TOKEN
required

Use the bearer token provided through the Neural4D website.

Body

multipart/form-data
mesh_quality
enum<string>
default:high
required

Mesh quality level. Supported values are standard, high, and extra_high.

Available options:
standard
image
file
required

Required input file. The multipart part must use an image/* Content-Type and must not exceed 50 MB.

faceNum
integer

Target face count. standard accepts 100000 to 500000 and defaults to 500000; high and extra_high accept 500000 to 1000000 and default to 1000000.

Required range: 100000 <= x <= 500000
modelCount
integer
default:4

Number of models to generate.

Required range: 1 <= x <= 4
disablePbr
enum<integer>
default:0

PBR toggle. Use 0 to enable PBR and 1 to disable it.

Available options:
0,
1
onlyGenerateMesh
boolean
default:false

Whether to generate only the mesh, without texture or PBR output.

Response

Generation job accepted, or the request was rejected by content moderation.

type
enum<string>
required

Response source or type marker.

Available options:
sys
Example:

"sys"

message
enum<string>
required

Generation status message.

Available options:
Generating
uuids
string<uuid>[]
required

UUIDs that can be used to retrieve the generated models.

Required array length: 1 - 4 elements
uploadedImageUrl
string<uri> | null
required

Signed URL for the uploaded source image, or null when unavailable.

pointsDeducted
integer | null

Credits deducted when the value is available.

generationConfig
object | null

Normalized face-count configuration applied to this generation request.