Crop Image
Crops an image to the specified dimensions
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
Request Parameters
The request path should contain the following parameters:
The ID of the image to crop.
Request Body
The request body should contain a JSON object with the following fields:
The x-coordinate of the top-left corner of the crop area.
The y-coordinate of the top-left corner of the crop area.
The x-coordinate of the bottom-right corner of the crop area.
The y-coordinate of the bottom-right corner of the crop area.
The name of the image to identify it on the dashboard.
Response
The API will return the created Image object in the response body.
The unique identifier of the image. This identifier is used to reference the image in subsequent requests.
The name of the image. This name is provided when uploading the image and is the way the image is identified in your account. It is not unique, in fact, each transformation you make to an image will create a new image with the same name.
The public URL of the image. By default, this URL is not available and will be null.
You can make the image public by using the publish endpoint.
Once the image is public, the URL will be updated with the public URL.
The width of the image in pixels.
The height of the image in pixels.
The format of the image. The format can be one of the following: jpeg, png, webp.
The estimated size of the image in bytes. The size is an estimate and may not be exact since images can be compressed or optimized depending on the format and quality settings used during processing.
The date and time when the image was created. The date and time are in ISO 8601 format.