API Reference
Create virtual try-on task
Create an asynchronous virtual try-on task. Upload a model (person) image and one or two clothing images to generate the try-on result.
This API supports either:
- One clothing item of type
upper,lower, orfull - Two clothing items simultaneously (
upperandlower)
Poll the GET endpoint with the returned task_id to retrieve results.
Model:
virtual-tryon-clothesCredit:17
post
/v1/images/try-onAuthorization — This endpoint requires an API key. Pass it in the api-key header on every request. Learn more
Parameters
| Name | Type | Status | Description |
|---|---|---|---|
model_image | file | Required | Model/person image file or URL. |
cloth_image | file | Required | Clothing image file or URL. |
lower_cloth_image | file | Optional | Lower clothing image file or URL. |
cloth_type | string | Required | Clothing type. |
Responses
Try-on task created successfullyTaskCreatedResponse
| Field | Type | Description |
|---|---|---|
task_id | string | Unique task identifier. Poll the matching task-status endpoint for results. |
status | string | |
created_at | integer | Unix timestamp of task creation |
curl -X POST "https://api.snapedit.app/v1/images/try-on" \
-H "api-key: YOUR_API_KEY" \
-F "model_image=@./image.jpg" \
-F "cloth_image=@./image.jpg" \
-F "lower_cloth_image=@./image.jpg" \
-F "cloth_type=value"Response
{
"task_id": "task_abc123",
"status": "CREATED",
"created_at": 1745827200
}

