Try H3 Max Director
Log-inSign-up
Contact SalesLog-inSign-up

Bria AI logo
bria/video/background-removal/realtime

Remove video backgrounds in real time with Bria’s VRMBG 3.0 model. Built for live streaming, real-time video apps, content creation, and low-latency workflows that need fast, accurate background removal.
Inference
Commercial use
Partner
Schema
LLMs
PlaygroundAPI

Table of contents

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Real-time via WebSockets#

This model has a real-time mode via WebSockets, supported by fal.realtime.connect.

import { fal } from "@fal-ai/client";

const connection = fal.realtime.connect("bria/video/background-removal/realtime", {
  onResult: (result) => {
    console.log(result);
  },
  onError: (error) => {
    console.error(error);
  },
  // Fetch short-lived JWT token from your backend
  tokenProvider: async (app) => {
    const response = await fetch("/api/fal/realtime-token", {
      method: "POST",
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify({ app }),
    });
    return response.text();
  },
  tokenExpirationSeconds: 10,
});

connection.send({});

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In an environment where you cannot set environment variables, you can configure the API key manually on the client.
import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

4. Files#

Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.

Data URI (base64)#

You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.

Hosted files (URL)#

You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.

Uploading files#

We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.

import { fal } from "@fal-ai/client";

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Read more about file handling in our file upload guide.

5. Schema#

Input#

blur_strength integer

Background blur strength, 0-100 (used when background_type is 'blur'). Default value: 50

background_color BackgroundColorEnum

Solid background colour (used when background_type is 'color'). Default value: "Black"

Possible enum values: Black, White, Gray, Red, Green, Blue, Yellow, Cyan, Magenta, Orange

background_type BackgroundTypeEnum

How to replace the background: 'color', 'image', or 'blur'. Default value: "color"

Possible enum values: color, image, blur

image_url string

Playground webcam/video source. Media is sent over WebRTC. Default value: ""

background_image_url string

Background image URL or data URI (used when background_type is 'image'). Default value: "null"

{
  "blur_strength": 50,
  "background_color": "Black",
  "background_type": "color"
}

Output#

{}

Other types#

IceCandidate#

sdpMLineIndex integer
sdpMid string

Default value: "null"

candidate string* required

Related Models