> ## Documentation Index
> Fetch the complete documentation index at: https://ailabtools.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Product Background Removal API

> Product Background Removal API removes product backgrounds and isolates items for clean e-commerce images, catalogs, and marketplace listings.

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

### Headers

| Field              | Required | Type     | Description                                           |
| :----------------- | :------- | :------- | :---------------------------------------------------- |
| `ailabapi-api-key` | YES      | `string` | Application API KEY. [Get API KEY](/docs/get-api-key) |

### Body

| Field         | Required | Type     | Scope                     | Description                                                                                                                                                                                                                                                                                          |
| :------------ | :------- | :------- | :------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `image`       | YES      | `file`   |                           |                                                                                                                                                                                                                                                                                                      |
| `return_form` | NO       | `string` | `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

<Warning>
  **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`.
</Warning>

### Public Response Fields

<a href="/docs/response-description" target="_blank">Viewing Public Response Fields and Error Codes</a>

### Business Response Fields

| Field        | Type     | Description                              |
| :----------- | :------- | :--------------------------------------- |
| `data`       | `object` | The content of the result data returned. |
| +`image_url` | `string` | Resulting image URL address.             |

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

```json theme={null}
{
  "request_id":     "",
  "log_id":         "",
  "error_code":     0,
  "error_msg":      "",
  "error_detail":   {
    "status_code":  200,
    "code":         "",
    "code_message": "",
    "message":      ""
  },
  "data":           {
    "image_url": ""
  }
}
```


## OpenAPI

````yaml POST /api/cutout/general/commodity-background-removal
openapi: 3.0.0
info:
  title: AILabAPI
  description: >-
    [<b>AILabTools</b>](https://www.ailabtools.com) is an advanced tool that
    offers a vast array of simple and flexible API endpoints to suit your
    specific needs. With just one [<b>API
    KEY</b>](https://www.ailabtools.com/doc/get-api-key), you can easily call
    any of the endpoints and integrate them quickly into your application or
    workflow, allowing for smooth and efficient operations.


    [<b>AILabTools</b>](https://www.ailabtools.com) is continuously evolving,
    and you can anticipate even more API endpoints being added in the future,
    further enhancing its capabilities and usefulness for your artificial
    intelligence and machine learning requirements.
  version: 1.0.0
servers:
  - url: https://www.ailabapi.com
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: AI IMAGE
  - name: AI IMAGE > Image Enhancement
  - name: AI IMAGE > Image Effects
  - name: AI IMAGE > Image Editing
  - name: AI IMAGE > Image Scoring
  - name: AI BACKGROUND REMOVAL
  - name: AI BACKGROUND REMOVAL > Portrait
  - name: AI BACKGROUND REMOVAL > General
  - name: AI PORTRAIT
  - name: AI PORTRAIT > Portrait Effects
  - name: AI PORTRAIT > Portrait Enhance
  - name: AI PORTRAIT > Portrait Editing
  - name: AI PORTRAIT > Portrait Analysis
  - name: AI COMMON
paths:
  /api/cutout/general/commodity-background-removal:
    post:
      tags:
        - AI BACKGROUND REMOVAL > General
      summary: Product Background Removal
      description: >-
        Product Background Removal API removes product backgrounds and isolates
        items for clean e-commerce images, catalogs, and marketplace listings.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                image:
                  type: string
                  format: binary
                return_form:
                  type: string
                  description: >-
                    Specifies the form of the returned image. <li>If not set,
                    the four-channel PNG map is returned.</li> <li>`mask`:
                    Returns a single channel mask.</li> <li>`whiteBK`: Return to
                    white background image.</li> <li>`crop`: Returns the
                    four-channel PNG image after cropping (cropping out the
                    blank areas around the edges).</li>
      responses:
        '200':
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              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: ''
          description: Success
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: ailabapi-api-key
      description: API Key for authentication

````