Virtual Try-On

Create a virtual try-on task

Render a user wearing a product. Async — returns a task_id; poll /v1/tasks/:id for the result.

post/v1/try-on

Request

  • Base URL: https://api.crayonz.ai
  • URL: https://api.crayonz.ai/v1/try-on
  • Auth: API key in header X-API-Key

Request body

userPhotostring required

URL or base64 of the user photo

productImagestring required

URL or base64 of the product image

customPromptstring

Optional styling instructions

Example request

{
  "userPhoto": "https://example.com/shopper.jpg",
  "productImage": "https://example.com/tee.png"
}

Response

Success

taskIdstring

Poll GET /v1/tasks/{taskId} with this id

statusstring

queued, processing, completed or failed

messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.