Skip to main content
POST

Overview

Starts removing the background of an image; the result is a PNG with real transparency, attached to the image in your library a moment later. The call answers 202 with the media to follow: poll Get Image until backgroundRemoval.status is COMPLETED. The image can be one already in your library (media) or any public URL (imageUrl); a URL is imported into your library first, so the result is always attached to a media you own. An image that already has its background removed answers 200 at once, without a new charge; one whose removal is already running answers 202 again with the same job.
Accepted formats: JPEG, PNG and WEBP, up to 25 MB.

Request Body

string
ID of an image in your media library. Required unless imageUrl is given.
string
Public URL of the image to process. It is saved to your library before processing. Required unless media is given.

Response Fields

string
The library image the cut-out belongs to (the imported one when imageUrl was used).
string
PROCESSING while Bria works (202), COMPLETED when the cut-out already existed (200).
string
Signed URL of the original image.
string
The removal job, while it runs.
string
Signed URL of the PNG with the background removed, when status is COMPLETED. Otherwise read it from Get Image once backgroundRemoval.status is COMPLETED.
number
Credits charged by this call. 0 when nothing new was started.

Status Codes

If Bria fails later, the job ends as backgroundRemoval.status: "FAILED" in Get Image and the credits are refunded.

Get Image

Follow the removal and read the result

Expand Image

Grow an image to another aspect ratio

Remove Video Background

The same for a video

Authorizations

x-api-key
string
header
required

Body

application/json
media
string

ID of an image in your media library. Required unless imageUrl is given.

imageUrl
string<uri>

Public URL of a JPEG, PNG or WEBP image (up to 25 MB). Imported into your library before processing. Required unless media is given.

Response

The image already had its cut-out

success
boolean
message
string
data
object