Skip to main content
POST
Generate a scene

Headers

authorization
string | null
x-gizmo-service-token
string | null
x-gizmo-user-id
string | null
x-gizmo-convex-user-id
string | null

Body

application/json

Request body for scene generation.

prompt
string
required

Natural language description of the scene to generate

Minimum string length: 1
Example:

"A modern robotics lab with two workbenches and a mobile manipulator"

model
string | null

Override the default LLM model

asset_pipeline
enum<string>
default:auto

Asset geometry pipeline: 'auto' (recommended), 'gizmo' (parametric), or 'cad' (B-Rep)

Available options:
auto,
gizmo,
cad
reference_image_urls
string[]

Up to 3 http(s) image URLs grounding the generation (room photo, product shot). A reference automatically selects the photo-grounded structure build.

Maximum array length: 3
persist
boolean
default:true

Whether to save the scene to your library

Response

Job created