POST
/
v1
/
images
/
{imageId}
/
resize

​
Description

This endpoint creates a new image by resizing an existing image.

At the moment, there are three fit modes available:

Available fit modes

  • fill: The image is resized to fill the specified dimensions, stretching/squishing the image to fit the provided dimensions. This is the default fit mode.
  • contain: The image is resized to fit within the specified dimensions, maintaining the aspect ratio, and adding a letterbox if necessary.
  • cover: The image is resized to cover the specified dimensions, maintaining the aspect ratio, cropping/clipping the image if necessary.

Additionally, you can specify the background color for the letterbox when using the contain fit mode, and the gravity for cropping or positioning the image when using the cover and contain fit modes.

The next image shows the available gravity modes with a white letterbox_color and a contain fit mode:

Available gravity modes with a white letterbox_color and a contain fit mode

​
Request Parameters

The request path should contain the following parameters:

imageId
string
required

The ID of the image to resize.

​
Request Body

The request body should contain a JSON object with the following fields:

width
integer
required

The desired width of the resized image in pixels.

height
integer
required

The desired height of the resized image in pixels.

letterbox_color
string
default: "transparent | #000"

The color of the letterbox when using the contain fit mode. It can be a color name, a hex color code, or transparent.

position
string
default: "center"

The gravity position of the image when using the cover or contain fit modes.

Available options: center, top, right, bottom, left, top-right, top-left, bottom-right, bottom-left.

fit
string
default: "fill"

The fit mode to use when resizing the image.

Available options: fill, contain, cover.

name
string
default: "<old name>"

The name of the image to identify it on the dashboard.

​
Response

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

id
image_{string}

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

name
string

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.

url
url | null

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.

width
integer

The width of the image in pixels.

height
integer

The height of the image in pixels.

format
jpeg | png | webp

The format of the image. The format can be one of the following: jpeg, png, webp.

We are constantly adding new formats to the API, so make sure to check the latest documentation for the most up-to-date list of supported formats.

size
integer

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.

created_at
datetime

The date and time when the image was created. The date and time are in ISO 8601 format.

Mirror ImageRotate Image