Virtual Try-On

Poll a try-on task

Status and result images of a task created by POST /v1/try-on or /v1/try-on/variations. Poll every few seconds until status is completed or failed. Free.

get/v1/tasks/{taskId}

Request

  • Base URL: https://api.crayonz.ai
  • URL: https://api.crayonz.ai/v1/tasks/{taskId}
  • Auth: API key in header X-API-Key

Path parameters

taskIdstring required

The taskId from the create response

Response

Success

taskIdstring
statusstring

queued | processing | completed | failed

resultImagestring

The main result image URL, when completed

resultImagesobject[]

Every pose rendered: { id, pose, image } (variations return several)

errorstring

Why the task failed, when status is failed (a failed task is not charged)

createdAtstring
completedAtstring

Changes

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