Request
Make aPOST request to below endpoint and pass the required parameters as a request body.
curl
Body
json
Body Attributes
string
required
Your API Key used for request authorization.
string
default:"instantmesh"
Specifies the model to be used for the 3D generation.
string
default:"A full body mesh of a dog"
required
Text prompt for generating the 3D model.
bool
default:"false"
Whether to render a NeRF video of the 3D model.
string
default:"obj"
The format of the output 3D object (
glb, obj, stl, ply).string
default:""
Negative prompt to exclude certain elements.
number
default:"1"
Controls the guidance between the prompt and the generated model.
number
default:"10"
required
The number of inference steps to generate the 3D model.
number
default:"7.5"
Controls the strength of style-space guidance.
number
default:"12"
Number of sampling steps for style-space guidance. Range: 1 to 50.
number
default:"3.0"
Controls the strength of slat guidance. Range: 0.0 to 10.0.
number
default:"12"
Number of sampling steps for slat guidance. Range: 1 to 50.
number
default:"0.90"
Degree of mesh simplification. Range: 0.90 to 0.98.
number
default:"0.85"
required
Ratio of the foreground size to the image size. Only used when
remove_bg is enabled.bool
default:"false"
If true, removes the background from the generated 3D model.
number
default:"256"
required
Specifies the resolution of the generated 3D model. Max: 512.
number
default:"8192"
Size of chunks used in the process (affects VRAM usage). Max: 12000.
number
default:"0"
Random seed for reproducibility. If set to 0, a random seed will be generated.
string
default:"no"
If set to
"yes", the output files will be saved in a temporary directory.
