Transformation Methods

convert

Create a new image by converting an existing image to a different format.

The supported image formats are jpeg, png, and webp.

format

string

required

The format to convert the image to. Supported formats are jpeg, png, and webp.

quality

number

default: "100"

The quality of the converted image if the target format is jpeg.

name

string

The name of the image to identify it on the dashboard. If not provided, the name will be the same as the original image.

crop

Create a new image by cropping an existing image.

integer

required

The x-coordinate of the top-left corner of the crop area.

The x-coordinate must be greater than or equal to 0.

integer

required

The y-coordinate of the top-left corner of the crop area.

The y-coordinate must be greater than or equal to 0.

integer

required

The x-coordinate of the bottom-right corner of the crop area.

The x-coordinate must be greater than the x-coordinate of the top-left corner.

integer

required

The y-coordinate of the bottom-right corner of the crop area.

The y-coordinate must be greater than the y-coordinate of the top-left corner.

name

string

default: "<old name>"

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

The name must be between 1 and 30 characters long.

mirror

Create a new image by mirroring an existing image.

mode

string

required

The mirror mode to apply to the image.

Available modes: horizontal, vertical, both.

name

string

default: "<old name>"

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

The name must be between 1 and 30 characters long.

resize

Create a new image by resizing an existing image.

width

integer

required

The desired width of the resized image in pixels.

The width must be greater than 0.

height

integer

required

The desired height of the resized image in pixels.

The height must be greater than 0.

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.

The name must be between 1 and 30 characters long.

rotate

Create a new image by rotating an existing image.

angle

integer

required

The angle in degrees or radians rotate the image.

unit

string

default: "degrees"

The unit of the angle.

Available units: degrees, radians.

background_color

string

The background color to fill the empty areas after rotating the image.

The background color must be a valid CSS color.

Get Started

IMG Processing Client

ImageObject