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

{
    "brightness": 2,
    "name": "bright-image"
}
{
    "id": "image_etm0g3x5iap4cld1qcfsjvo2",
    "name": "bright-image",
    "url": null,
    "width": 460,
    "height": 460,
    "format": "jpeg",
    "size": 282000,
    "created_at": "2021-09-01T12:00:00.000Z"
}

​
Description

This endpoint allows you to adjust the brightness, saturation, and hue of an image.

Brightness is one of the three properties of color, along with hue and saturation. It refers to the amount of light in an image, with a high brightness making the image lighter and a low brightness making the image darker.

On the other hand, saturation refers to the intensity of the colors in an image. A high saturation value will make the colors more vivid, while a low saturation value will make the colors more muted.

Finally, hue refers to the color of the image. It is represented as a circular color space, with red, green, and blue forming the primary colors.

Color Wheel

​
Request Parameters

The request path should contain the following parameters:

​
imageId
string
required

The ID of the image to adjust the brightness.

​
Request Body

The request body should contain a JSON object with the following fields:

​
brightness
number
required

The brightness level to apply to the image. The difference between the brightness and lightness parameters is that brightness multiplies the color values, while lightness adds a constant value to the color values.

​
saturation
number
required

The saturation multiplier to apply to the image.

​
hue
integer
required

The hue rotation angle in degrees to apply to the image.

​
lightness
number
required

The lightness to add to the image. The difference between the brightness and lightness parameters is that brightness multiplies the color values, while lightness adds a constant value to the color values.

​
name
string
default:"<old name>"

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

​
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}/modulate HTTP/1.1
Host: api.img-processing.com
x-api-key: <api-key>
Content-Type: application/json

{
    "brightness": 2,
    "name": "bright-image"
}
{
    "id": "image_etm0g3x5iap4cld1qcfsjvo2",
    "name": "bright-image",
    "url": null,
    "width": 460,
    "height": 460,
    "format": "jpeg",
    "size": 282000,
    "created_at": "2021-09-01T12:00:00.000Z"
}