Skip to main content
POST
Create a virtual try-on job. Returns immediately with a jobId. Poll Try-On Status for the result.
On JavaScript, the @genlook/storefront SDK is the recommended integration: it calls this endpoint for you, along with the rest of the try-on flow.
With the SDK, one call starts the try-on and resolves when the image is ready, polling included:
SDK

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
Try-on job ID. Use it to poll status.
string
required
Status message or reason the try-on was blocked.
string
Present when the try-on was blocked:
  • QUOTA_EXCEEDED: Monthly quota reached
  • RATE_LIMIT_EXCEEDED: Too many requests
  • BILLING_NOT_ALLOWED: Plan expired
  • PRODUCT_BLOCKED: Try-on is disabled for this product
  • CREATION_FAILED: Job could not be created

Next Steps

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