Methods
Multi-Image Methods
Work with multiple images
addWatermark
Applies watermarks to a specific image. Watermarks are a great way to protect your images from unauthorized use and to promote your brand.
Copy
addWatermark(imageID: string, body: ImageAddWatermarkParams, options?: RequestOptions): APIPromise<ImageObject>;
Show addWatermarkOptions
Show addWatermarkOptions
The unique identifier of the image to add a watermark to.
The body parameters for adding a watermark to the image.
Show ImageAddWatermarkParams
Show ImageAddWatermarkParams
An array of watermark objects to apply to the image
Show Watermark
Show Watermark
The ID of the image to use as a watermark. Must be a valid image ID.
The height of the watermark in pixels. If not provided, the watermark will be applied at its original height.
The position of the watermark from the left of the image to apply the watermark. If not provided, the watermark will be applied at the left of the image.
The repetition mode of the watermark. If not provided, the watermark will be applied once
The position of the watermark from the top of the image to apply the watermark. If not provided, the watermark will be applied at the top of the image.
The width of the watermark in pixels. If not provided, the watermark will be applied at its original width.
Show Examples
Show Examples
Copy
const imageObject = await client.images.addWatermark('image_etm0g3x5iap4cld1qcfsjvo2', { watermarks: [{ id: 'id' }] });
Assistant
Responses are generated using AI and may contain mistakes.