Skip to main content
POST
Create a virtual try-on generation job. Returns immediately with a jobId. Poll Generation Status for the result.

Request

string
required
The fileId from a previous upload.
string
required
Shopify product ID (gid://shopify/Product/{id}).
string
Shopify variant ID (gid://shopify/ProductVariant/{id}). Uses the default variant if omitted.

Response

string
required
Generation job ID. Use it to poll status.
string
required
Status message or reason the generation was blocked.
string
Present when generation was blocked:
  • QUOTA_EXCEEDED: Monthly quota reached
  • RATE_LIMIT_EXCEEDED: Too many requests
  • BILLING_NOT_ALLOWED: Plan expired
  • CREATION_FAILED: Job could not be created

Next Steps

  1. Store the jobId
  2. Poll Generation Status every 2 seconds
  3. Display the result when status is COMPLETED