Skip to main content

AILabTools API - Costume background removal - API

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.
FieldRequiredTypeDescription
ailabapi-api-keyYESstringApplication API KEY.

Body

FieldRequiredTypeScopeExampleDescription
imageYESfile
cloth_classNOstring
  • tops
  • coat
  • skirt
  • pants
  • bag
  • shoes
  • hat
  • tops,coatClothing 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_formNOstring
  • 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

    Public Parameters

    Viewing Public Parameters and Error Codes

    Business Parameters

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