POST /generate to queue an AI image generation. The endpoint is asynchronous — it returns a task_id immediately and the image is ready to download once the status transitions to completed.
Prerequisites
Before you call/generate, make sure you have:
- An API key — passed in every request as the
X-Api-Keyheader - A product image hosted at a publicly accessible URL
- A
scene_id— retrieve one fromGET /scenes(see Manage Scenes)
Required Fields
Optional Fields
additional_data — a flat object of string:string pairs that are injected into the generation prompt as key:value lines. Use this to provide product-specific context such as names, materials, or colours. Omitting the field, passing {}, or passing null all have the same effect: no extra data is added.
Example Request
Response
A successful request returns aqueued status and a task_id you use to track the generation.
Error Reference
Next Steps
Poll for Status
Track your generation from queued to completed and retrieve the image URL.
Generation History
Browse and filter past generations for your account.