Skip to main content
POST
/
api
/
image
/
editing
/
image-cropping
AI Image cropping
curl --request POST \
  --url https://www.ailabapi.com/api/image/editing/image-cropping \
  --header 'Content-Type: multipart/form-data' \
  --header 'ailabapi-api-key: <api-key>' \
  --form image='@example-file' \
  --form 'width=<string>' \
  --form 'height=<string>'
{
  "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
    }
  }
}

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

​
Headers

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

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

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.
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":           {
    "url":             "",
    "retain_location": {
      "width":  0,
      "height": 0,
      "y":      0,
      "x":      0
    }
  }
}

​
Sample Code

👉 Online Experience 👈If you’d like to see the actual effects, please visit the experience page for a trial.

Authorizations

​
ailabapi-api-key
string
header
required

API Key for authentication

Body

multipart/form-data
​
image
file
​
width
string

The width of the target. Unit: px.

​
height
string

The height of the target. Unit: px.

Response

200 - application/json

Success

The response is of type object.