Documentation Index Fetch the complete documentation index at: https://docs.img-processing.com/llms.txt
Use this file to discover all available pages before exploring further.
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 > ;
The unique identifier of the image to blur.
The body parameters for blurring the image. The name of the image to identify it on the dashboard.
The standard deviation of the Gaussian kernel used to apply the blur effect.
const imageObject = await client . images . blur ( 'image_etm0g3x5iap4cld1qcfsjvo2' , { sigma: 5 });
Adjusts the brightness, saturation, and hue of an image. modulate ( imageID : string , body : ImageModulateParams | null | undefined = {}, options ?: RequestOptions ): APIPromise < ImageObject > ;
The unique identifier of the image to modulate.
The body parameters for modulating the image. The brightness level to apply to the image. Value should be between -100 and 100, where 0 is no change.
The contrast level to apply to the image. Value should be between -100 and 100, where 0 is no change.
The exposure multiplier to apply to the image.
The name of the modulation. This is used to identify the modulation in the dashboard.
The saturation multiplier to apply to the image.
const imageObject = await client . images . modulate ( 'image_etm0g3x5iap4cld1qcfsjvo2' , { brightness: 10 , saturation: 20 });
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
The unique identifier of the image to remove the background from.
The body parameters for removing the background from the image. Show ImageRemoveBackgroundParams
The name of the image to identify it on the dashboard.
const imageObject = await client . images . removeBackground ( 'image_etm0g3x5iap4cld1qcfsjvo2' );
