Virtual Try-on Submit API Reference
Virtual Try-On Submit API
Standard Ver: POST
/ai/virtual/tryon
Pro Ver: POST
/ai/virtual/tryon-pro
Supports uploading individual clothing item image URLs and clothing types. Generates real-time virtual try-on images based on the selected model type.
Request Parameters
String
Yes
The value is a List, but should be transferred to String value. e.g. "[{\"clothesList\":[{\"imageUrl\":\"https://ae-pic-a1.aliexpress-media.com/kf/H7588ee37b7674fea814b55f2f516fda1z.jpg\",\"type\":\"tops\"}],\"model\":{\"base\":\"General\",\"name\":\"James\"},\"viewType\":\"mixed\",\"inputQualityDetect\":0,\"generateCount\":4}]"
clothesList
Object[]
Yes
A list of images for virtual try-on. Upload two clothes to do suits tryon.
imageUrl
String
Yes
URL of the clothing image. The resolution should be greater than 500x500 pixels and up to a maximum of 3000x3000 pixels.
type
String
No
Type of garments includes:
"tops": Upper body clothing
"bottoms": Lower body clothing
"dresses": One-pieces garments
modelImage
String[]
No
A list of URLs for customized model images with maximum 8.
model
Object
No
Users can select the type of model or a specific model from the model base.
base
String
No
The model library to be used.
"General": Public model library.
name
String
No
The name of the model. Refer to the model library documentation for the list of available model names.
gender
String
No
The gender of the model for virtual try-on:
"male", "female" Default is "female".
style
String
No
The style of the model for virtual try-on
"universal_1":
"universal_2":
"universal_3":
age
String
No
The age of the model. "children", "youngadult"
body
String
No
The body type of the model.
"slim": slim model
"curvy": plus-size model Default is "slim".
viewType
String
No
The perspective for the generated images:
"fullbody": Full body view
"halfbody": Half body view
"mixed": Mixed full body and half body views
Default "fullbody".
generateCount
Number
No
The number of images to be generated, supporting an input range of 1 to 8.
Default is 4.
inputQualityDetect
Number
No
Whether to automatically filter out low-quality or incomplete flat-lay input images:
"1": Yes, filter low-quality images
"0": No, do not filter low-quality images
Default is 0.
Sample Request
Specify the model type for virtual try-on:
Specify the model for virtual try-on:
Upload your own model image for virtual try-on:
Response Parameters
resCode
Number
The returned result code, where 200 indicates success. For detailed error codes, please refer to the error code list.
data
Object
The returned JSON result data. the task id can be used to query the generation api to obtain results
requestId
String
A unique request ID used for troubleshooting.
success
Boolean
The status of the returned request, indicating whether the request was successful.
resMessage
String
The returned request information.
Sample Response
Error Code
500
system error
System error.
501
rate limit exceed
The current interface has reached the current limit. Please contact us via navigation bar or email us (aidge_support@service.alibaba.com) to increase the current limit value.
700
invalid input
The format of the input parameters does not meet the requirements, and resMessage will return detailed fields that do not meet the requirements.
701
Clothing image dowloading failed, please try another input
Clothing image dowloading failed, please try another image url.
703
Input clothes image resoulution low, please try other image
The resolution of the clothing image does not meet the requirements. Please try another image.
707
Input clothing image is not a complete flat lay. Please try another image.
The clothing image is not a complete flat lay and does not meet the quality requirements for virtual try-on. Please try another image.
1001
content control failed, please retry
Content risk failed, please try other input. If an error persists,please contact us via navigation bar or email us (aidge_support@service.alibaba.com) for troubleshooting.
1002
content risk filter failed, please contact us
Content risk failed, please ccontact us via navigation bar or email us (aidge_support@service.alibaba.com).
Last updated
Was this helpful?