Image Editing

Erase Foreground

Changed on

Description

This route is used to erase the foreground from a provided image, while generating the area behind it.

post/erase_foreground

Request

  • Base URL: https://engine.prod.bria-api.com/v1
  • URL: https://engine.prod.bria-api.com/v1/erase_foreground
  • 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.

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