AILabTools API - Animal background removal - API

---

draft: true

Important Announcement: API End of Maintenance Notice

Dear Developers,

We sincerely appreciate your continued support and use of our API over the years. Throughout this time, we have strived to provide high-quality services and reliable API interfaces to meet your needs.

However, due to technological advancements and adjustments in our business strategies, we regret to announce the discontinuation of maintenance and support for the current API. This means that we will no longer be releasing new features, fixing known issues, or providing technical support.

If you have any questions or need assistance regarding this change, please feel free to reach out to our support team ([email protected]). We are committed to assisting you and making this transition process as smooth as possible.

Once again, we thank you for your continued support and cooperation.

Warm regards,

AILabTools Support Team

Request

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

Image requirements

• Image format: JPEG JPG BMP PNG
• Image size: No more than 3 MB.
• Image resolution: Larger than 50x50px, smaller than 2000x2000px.

Headers

Field	Required	Type	Description
ailabapi-api-key	YES	string	Application API KEY. 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

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

Field	Type	Description
data	object	The content of the result data returned.
+image_url	string	Resulting 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.

Response Example

{
  "request_id":     "",
  "log_id":         "",
  "error_code":     0,
  "error_msg":      "",
  "error_detail":   {
    "status_code":  200,
    "code":         "",
    "code_message": "",
    "message":      ""
  },
  "data":           {
    "image_url": ""
  }
}

Sample Code

• Introduction to Get Sample Code
• Sample Code