Skip to main content
POST
/
api
/
cutout
/
general
/
apparel-background-removal
Costume background removal
curl --request POST \
  --url https://www.ailabapi.com/api/cutout/general/apparel-background-removal \
  --header 'Content-Type: multipart/form-data' \
  --header 'ailabapi-api-key: <api-key>' \
  --form image='@example-file' \
  --form 'out_mode=<string>' \
  --form 'cloth_class=<string>' \
  --form 'return_form=<string>'
{
  "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": ""
        }
      }
    ]
  }
}

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

​
Headers

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

​
Body

FieldRequiredTypeScopeExampleDefaultDescription
imageYESfile
out_modeNOinteger0, 1000`: Default segmentation result of the main clothing.`, 1: Combined segmentation result based on the category specified by cloth_class.
cloth_classNOstringtops, coat, skirt, pants, bag, shoes, hattops,coattops`: Tops.`, coat: Coat., skirt`: Skirt.`, pants: Pants., bag`: Bag.`, shoes: Shoes., “hat: Hat.
return_formNOstringmask, whiteBKwhiteBK`: 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

FieldTypeDescription
dataobjectThe content of the result data returned.
+elementsarrayReturns an array of elements.
++0object
+++image_urlstringReturns the keying result image URL address.
++1object
+++class_urlobjectReturn the URL corresponding to the clothing category based on the input cloth_class.
++++topsstringTops URL.
++++coatstringCoat URL.
++++skirtstringSkirt URL.
++++pantsstringPants URL.
++++bagstringBag URL.
++++shoesstringShoes URL.
++++hatstringHat URL.
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.

Authorizations

​
ailabapi-api-key
string
header
required

API Key for authentication

Body

multipart/form-data
​
image
file
​
out_mode
string

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
    string

    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
    string

    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

    200 - application/json

    Success

    The response is of type object.