POST
/
v1
/
images
/
{imageId}
/
watermark
POST /v1/images/<imageId>/watermark HTTP/1.1
Host: api.img-processing.com
x-api-key: <api-key>
Content-Type: application/json

{
    "watermarks": [
        {
            "id": "image_etm0g3x5iap4cld1qcfsjvo2",
            "top": 100,
            "left": 100
        }
    ]
}
{
    "id": "image_etm0g3x5iap4cld1qcfsjvo2",
    "name": "watermarked-image",
    "url": null,
    "width": 460,
    "height": 460,
    "format": "jpeg",
    "size": 282000,
    "created_at": "2021-09-01T12:00:00.000Z"
}

Guide

Learn how to apply watermarks to an image

​
Description

This endpoint allows you to add watermarks to an image. Watermarks are a great way to protect your images from unauthorized use and to promote your brand.

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.

​
Path Parameters

​
imageId
string
required

The unique identifier of the image. This identifier is used to reference the image in subsequent requests.

​
Request Body

​
watermarks
array
required

An array of watermark objects to apply to the image.

​
name
string

The name of the image. If not provided, the image name will be the same as the original image.

​
Response

The API will return the updated Image object in the response body.

​
id
image_{string}

The unique identifier of the image. This identifier is used to reference the image in subsequent requests.

​
name
string

The name of the image. This name is provided when uploading the image and is the way the image is identified in your account. It is not unique, in fact, each transformation you make to an image will create a new image with the same name.

​
url
url | null

The public URL of the image. By default, this URL is not available and will be null. You can make the image public by using the publish endpoint. Once the image is public, the URL will be updated with the public URL.

​
width
integer

The width of the image in pixels.

​
height
integer

The height of the image in pixels.

​
format
jpeg | png | webp

The format of the image. The format can be one of the following: jpeg, png, webp.

We are constantly adding new formats to the API, so make sure to check the latest documentation for the most up-to-date list of supported formats.

​
size
integer

The estimated size of the image in bytes. The size is an estimate and may not be exact since images can be compressed or optimized depending on the format and quality settings used during processing.

​
created_at
datetime

The date and time when the image was created. The date and time are in ISO 8601 format.

POST /v1/images/<imageId>/watermark HTTP/1.1
Host: api.img-processing.com
x-api-key: <api-key>
Content-Type: application/json

{
    "watermarks": [
        {
            "id": "image_etm0g3x5iap4cld1qcfsjvo2",
            "top": 100,
            "left": 100
        }
    ]
}
{
    "id": "image_etm0g3x5iap4cld1qcfsjvo2",
    "name": "watermarked-image",
    "url": null,
    "width": 460,
    "height": 460,
    "format": "jpeg",
    "size": 282000,
    "created_at": "2021-09-01T12:00:00.000Z"
}