Skip to main content
POST

Authorizations

string
default:"Bearer ${YOUR_API_KEY}"
required
Use the bearer token provided through the Neural4D website.

Body multipart/form-data

string<binary>
required
Required input file. The multipart part must use an image/* content type and must not exceed 50 MB.
enum<string>
required
Standard mesh quality.Available options: standard.
integer
default:4
Number of models to generate.Required range: 1 <= x <= 4.
enum<integer>
default:0
PBR toggle. Use 0 to enable PBR and 1 to disable it.Available options: 0, 1.
boolean
default:false
Whether to generate only the mesh, without texture or PBR output.
boolean
default:false
Image enhancement is in beta. Contact customer service for access.
integer
Target face count for standard quality.Required range: 100000 <= x <= 500000.Default: 500000.

Response

Generation job accepted, or the request was rejected by content moderation.
enum<string>
required
Response source or type marker.Available options: sys.Example: "sys".
string
required
Generation status message.Available options: Generating.
string<uuid>[]
required
UUIDs that can be used to retrieve the generated models.Allowed array length: 1 - 4 elements.
string<uri> | null
required
Signed URL for the uploaded source image, or null when unavailable.
integer | null
Credits deducted when the value is available.
object
Normalized face-count configuration applied to this generation request.