Skip to main content

AILabTools API - AI Image cropping - API

Request

  • URL: https://www.ailabapi.com/api/image/editing/image-cropping
  • Method: POST
  • Content-Type: multipart/form-data

Image requirements

  • Image format: JPEG JPG PNG BMP WEBP
  • Image size: No more than 3.5 MB.
  • Image resolution: Less than 2000x2000px.
  • The images must all be RGB 3-channel.
FieldRequiredTypeDescription
ailabapi-api-keyYESstringApplication API KEY. Get API KEY

Body

FieldRequiredTypeDescription
imageYESfile
widthYESintegerThe width of the target. Unit: px.
heightYESintegerThe height of the target. Unit: px.

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.
+urlstringThe URL address of the image after size transformation.
+retain_locationobjectThe coordinate information of the original image data in the generated image.
++widthintegerOutputs the width of the original image after isoscaling according to the specified width. Unit: px.
++heightintegerOutputs the height of the original image after isoscaling according to the specified height. Unit: px.
++yintegerThe y-coordinate of the upper-left corner of the original figure.
++xintegerThe x coordinate of the upper left corner of the original figure.
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": {
"url": "",
"retain_location": {
"width": 0,
"height": 0,
"y": 0,
"x": 0
}
}
}

Code example

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