Skip to main content
POST

Authorizations

Authorization
string
header
required

Select Personal or your Team in Gizmo, then create a key in API Access. The key selects your library and billing account.

Headers

idempotency-key
string | null

Required for Team generation; recommended for Personal generation. Save a unique key for each intended job. Reuse the same key and body after a lost response to prevent 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"

composition
enum<string>
default:single

Use assembly for one product containing separately built objects, such as a fitted tray with tools. Single keeps the ordinary asset pipeline.

Available options:
single,
assembly
appearance_variants
boolean
default:false

Keep the original and save additional variants as separate assets. Select count, mode and optional guidance.

variant_guidance
string
default:""

Optional guidance for the additional variants only. Requires appearance_variants=true; does not change the original prompt.

Maximum string length: 2000
variant_count
integer
default:2

Number of additional separately saved assets (1–10); original is not counted. Personal: each delivered variant costs a flat 100 credits ($1); the original bills at 1.5x measured cost.

Required range: 1 <= x <= 10
variant_mode
enum<string>
default:appearance
Available options:
appearance,
geometry,
both
interactions
string[]

Optional intended interactions in plain language (each 1-2000 characters). Omit to infer ordinary uses. The functional scenario allowance is max(2, unique supplied plus accepted inferred interaction count).

Maximum array length: 32
Required string length: 1 - 2000
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"
estimate_note
string
required
estimated_seconds
integer | null

Advisory duration when available, not a deadline