Blur Image
Apply a blur effect to an image.
In the playground, ensure at least one field is set to avoid sending a request with an empty body and content-type: application/json, as this is not permitted by the API.
Description
This endpoint allows you to apply 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.
Blurring an image depends on a factor sigma
that determines the intensity of the blur effect.
The higher the value of sigma
, the more intense the blur effect will be.
This value represents the standard deviation of the Gaussian kernel used to apply the blur effect.
Blur effect over a cat image [Normal, Sigma 10, Sigma 20, Sigma 100]
Request Parameters
The request path should contain the following parameters:
The ID of the image to blur.
Request Body
The request body should contain a JSON object with the following fields:
The standard deviation of the Gaussian kernel used to apply the blur effect.
The name of the image to identify it on the dashboard.
Response
The API will return the updated Image object in the response body.
The unique identifier of the image. This identifier is used to reference the image in subsequent requests.
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.
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.
The width of the image in pixels.
The height of the image in pixels.
The format of the image. The format can be one of the following: jpeg
, png
, webp
.
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.
The date and time when the image was created. The date and time are in ISO 8601 format.