AILabTools API - Costume Background Removal - API

---

draft: true

Important Announcement: The API Documentation Has Been Fully Updated

This API documentation has been completely restructured with an improved and clearer format. The current page will no longer receive active updates or maintenance. For the most accurate and up-to-date information, please switch to the new documentation.

View New Docs

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 3 MB.
• Image resolution: Larger than 50x50px, smaller than 3000x3000px.

Headers

Field	Required	Type	Description
ailabapi-api-key	YES	string	Application API KEY. Get API KEY

Body

Field	Required	Type	Scope	Example	Default	Description
image	YES	file
out_mode	NO	integer	0 1	0	0	Specifies the type of segmentation result to return, which affects the content of the image_url field. 0: Default segmentation result of the main clothing. 1: Combined segmentation result based on the category specified by cloth_class.
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. If not specified, a four-channel PNG image will be returned.

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

Response Example

{
  "request_id":   "",
  "log_id":       "",
  "error_code":   0,
  "error_msg":    "",
  "error_detail": {
    "status_code":  200,
    "code":         "",
    "code_message": "",
    "message":      ""
  },
  "data":         {
    "elements": [
      {
        "image_url": ""
      },
      {
        "class_url": {
          "tops":  "",
          "coat":  "",
          "skirt": "",
          "pants": "",
          "bag":   "",
          "shoes": "",
          "hat":   ""
        }
      }
    ]
  }
}

Sample Code

👉 Online Experience 👈

If you'd like to see the actual effects, please visit the experience page for a trial.

• Introduction to Get Sample Code
• Sample Code