POST
/
v1
/
images
/
{image_id}
/
crop
curl --request POST \
  --url https://api.img-processing.com/v1/images/{image_id}/crop \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "x1": 100,
  "y1": 100,
  "x2": 300,
  "y2": 300,
  "name": "cropped-image"
}'
{
  "id": "image_etm0g3x5iap4cld1qcfsjvo2",
  "name": "Processed Image",
  "url": "https://storage.img-processing.com/images/image_etm0g3x5iap4cld1qcfsjvo2",
  "width": 460,
  "height": 460,
  "format": "jpeg",
  "size": 282000,
  "created_at": "2021-09-01T12:00:00.000Z"
}

​
Description

With this endpoint, you can crop an image by specifying the dimensions of the crop area.

The crop area is defined by 2 points: the top-left corner at (x1, y1) and the bottom-right corner at (x2, y2).

Example of a crop area

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Path Parameters

​
image_id
string
required

The unique identifier of the image. This identifier is used to reference the image in subsequent requests.

Body

application/json

Response

201
application/json

The API will return the Image object in the response body.

The Image object represents an image processed using the IMG Processing API. The object contains information about the image, such as its URL, size, and format. The Image object is returned in the response body of all image processing requests.