Skip to main content

AILabTools API - Product background removal - API

Request

  • URL: https://www.ailabapi.com/api/cutout/general/commodity-background-removal
  • Method: POST
  • Content-Type: multipart/form-data

Image requirements

  • Image format: JPEG JPG BMP PNG(8-bit, 16-bit, 64-bit PNG not supported)
  • Image size: No more than 3 MB.
  • Image resolution: Less than 2000x2000px.
FieldRequiredTypeDescription
ailabapi-api-keyYESstringApplication API KEY. Get API KEY

Body

FieldRequiredTypeScopeDescription
imageYESfile
return_formNOstring
  • mask
  • whiteBK
  • crop
  • Specifies the form of the returned image.
  • If not set, the four-channel PNG map is returned.
  • mask: Returns a single channel mask.
  • whiteBK: Return to white background image.
  • crop: Returns the four-channel PNG image after cropping (cropping out the blank areas around the edges).
  • Response

    Processing Flow
    1. 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.

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

    Business Parameters

    FieldTypeDescription
    dataobjectThe content of the result data returned.
    +image_urlstringResulting image URL address.
    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": {
    "image_url": ""
    }
    }

    Code example

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