v1

latestOpenAPI 3.0.02026-08-062312216.0 KB
v2 endpoints

Remove Background

Try out this capability in Bria's sandbox

Description

The Remove BG Route can be used to remove the background of an image. This route leverages Bria's newest model, RMBG 2.0. For more details and to explore the model, check out the Hugging Face demo.

Content Moderation

This endpoint includes granular content moderation controls to ensure safe usage across all stages of processing:

  • Input Image Moderation – Scans the uploaded image and stops processing if inappropriate or restricted content is detected.
  • Output Image Moderation – Evaluates the generated image and blocks the response if it violates safety guidelines.

Constraints

The Bria API currently supports only JPEG and PNG files in RGB, RGBA, or CMYK color modes. When the file is of a different type or color mode, the status code 415 will be returned.

Transparency and Customizable Binarization

This endpoint returns an image where the background is removed, and the foreground remains with varying levels of transparency, allowing for smoother edges and more natural blending when placed over different backgrounds. Additionally, this unique output provides developers with the flexibility to binarize the result—transforming it into a binary mask—by setting a custom transparency threshold according to their specific use case. A binary mask is an image where pixels are either fully visible (foreground) or fully transparent (background), commonly used in visual generative AI and image processing pipelines. This capability enables seamless integration into workflows that require clear separation between subject and background, while still offering control over how strict this separation should be.

Below is a simple Python script to demonstrate how you can binarize the output image from the API. This allows you to set your own threshold to determine which areas are considered "foreground" and which are "background."

from PIL import Image
import numpy as np

# Load the image (the output from the API)
image = Image.open('output_image.png').convert('RGBA')

# Convert to numpy array
data = np.array(image)

# Define your threshold (0-255, where 255 is fully opaque)
threshold = 128

# Apply the threshold: if alpha > threshold, set to fully opaque (255), otherwise transparent (0)
data[:, :, 3] = np.where(data[:, :, 3] > threshold, 255, 0)

# Create a new Image from the modified array
binarized_image = Image.fromarray(data)

# Save or display
binarized_image.save('binarized_output.png')
binarized_image.show()
  ```
post/remove_background

Headers

api_tokenstring required

Request body

imagestring required

The image that you would like to remove the background from. Supported input types:

  • Base64-encoded string
  • URL pointing to an image file that is publicly accessible and available at the time of processing.

Accepted formats: JPEG, JPG, PNG, WEBP.

preserve_alphaboolean

Controls whether partially transparent areas from the input image are retained in the output after background removal, if the input includes an alpha channel.

  • When true: Partially transparent pixels preserve their original alpha values in the output.
  • When false: All non-background areas in the output are rendered fully opaque.
  • Has no effect if the input image does not include an alpha channel.
syncboolean

Specifies the response mode.

  • When false (default), the request is processed asynchronously: the API immediately returns a status URL to track progress.
  • When true, the request is processed synchronously: the API hold the connection open until the proccess is complete and then returns the final image URL in the response.
webhook_urlstring uri

Optional URL for receiving the result via webhook when the async job completes. See Webhooks.

visual_input_content_moderationboolean

When enabled, applies content moderation to input visual.

Expected behavior:

  • Processing stops if the image fails moderation.
  • Returns a 422 error with details about which parameter failed.
visual_output_content_moderationboolean

When enabled, applies content moderation to result visual.

Expected behavior:

  • If the modified image fails moderation, returns a 422 error.

Response

Successful operation (Synchronous Success)

request_idstring required