Developer documentation

Create an asynchronous virtual try-on job

TryRobe supports URL-based JSON requests and multipart uploads. Both return an asynchronous job rather than holding the connection open for generation.

URL submission

POST /v1/tryon accepts public HTTPS person and product image URLs. URL validation rejects local, private, credential-bearing, or unsafe targets.

Multipart upload

POST /v1/tryon/upload accepts validated image files subject to file-size, pixel, dimension, and count limits.

Garment scope

Use complete_outfit, upper_wear, lower_wear, or accessory. Advanced upper-and-lower mode accepts a separate secondary product image and uses the published higher credit cost.

Idempotent retries

Reuse the same Idempotency-Key when retrying the same customer action. Generate a new key only for a genuinely new requested generation.

Frequently asked questions

What images should be rejected before submission?

Reject unsupported formats, oversized files, unclear person images, ambiguous product collages, and inputs the user does not have permission to process.

Can the request include a product URL?

Yes. A stable ecommerce product URL and title improve merchant-side reporting and product association.