POST
/
v1
/
images
/
{image_id}
/
resize
curl --request POST \
  --url https://api.img-processing.com/v1/images/{image_id}/resize \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "width": 300,
  "height": 200,
  "name": "resized-image",
  "letterbox_color": "transparent",
  "position": "center",
  "fit": "contain"
}'
{
  "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"
}

Guide

Learn how to resize an image

​
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

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.