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}

AuthorizationThis endpoint requires an API key. Pass it in the api-key header on every request. Learn more

Parameters

NameTypeStatusDescription
task_id
stringRequiredTask ID returned by the create-task or upload endpoint.

Responses

Task statusTaskStatusResponse

FieldTypeDescription
task_idstring
statusstring
progressintegerProgress 0-100 (when PROCESSING)
download_urlstringResult image URL (when COMPLETED)
error_msgstringError message (when FAILED)
created_atinteger
started_atinteger
completed_atinteger
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
}