API Reference
Get virtual try-on task status
Get the status and result URL for a virtual try-on task.
get
/v1/images/try-on/tasks/{task_id}Authorization — This endpoint requires an API key. Pass it in the api-key header on every request. Learn more
Parameters
| Name | Type | Status | Description |
|---|---|---|---|
task_id | string | Required | Task ID returned by the create-task or upload endpoint. |
Responses
Task statusTaskStatusResponse
| Field | Type | Description |
|---|---|---|
task_id | string | |
status | string | |
progress | integer | Progress 0-100 (when PROCESSING) |
download_url | string | Result image URL (when COMPLETED) |
error_msg | string | Error message (when FAILED) |
created_at | integer | |
started_at | integer | |
completed_at | integer |
curl -X GET "https://api.snapedit.app/v1/images/try-on/tasks/YOUR_TASK_ID" \
-H "api-key: YOUR_API_KEY"Response
{
"task_id": "task_abc123",
"status": "COMPLETED",
"progress": 75,
"download_url": "https://outputs.snapedit.app/outputs/result.png",
"error_msg": "string",
"created_at": 0,
"started_at": 0,
"completed_at": 0
}