Applies watermarks to a specific image. Watermarks are a great way to protect your images from unauthorized use and to promote your brand.
addWatermark(imageID: string, body: ImageAddWatermarkParams, options?: RequestOptions): APIPromise<ImageObject>;
Show addWatermarkOptions
Show addWatermarkOptions
string
required
The unique identifier of the image to add a watermark to.
object
required
The body parameters for adding a watermark to the image.
Show ImageAddWatermarkParams
Show ImageAddWatermarkParams
array
required
An array of watermark objects to apply to the image
Show Watermark
Show Watermark
string
required
The ID of the image to use as a watermark. Must be a valid image ID.
number
The height of the watermark in pixels. If not provided, the watermark will be applied at its original height.
number
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.
string
The repetition mode of the watermark. If not provided, the watermark will be applied once
number
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.
number
The width of the watermark in pixels. If not provided, the watermark will be applied at its original width.
Show Examples
Show Examples
const imageObject = await client.images.addWatermark('image_etm0g3x5iap4cld1qcfsjvo2', { watermarks: [{ id: 'id' }] });