Skip to main content
POST
Generate 3D model from image

Request

Make a POST request to below endpoint and pass the required parameters as a request body to the endpoint.
curl

Body

json

Body

application/json
key
string
required

API key for request authorization

init_image
string

The input image URL or file path to be used for 3D conversion

output_format
enum<string>
default:glb

Specifies the format of the generated 3D object

Available options:
obj,
stl,
ply,
glb
render
boolean
default:false

Indicates whether to render a NeRF video of the 3D model

resolution
integer
default:256

Resolution of the generated 3D model

Required range: x <= 512
multi_image
boolean
default:false

Processes multiple images together when set to true

ss_guidance_strength
number
default:7.5

Adjusts the strength of style-space guidance for better model refinement

ss_sampling_steps
integer
default:12

Number of steps for style-space sampling

Required range: 1 <= x <= 50
slat_guidance_strength
number
default:3

Strength of slat guidance to refine model details

Required range: 0 <= x <= 10
slat_sampling_steps
integer
default:12

Number of steps for slat guidance sampling

Required range: 1 <= x <= 50
mesh_simplify
number
default:0.9

Controls the degree of mesh simplification to optimize the output

Required range: 0.9 <= x <= 0.98
chunk_size
integer
default:8192

Specifies the size of processing chunks, which affects VRAM usage

Required range: x <= 12000
seed
integer
default:0

Sets a random seed for reproducibility; 0 generates a random seed

temp
enum<string>
default:no

Saves the output files in a temporary directory if set to 'yes'

Available options:
yes,
no
webhook
string | null

Webhook URL for completion notification

track_id
string | null

Custom tracking ID for the request

Response

3D generation response

status
enum<string>
Available options:
success
generationTime
number

Time taken to generate the 3D model in seconds

id
integer

Unique identifier for the generation request

output
string<uri>[]

Array of URLs to the generated 3D files

Array of proxy URLs for the generated 3D files

meta
object

Metadata about the generation process and parameters used