Multi-Image Methods

watermark

Add overlay images to a base image.

At the moment, you can only add image watermarks to your images. You must upload your watermark, apply the transformations, and once you have the desired watermark, apply it to your images using this endpoint.

watermark(options: WatermarkOptions): Promise<ImageObject>;

watermarks

array

required

An array of watermark objects to apply to the image.

string

required

The unique identifier of the image to use as a watermark.

top

integer

required

The position of the watermark from the top of the image to apply the watermark.

left

integer

required

The position of the watermark from the left of the image to apply the watermark.

width

integer

The width of the watermark. If not provided, the watermark will be applied with its original width.

Width must be between 1 and 2048.

height

integer

The height of the watermark. If not provided, the watermark will be applied with its original height.

Height must be between 1 and 2048.

repetition_mode

string

default:"no_repeat"

The repetition mode of the watermark. If not provided, the watermark will be applied once.

Available options: no_repeat, repeat, repeat_x, repeat_y.

It is mandatory to provide at least one watermark object.
The maximum number of watermarks that can be applied to an image at the same time is 5. If you need to apply more watermarks, use the resulting image as an input to add more watermarks.

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.

const watermarked = await image.watermark({
    watermarks: [
        {
            id: 'image_watermark_id',
            top: 0,
            left: 0,
        },
    ],
});

Get Started

IMG Processing Client

ImageObject