Skip to main content
POST
Starts a try-on and returns a generationId. The work runs in the background: poll Generation Status or use client.generations.waitFor(). Costs 1 credit (2 for a 2K result), refunded if the generation fails. A product that is not worn on the body (a gift card, a beauty device, luggage…) cannot be shown in a try-on: the generation completes with the person photo unchanged, and no credit is charged. Prefer one call that returns the image? Use Create Try-On (sync): same body, no polling.
Send the full product title and description. They tell the AI what the garment is and how it fits (cut, length), which gives faster and more accurate results.

Headers

string
A unique value of your choice (a UUID, up to 255 characters) that makes the call safe to retry: the same key and body within 24 hours returns the first response and creates and charges nothing new. See Idempotency.
The response carries X-RateLimit-Limit and X-RateLimit-Remaining: see Rate limits.

Body

array
required
1 to 4 items. With two or more, the person wears all of them together in one result (a top, trousers and a jacket, for example): only those garments change, the rest of the outfit stays. Clothing only. See Multiple products.Reuse the ID. The first try-on of a product analyzes it, which adds a few seconds. Later calls with just { externalId } skip that step and return faster. Every try-on resets the product lifetime. See Products.
object
required
The customer photo: { image: { source: { ... } } } with exactly one of:url and fileKey are always cropped to 4:5 around the person.
string
Your own user ID, for GDPR deletion. No PII.
boolean
default:"false"
Test call: skips the AI and returns the person photo unchanged, fast. Costs no credit. Use it to build and test your integration. A top-level field, next to products (not inside output). Not available on batches.
object

Response

string
required
string
required
Always PENDING.
string[]
Every product’s ID, in the order you sent them: your externalId, or the generated ID of a one-shot product.

Errors

All codes: Errors.
Deprecated but still accepted: the 1.0 body with singular product, customer: { id | url | fileKey }, customerId, useWatermark and retentionDays. Don’t mix it with new fields. See the Changelog.