AILabTools API - Costume background removal - API:V1.1.0
Request
- URL:
https://www.ailabapi.com/api/cutout/general/apparel-background-removal
- Method:
POST
- Content-Type:
multipart/form-data
Image requirements
- Image format:
JPEG
JPG
BMP
PNG
- Image size: No more than 5 MB.
- Image resolution: Larger than 50x50px, smaller than 3000x3000px.
Header
Field | Required | Type | Description |
---|---|---|---|
ailabapi-api-key | YES | string | Application API KEY. Get API KEY |
Body
Field | Required | Type | Scope | Example | Description |
---|---|---|---|---|---|
image | YES | file | |||
cloth_class | NO | string | tops coat skirt pants bag shoes hat | tops,coat | Clothing categories. Multiple values can be submitted at once, separated by commas (,). tops : Tops.coat : Coat.skirt : Skirt.pants : Pants.bag : Bag.shoes : Shoes.hat : Hat. |
return_form | NO | string | mask whiteBK | Specify the desired image format for the output. whiteBK : Returns an image with a white background.mask : Returns a single-channel mask. |
Response
Processing Flow
-
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 | Description |
---|---|---|
data | object | The content of the result data returned. |
+elements | array | Returns an array of elements. |
++0 | object | |
+++image_url | string | Returns the keying result image URL address. |
++1 | object | |
+++class_url | object | Return the URL corresponding to the clothing category based on the input cloth_class . |
++++tops | string | Tops URL. |
++++coat | string | Coat URL. |
++++skirt | string | Skirt URL. |
++++pants | string | Pants URL. |
++++bag | string | Bag URL. |
++++shoes | string | Shoes URL. |
++++hat | string | Hat URL. |
tip
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
{
"request_id": "",
"log_id": "",
"error_code": 0,
"error_code_str": "",
"error_msg": "",
"error_detail": {
"status_code": 200,
"code": "",
"code_message": "",
"message": ""
},
"data": {
"elements": [
{
"image_url": ""
},
{
"class_url": {
"tops": "",
"coat": "",
"skirt": "",
"pants": "",
"bag": "",
"shoes": "",
"hat": ""
}
}
]
}
}
Code example
If you'd like to see the actual effects, please visit the experience page for a trial.