Skip to main content
POST
/
vton
/
request
cURL
curl --request POST \
  --url https://whilter-api-host/vton/request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user-id": "<string>",
  "client-id": "<string>",
  "usecase-id": "<string>",
  "model-image": "<string>",
  "garment-image": "<array>",
  "category": "auto",
  "mode": "balanced",
  "moderation_level": "permissive",
  "segmentation_free": true,
  "output_format": "png"
}
'
{
  "request-id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Virtual Tryon request parameters

​
user-id
string
required

User phone number or ID

​
client-id
string
required

Client ID provided during vendor onboarding

​
usecase-id
string
required

Usecase ID provided during vendor onboarding

​
model-image
string<uri>
required

URL of the model image

​
garment-image
array
required

URL of the garment image

​
category
enum<string>
default:auto
required

Category of garments

Available options:
auto,
tops,
bottoms,
one-pieces
​
mode
enum<string>
default:balanced

Speed vs quality preset

Available options:
balanced,
performance,
quality
​
moderation_level
enum<string>
default:permissive

Content safety filter

Available options:
conservative,
permissive,
none
​
segmentation_free
boolean

Skip clothing removal

​
output_format
enum<string>
default:png

Image encoding for output

Available options:
png,
jpeg

Response

Virtual Tryon request created successfully

​
request-id
string
required

Unique identifier of the generation task