AILabTools API - Try on Clothes Refiner - API
Request
- URL:
https://www.ailabapi.com/api/portrait/enhance/try-on-clothes-refiner
- Method:
POST
- Content-Type:
multipart/form-data
Image requirements
- Image format:
JPG
JPEG
PNG
BMP
- Image size: No more than 5 MB.
- Image resolution: Larger than 150x150px, smaller than 4096x4096px.
- Pose requirements: full-body front view with hands fully visible. Arm positioning should avoid wide openings, crossing, or other exaggerated gestures.
Header
Field | Required | Type | Description |
---|---|---|---|
ailabapi-api-key | YES | string | Application API KEY. Get API KEY |
Body
Field | Required | Type | Scope | Description |
---|---|---|---|---|
task_type | YES | string | async | Task Type. async : Asynchronous tasks. |
person_image | YES | file | Model image for calling the Try on Clothes API. | |
top_garment | YES | file | Top clothing image for calling the Try on Clothes API. | |
coarse_image | YES | file | Result image obtained from calling the Try on Clothes API. | |
gender | YES | string | woman man | Gender of the person_image . woman : Female.man : Male. |
bottom_garment | NO | file | Bottom clothing image for calling the Try on Clothes API. |
Response
-
Handle
Public Parameters
:First, parse and validate the
Public Parameters
, checking the status code or response message to ensure the request is successful and no errors are present. -
Handle
Business Parameters
:If the public parameters are valid and no exceptions are found, proceed to process the business logic in the
Business Parameters
.
Public Parameters
Viewing Public Parameters and Error CodesBusiness Parameters
Field | Type | Scope | Description |
---|---|---|---|
task_type | string | async | Task Type. async : Asynchronous tasks. |
task_id | string | Asynchronous task ID. Please use this field when calling the Querying Async Task Results API. |
Example
{
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"task_type": "",
"task_id": ""
}
This API is asynchronous, please keep task_id
and call Querying Async Task Results
to get the final results.
Asynchronous task results are valid for 24 hours. It is recommended that asynchronous task results be queried every 5 seconds.
Querying Async Task Results
Response
-
Handle
Public Parameters
:First, parse and validate the
Public Parameters
, checking the status code or response message to ensure the request is successful and no errors are present. -
Handle
Business Parameters
:If the public parameters are valid and no exceptions are found, proceed to process the business logic in the
Business Parameters
.
Public Parameters
Viewing Public Parameters and Error CodesBusiness Parameters
Field | Type | Scope | Description |
---|---|---|---|
task_status | integer | 0 1 2 | Asynchronous task status. 0 : The task is queued.1 : Asynchronous processing.2 : Processing was successful. |
output | object | ||
+task_status | string | PENDING RUNNING SUCCEEDED FAILED UNKNOWN | Task status. PENDING : Queued.RUNNING : In progress.SUCCEEDED : Successful.FAILED : Failed.UNKNOWN : Unknown. |
+image_url | string | Result image URL. | |
usage | object | ||
+image_count | integer | Number of generated images. |
The URL address is a temporary address, valid for 24 hours, and will not be accessible after it expires. If you need to save the file for a long time or permanently, please visit the URL address within 24 hours and download the file to your own storage space.
Example
{
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"task_status": 0,
"output": {
"task_status": "",
"image_url": ""
},
"usage": {
"image_count": 0
}
}