API Reference (Developers)
Create Generation
Request a virtual try-on generation combining a customer photo with a product
POST
Create a virtual try-on generation job. Returns immediately with a
jobId — poll Generation Status for the result.
Request
The
fileId from a previous upload.Shopify product ID (
gid://shopify/Product/{id}).Shopify variant ID (
gid://shopify/ProductVariant/{id}). Uses the default variant if omitted.Response
Generation job ID. Use it to poll status.
Status message or reason the generation was blocked.
Present when generation was blocked:
QUOTA_EXCEEDED— Monthly quota reachedRATE_LIMIT_EXCEEDED— Too many requestsBILLING_NOT_ALLOWED— Plan expiredCREATION_FAILED— Job could not be created
Next Steps
- Store the
jobId - Poll Generation Status every 2 seconds
- Display the result when status is
COMPLETED

