---
title: "Poll a try-on task"
method: GET
path: "/v1/tasks/{taskId}"
tags: ["Virtual Try-On"]
---

# Poll a try-on task

`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`

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.

## Path parameters

- `taskId` string, required: The taskId from the create response

## Response `200`

Success

- object
  - `taskId` string
  - `status` string: queued | processing | completed | failed
  - `resultImage` string: The main result image URL, when completed
  - `resultImages` object[]: Every pose rendered: { id, pose, image } (variations return several)
  - `error` string: Why the task failed, when status is failed (a failed task is not charged)
  - `createdAt` string
  - `completedAt` string

## Other responses

- `401`: Unauthorized — invalid or missing API key
- `402`: Insufficient credits
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/crayonz/apis/crayonz-api.md) · [All operations](https://skmtc.dev/crayonz/apis/crayonz-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crayonz/apis/crayonz-api/revisions/1114c84167b2?raw)