Image Editing

Blur Background

Changed on

Description

The background/blur Route is used to create a blur effect on the background of an image.

post/background/blur

Request

  • Base URL: https://engine.prod.bria-api.com/v1
  • URL: https://engine.prod.bria-api.com/v1/background/blur
  • Auth: none declared. Required headers: api_token

Headers

api_tokenstring required

Request body

image_urlstring

The URL of the input image. If both image_url and image_file are provided, image_url will be used. Accepted formats are jpeg, jpg, png, webp. Maximum file size 12MB.

filestring

The file of the input image, in base64 format. Used if image_url is not provided. Accepted formats are jpeg, jpg, png, webp. Maximum file size 12MB.

scaleinteger

A scale for determining how blurry the background of the image should be. The options are 1, 2, 3, 4, 5. This parameter is optional.

force_rmbgboolean

Forces background removal, even if the original image already contains an alpha channel. Useful for refining existing foreground/background separation or ignoring unnecessary alpha channels.

Example request

{
  "image_url": "URL"
}

Response

Successful operation.

result_urlstring

URL that represents the updated visual created in the request. It is a temporary URL that will expire

Example response

{
  "result_url": "URL"
}

Changes