openapi: 3.0.0
servers:
  - url: https://prod.api.market/api/v1/ailabtools/product-background-removal
info:
  title: Product Background Removal API
  version: 1.11.0
  description: Effortlessly remove backgrounds from product images, ensuring a
    clean and professional look for your e-commerce platform or marketing
    materials.
paths:
  /cutout/commodity/commodity:
    post:
      tags:
        - AI BACKGROUND REMOVAL > General
      summary: Product background removal
      operationId: 569af92db1dc5f0cc91c066eff4683ef
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              required:
                - image
              properties:
                image:
                  description: "<li>Image format: `JPEG` `JPG` `BMP` `PNG`(8-bit, 16-bit, 64-bit
                    PNG not supported)</li> <li>Image size: No more than 3
                    MB.</li> <li>Image resolution: Less than 2000x2000px.</li>"
                  type: file
                return_form:
                  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>"
                  type: string
                  enum:
                    - mask
                    - whiteBK
                    - crop
              type: object
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                allOf:
                  - properties:
                      data:
                        type: object
                        allOf:
                          - properties:
                              image_url:
                                description: "Resulting image URL address. `Expiration: 24 hours.`"
                                type: string
                            type: object
                    type: object
                  - $ref: "#components/schemas/commonResponses"
        "400":
          description: Bad Request
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
        "404":
          description: Not Found
        "405":
          description: Method Not Allowed
        "409":
          description: Conflict
        "410":
          description: Gone
        "413":
          description: Payload Too Large
        "415":
          description: Unsupported Media Type
        "422":
          description: Unprocessable Entity
        "429":
          description: Too Many Requests
        "500":
          description: Internal Server Error
        "502":
          description: Bad Gateway
        "503":
          description: Service Unavailable
        "504":
          description: Gateway Timeout
    parameters:
      - description: API.market API Key
        in: header
        name: x-api-market-key
        value: Please Login/Signup to get an API Key
        required: true
        schema:
          type: string
components:
  schemas:
    commonResponses:
      properties:
        request_id:
          description: Request ID. If there is a problem that cannot be located, this
            field can be sent to technology for problem location.
          type: string
        log_id:
          description: Log ID. If there is a problem that cannot be located, this field
            can be sent to technology for problem location.
          type: string
        error_code:
          description: "Status code. When HTTP Status is 200: `error_code`=0; otherwise
            exactly the same as HTTP Status."
          type: integer
        error_code_str:
          description: Error Code.
          type: string
        error_msg:
          description: Error message.
          type: string
        error_detail:
          type: object
          allOf:
            - properties:
                status_code:
                  description: Status Code.
                  type: integer
                code:
                  description: "Error Code. Compared to the `error_code_str` field: The code field
                    is more precise."
                  type: string
                code_message:
                  description: The information represented by the Error Code(`code`).
                  type: string
                message:
                  description: Supplementary information for the `code_message` field.
                  type: string
              type: object
      type: object
security: {}
tags:
  - name: visual-recognition
    description: Operations related to visual-recognition
  - name: artificial-intelligence
    description: Operations related to artificial-intelligence