> ## Documentation Index
> Fetch the complete documentation index at: https://ailabtools.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Try on Clothes Refiner API
> Try on Clothes Refiner API enhances virtual try-on images with more realistic details, colors, and clothing fit.
## 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
| Field | Required | Type | Description |
| :----------------- | :------- | :------- | :---------------------------------------------------- |
| `ailabapi-api-key` | YES | `string` | Application API KEY. [Get API KEY](/docs/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
**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
| 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](/docs/ai-common/async-task-results/api) API.** |
### Response Example
```json theme={null}
{
"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`](/docs/ai-common/async-task-results/api) 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
| 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` | | |
| +`image_url` | `string` | | Result image URL. |
| `usage` | `object` | | |
| +`image_count` | `integer` | | Number of generated images. |
All result URLs are temporarily available and will expire after 24 hours.
### Response Example
```json theme={null}
{
"error_code": 0,
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"task_status": 0,
"output": {
"image_url": ""
},
"usage": {
"image_count": 0
}
}
```
## OpenAPI
````yaml POST /api/portrait/enhance/try-on-clothes-refiner
openapi: 3.0.0
info:
title: AILabAPI
description: >-
[AILabTools](https://www.ailabtools.com) is an advanced tool that
offers a vast array of simple and flexible API endpoints to suit your
specific needs. With just one [API
KEY](https://www.ailabtools.com/doc/get-api-key), you can easily call
any of the endpoints and integrate them quickly into your application or
workflow, allowing for smooth and efficient operations.
[AILabTools](https://www.ailabtools.com) is continuously evolving,
and you can anticipate even more API endpoints being added in the future,
further enhancing its capabilities and usefulness for your artificial
intelligence and machine learning requirements.
version: 1.0.0
servers:
- url: https://www.ailabapi.com
description: Production server
security:
- apiKeyAuth: []
tags:
- name: AI IMAGE
- name: AI IMAGE > Image Enhancement
- name: AI IMAGE > Image Effects
- name: AI IMAGE > Image Editing
- name: AI IMAGE > Image Scoring
- name: AI BACKGROUND REMOVAL
- name: AI BACKGROUND REMOVAL > Portrait
- name: AI BACKGROUND REMOVAL > General
- name: AI PORTRAIT
- name: AI PORTRAIT > Portrait Effects
- name: AI PORTRAIT > Portrait Enhance
- name: AI PORTRAIT > Portrait Editing
- name: AI PORTRAIT > Portrait Analysis
- name: AI COMMON
paths:
/api/portrait/enhance/try-on-clothes-refiner:
post:
tags:
- AI PORTRAIT > Portrait Enhance
summary: Try on Clothes Refiner
description: >-
Try on Clothes Refiner API enhances virtual try-on images with more
realistic details, colors, and clothing fit.
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
task_type:
type: string
description: |-
Task Type.
- `async`: Asynchronous tasks.
example: async
person_image:
type: string
format: binary
description: Model image for calling the Try on Clothes API.
top_garment:
type: string
format: binary
description: Top clothing image for calling the Try on Clothes API.
coarse_image:
type: string
format: binary
description: Result image obtained from calling the Try on Clothes API.
gender:
type: string
description: |-
Gender of the `person_image`.
- `woman`: Female.
- `man`: Male.
example: man
bottom_garment:
type: string
format: binary
description: Bottom clothing image for calling the Try on Clothes API.
responses:
'200':
headers:
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
request_id: ''
log_id: ''
error_detail:
code: ''
code_message: ''
message: ''
task_type: ''
task_id: ''
description: Success
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: ailabapi-api-key
description: API Key for authentication
````