Try on Clothes API

Try on Clothes

curl --request POST \
  --url https://www.ailabapi.com/api/portrait/editing/try-on-clothes \
  --header 'Content-Type: multipart/form-data' \
  --header 'ailabapi-api-key: <api-key>' \
  --form task_type=async \
  --form person_image='@example-file' \
  --form clothes_image='@example-file' \
  --form 'clothes_type=<string>'

import requests

url = "https://www.ailabapi.com/api/portrait/editing/try-on-clothes"

files = {
    "person_image": ("example-file", open("example-file", "rb")),
    "clothes_image": ("example-file", open("example-file", "rb"))
}
payload = {
    "task_type": "async",
    "clothes_type": "<string>"
}
headers = {"ailabapi-api-key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('task_type', 'async');
form.append('person_image', '<string>');
form.append('clothes_image', '<string>');
form.append('clothes_type', '<string>');

const options = {method: 'POST', headers: {'ailabapi-api-key': '<api-key>'}};

options.body = form;

fetch('https://www.ailabapi.com/api/portrait/editing/try-on-clothes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.ailabapi.com/api/portrait/editing/try-on-clothes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\nasync\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"person_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_type\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "ailabapi-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.ailabapi.com/api/portrait/editing/try-on-clothes"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\nasync\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"person_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_type\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("ailabapi-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.ailabapi.com/api/portrait/editing/try-on-clothes")
  .header("ailabapi-api-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\nasync\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"person_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_type\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.ailabapi.com/api/portrait/editing/try-on-clothes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["ailabapi-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\nasync\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"person_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_type\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "request_id": "",
  "log_id": "",
  "error_detail": {
    "code": "",
    "code_message": "",
    "message": ""
  },
  "task_type": "",
  "task_id": ""
}

POST

api

portrait

editing

try-on-clothes

Try on Clothes

curl --request POST \
  --url https://www.ailabapi.com/api/portrait/editing/try-on-clothes \
  --header 'Content-Type: multipart/form-data' \
  --header 'ailabapi-api-key: <api-key>' \
  --form task_type=async \
  --form person_image='@example-file' \
  --form clothes_image='@example-file' \
  --form 'clothes_type=<string>'

import requests

url = "https://www.ailabapi.com/api/portrait/editing/try-on-clothes"

files = {
    "person_image": ("example-file", open("example-file", "rb")),
    "clothes_image": ("example-file", open("example-file", "rb"))
}
payload = {
    "task_type": "async",
    "clothes_type": "<string>"
}
headers = {"ailabapi-api-key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('task_type', 'async');
form.append('person_image', '<string>');
form.append('clothes_image', '<string>');
form.append('clothes_type', '<string>');

const options = {method: 'POST', headers: {'ailabapi-api-key': '<api-key>'}};

options.body = form;

fetch('https://www.ailabapi.com/api/portrait/editing/try-on-clothes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.ailabapi.com/api/portrait/editing/try-on-clothes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\nasync\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"person_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_type\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "ailabapi-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.ailabapi.com/api/portrait/editing/try-on-clothes"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\nasync\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"person_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_type\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("ailabapi-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.ailabapi.com/api/portrait/editing/try-on-clothes")
  .header("ailabapi-api-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\nasync\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"person_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_type\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.ailabapi.com/api/portrait/editing/try-on-clothes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["ailabapi-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_type\"\r\n\r\nasync\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"person_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"clothes_type\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "request_id": "",
  "log_id": "",
  "error_detail": {
    "code": "",
    "code_message": "",
    "message": ""
  },
  "task_type": "",
  "task_id": ""
}

Request

URL: https://www.ailabapi.com/api/portrait/editing/try-on-clothes
Method: POST
Content-Type: multipart/form-data

Image requirements

Portrait

Image format: JPG JPEG PNG
Image size: No more than 3 MB.
Image resolution: Less than 4096x4096px.
Pose requirements: full-body front view with hands fully visible. Arm positioning should avoid wide openings, crossing, or other exaggerated gestures.

Correct Example

Incorrect Example

Non-Front Full-Body Shot
(Avoid uploading side views, sitting poses, lying down poses, or half-body photos.)

Group Photo

Clothing Obstruction
(Avoid holding items, bags, etc.)

Lighting Too Dark / Blurry

Clothing

Image format: JPG JPEG PNG
Image size: No more than 3 MB.
Image resolution: Less than 4096x4096px.
Pose requirements: full-body front view with hands fully visible. Arm positioning should avoid wide openings, crossing, or other exaggerated gestures.
Clothing Category: Minimal Patterns & Prints. Examples include jeans, polo shirts, yoga wear, dresses, suits, T-shirts, etc.
Upload a clear, well-aligned flat-lay image of the clothing.
Background should be simple, clean, and well-lit.
Only a single item of clothing should be displayed in the image.
No layering with other clothing items.
The clothing item should occupy as much of the image frame as possible.

Correct Example

Incorrect Example

Multiple Clothing Items

Non-Front View

Folded Obstruction

Clothing Wrinkles

Headers

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`		Portrait image.
`clothes_image`	YES	`file`		Clothing image.
`clothes_type`	YES	`string`	`upper_body`, `lower_body`, `full_body`	Clothing Types. upper_body`: Upper body clothing.` lower_body`: Lower body clothing.` “full_body`: Full body clothing.`

Response

Response Field Handling Flow

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

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.

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

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

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.`
`data`	`object`
+`image`	`string`		Result image URL.

All result URLs are temporarily available and will expire after 24 hours.

Response Example

{
  "error_code":     0,
  "error_msg":      "",
  "error_detail":   {
    "status_code":  200,
    "code":         "",
    "code_message": "",
    "message":      ""
  },
  "task_status":    0,
  "data":           {
    "image": ""
  }
}

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

Portrait image.

clothes_image

file

Clothing image.

clothes_type

string

Clothing Types.

upper_body: Upper body clothing.
lower_body: Lower body clothing.
full_body: Full body clothing.

Response

200 - application/json

Success

The response is of type object.

Preface

Quick Start

AI Common

AI Portrait

AI Image

AI Background Removal

Request

Image requirements

Portrait

Correct Example

Incorrect Example

Clothing

Correct Example

Incorrect Example

Headers

Body

Response

Public Response Fields

Business Response Fields

Response Example

`Querying Async Task Results` Response

Public Response Fields

Business Response Fields

Response Example

Authorizations

Body

Response

​Request

​Image requirements

​Portrait

Correct Example

Incorrect Example

​Clothing

Correct Example

Incorrect Example

​Headers

​Body

​Response

​Public Response Fields

​Business Response Fields

​Response Example

​Querying Async Task Results Response

​Public Response Fields

​Business Response Fields

​Response Example

Authorizations

Body

Response

Request

Image requirements

Portrait

Clothing

Headers

Body

Response

Public Response Fields

Business Response Fields

Response Example

`Querying Async Task Results` Response

Public Response Fields

Business Response Fields

Response Example