Edition Methods - IMG Processing

blur

Applies a blur effect to an image. Blurring an image can be useful for various purposes, such as anonymizing sensitive information, creating a soft-focus effect, loader skeletons, etc.

blur(imageID: string, body: ImageBlurParams | null | undefined = {}, options?: RequestOptions): APIPromise<ImageObject>;

Show blurOptions

imageID

string

required

The unique identifier of the image to blur.

body

object

The body parameters for blurring the image.

Show ImageBlurParams

name

string

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

sigma

number

The standard deviation of the Gaussian kernel used to apply the blur effect.

Show Examples

const imageObject = await client.images.blur('image_etm0g3x5iap4cld1qcfsjvo2', { sigma: 5 });

modulate

Adjusts the brightness, saturation, and hue of an image.

modulate(imageID: string, body: ImageModulateParams | null | undefined = {}, options?: RequestOptions): APIPromise<ImageObject>;

Show modulateOptions

imageID

string

required

The unique identifier of the image to modulate.

body

object

The body parameters for modulating the image.

Show ImageModulateParams

brightness

number

The brightness level to apply to the image. Value should be between -100 and 100, where 0 is no change.

contrast

number

The contrast level to apply to the image. Value should be between -100 and 100, where 0 is no change.

exposure

number

The exposure multiplier to apply to the image.

name

string

The name of the modulation. This is used to identify the modulation in the dashboard.

saturation

number

The saturation multiplier to apply to the image.

Show Examples

const imageObject = await client.images.modulate('image_etm0g3x5iap4cld1qcfsjvo2', { brightness: 10, saturation: 20 });

removeBackground

Removes the background from an image. Removing the background from an image can be useful for various purposes, such as creating a transparent background or isolating the subject of the image.

removeBackground(imageID: string, body: ImageRemoveBackgroundParams | null | undefined = {}, options?: RequestOptions): APIPromise<ImageObject>;

Show removeBackgroundOptions

imageID

string

required

The unique identifier of the image to remove the background from.

body

object

The body parameters for removing the background from the image.

Show ImageRemoveBackgroundParams

name

string

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

Show Examples

const imageObject = await client.images.removeBackground('image_etm0g3x5iap4cld1qcfsjvo2');

blur

Applies a blur effect to an image. Blurring an image can be useful for various purposes, such as anonymizing sensitive information, creating a soft-focus effect, loader skeletons, etc.

blur(imageID: string, body: ImageBlurParams | null | undefined = {}, options?: RequestOptions): APIPromise<ImageObject>;

Show blurOptions

imageID

string

required

The unique identifier of the image to blur.

body

object

The body parameters for blurring the image.

Show ImageBlurParams

name

string

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

sigma

number

The standard deviation of the Gaussian kernel used to apply the blur effect.

Show Examples

const imageObject = await client.images.blur('image_etm0g3x5iap4cld1qcfsjvo2', { sigma: 5 });

modulate

Adjusts the brightness, saturation, and hue of an image.

modulate(imageID: string, body: ImageModulateParams | null | undefined = {}, options?: RequestOptions): APIPromise<ImageObject>;

Show modulateOptions

imageID

string

required

The unique identifier of the image to modulate.

body

object

The body parameters for modulating the image.

Show ImageModulateParams

brightness

number

The brightness level to apply to the image. Value should be between -100 and 100, where 0 is no change.

contrast

number

The contrast level to apply to the image. Value should be between -100 and 100, where 0 is no change.

exposure

number

The exposure multiplier to apply to the image.

name

string

The name of the modulation. This is used to identify the modulation in the dashboard.

saturation

number

The saturation multiplier to apply to the image.

Show Examples

const imageObject = await client.images.modulate('image_etm0g3x5iap4cld1qcfsjvo2', { brightness: 10, saturation: 20 });

removeBackground

Removes the background from an image. Removing the background from an image can be useful for various purposes, such as creating a transparent background or isolating the subject of the image.

removeBackground(imageID: string, body: ImageRemoveBackgroundParams | null | undefined = {}, options?: RequestOptions): APIPromise<ImageObject>;

Show removeBackgroundOptions

imageID

string

required

The unique identifier of the image to remove the background from.

body

object

The body parameters for removing the background from the image.

Show ImageRemoveBackgroundParams

name

string

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

Show Examples

const imageObject = await client.images.removeBackground('image_etm0g3x5iap4cld1qcfsjvo2');