Transformation Methods - IMG Processing

convert

Converts an image to a different format (jpeg, png, or webp).

convert(imageID: string, body: ImageConvertParams, options?: RequestOptions): APIPromise<ImageObject>;

Show convertOptions

imageID

string

required

The unique identifier of the image to convert.

body

object

required

The body parameters for converting the image.

Show ImageConvertParams

format

string

required

The format to convert the image to (jpeg, png, webp).

name

string

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

quality

number

The quality of the image to convert. It is a number between 1 and 100. If not provided, a default quality will be used.

Show Examples

const imageObject = await client.images.convert('image_etm0g3x5iap4cld1qcfsjvo2', { format: 'jpeg' });

crop

Crops an image by specifying the dimensions of the crop area.

crop(imageID: string, body: ImageCropParams, options?: RequestOptions): APIPromise<ImageObject>;

Show cropOptions

imageID

string

required

The unique identifier of the image to crop.

body

object

required

The body parameters for cropping the image.

Show ImageCropParams

number

required

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

number

required

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

number

required

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

number

required

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

name

string

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

Show Examples

const imageObject = await client.images.crop('image_etm0g3x5iap4cld1qcfsjvo2', { x1: 0, x2: 100, y1: 0, y2: 100 });

mirror

Mirrors an image horizontally or vertically.

mirror(imageID: string, body: ImageMirrorParams, options?: RequestOptions): APIPromise<ImageObject>;

Show mirrorOptions

imageID

string

required

The unique identifier of the image to mirror.

body

object

required

The body parameters for mirroring the image.

Show ImageMirrorParams

mode

string

required

The mode of mirroring (horizontal, vertical, or both).

name

string

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

Show Examples

const imageObject = await client.images.mirror('image_etm0g3x5iap4cld1qcfsjvo2', { mode: 'horizontal' });

resize

Resizes an image, you can use fit to specify how the image is resized.

resize(imageID: string, body: ImageResizeParams | null | undefined = {}, options?: RequestOptions): APIPromise<ImageObject>;

Show resizeOptions

imageID

string

required

The unique identifier of the image to resize.

body

object

The body parameters for resizing the image.

Show ImageResizeParams

fit

string

The fit mode to use when resizing the image (cover, contain, or fill).

height

number

The height of the image to resize.

letterbox_color

string

The color of the letterbox when using the contain fit mode.

name

string

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

position

string

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

width

number

The width of the image to resize.

Show Examples

const imageObject = await client.images.resize('image_etm0g3x5iap4cld1qcfsjvo2', { width: 200, height: 200 });

rotate

Rotates an image by a specified angle.

rotate(imageID: string, body: ImageRotateParams, options?: RequestOptions): APIPromise<ImageObject>;

Show rotateOptions

imageID

string

required

The unique identifier of the image to rotate.

body

object

required

The body parameters for rotating the image.

Show ImageRotateParams

angle

number

required

The angle in degrees or radians to rotate the image.

name

string

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

unit

string

The unit of the angle (degrees or radians). Defaults to degrees if not provided.

Show Examples

const imageObject = await client.images.rotate('image_etm0g3x5iap4cld1qcfsjvo2', { angle: 90 });

Get Started

Methods