Skip to main content
POST
/
api
/
portrait
/
enhance
/
try-on-clothes-refiner
Try on Clothes Refiner
curl --request POST \
  --url https://www.ailabapi.com/api/portrait/enhance/try-on-clothes-refiner \
  --header 'Content-Type: multipart/form-data' \
  --header 'ailabapi-api-key: <api-key>' \
  --form task_type=async \
  --form person_image='@example-file' \
  --form top_garment='@example-file' \
  --form coarse_image='@example-file' \
  --form gender=man \
  --form bottom_garment='@example-file'
{
  "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": ""
}

​
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.

​
Headers

FieldRequiredTypeDescription
ailabapi-api-keyYESstringApplication API KEY. Get API KEY

​
Body

FieldRequiredTypeScopeDescription
task_typeYESstringasyncTask Type. “async: Asynchronous tasks.
person_imageYESfileModel image for calling the Try on Clothes API.
top_garmentYESfileTop clothing image for calling the Try on Clothes API.
coarse_imageYESfileResult image obtained from calling the Try on Clothes API.
genderYESstringwoman, manGender of the person_image. woman`: Female.` man: Male.
bottom_garmentNOfileBottom clothing image for calling the Try on Clothes API.

​
Response

Response Field Handling Flow
  1. Handle Public Response Fields Parse and validate the Public Response Fields, checking the status code or response message to ensure the request is successful and error-free.
  2. Handle Business Response Fields If the Public Response Fields are valid and error-free, proceed with processing the business logic in the Business Response Fields.

​
Public Response Fields

Viewing Public Response Fields and Error Codes

​
Business Response Fields

FieldTypeScopeDescription
task_typestringasyncTask Type. “async: Asynchronous tasks.
task_idstringAsynchronous task ID.
Please use this field when calling the Querying Async Task Results API.

​
Response Example

{
  "request_id":     "",
  "log_id":         "",
  "error_code":     0,
  "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

Response Field Handling Flow
  1. Handle Public Response Fields Parse and validate the Public Response Fields, checking the status code or response message to ensure the request is successful and error-free.
  2. Handle Business Response Fields If the Public Response Fields are valid and error-free, proceed with processing the business logic in the Business Response Fields.

​
Public Response Fields

Viewing Public Response Fields and Error Codes

​
Business Response Fields

FieldTypeScopeDescription
task_statusinteger0, 1, 2Asynchronous task status. 0`: The task is queued.` 1: Asynchronous processing. “2: Processing was successful.
outputobject
+image_urlstringResult image URL.
usageobject
+image_countintegerNumber 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.

​
Response Example

{
   "error_code":     0,
   "error_msg":      "",
   "error_detail":   {
      "status_code":  200,
      "code":         "",
      "code_message": "",
      "message":      ""
   },
   "task_status":    0,
   "output":         {
      "image_url": ""
   },
   "usage":          {
      "image_count": 0
   }
}

​
Sample Code

Authorizations

​
ailabapi-api-key
string
header
required

API Key for authentication

Body

multipart/form-data
​
task_type
string

Task Type.

  • async: Asynchronous tasks.

    • Example:

    "async"

    ​
    person_image
    file

    Model image for calling the Try on Clothes API.

    ​
    top_garment
    file

    Top clothing image for calling the Try on Clothes API.

    ​
    coarse_image
    file

    Result image obtained from calling the Try on Clothes API.

    ​
    gender
    string

    Gender of the person_image.

  • woman: Female.
  • man: Male.

    • Example:

    "man"

    ​
    bottom_garment
    file

    Bottom clothing image for calling the Try on Clothes API.

    Response

    200 - application/json

    Success

    The response is of type object.