Skip to main content
POST

Authorizations

Authorization
string
header
required

API key created in Gizmo Settings → API Keys

Headers

idempotency-key
string | null

Reuse the same key and body when retrying generation; prevents duplicate jobs.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:-]+$

Body

application/json

Request body for asset generation.

prompt
string
required

Natural language description of the asset

Minimum string length: 1
Example:

"A 6-DOF robotic arm with gripper end-effector"

reference_intent
ReferenceIntent · object | null
reference_image_urls
string[]

Up to 8 http(s) image URLs grounding the asset's geometry/texture

Maximum array length: 8
reference_images
ImageReference · object[]

Uploaded image IDs or HTTP(S) URLs, optionally labeled with a view. Combined maximum: 8 images.

Maximum array length: 8
persist
boolean
default:true

Save the asset to your library for later retrieval and export (default true)

Response

Job created

ok
boolean
required
job_id
string
required
status
string
required
Allowed value: "queued"
estimated_seconds
integer
required

Advisory duration, not a deadline

estimate_note
string
required