Bria's VRMBG 3.0 Realtime

POST/v1/run

Video Background Removal Realtime is Bria's video-to-video AI model. Transform, enhance, and edit video content using text prompts - from style changes to object manipulation and scene modification.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to bria/video/background-removal/realtime.

Default: bria/video/background-removal/realtime

stringimagerequired

Playground webcam/video source. Media is sent over WebRTC.

Default:

Optional<integer>blur_strength

Background blur strength, 0-100 (used when background_type is 'blur').

Range: 0 to 100

Default: 50

Optional<string>background_color

Solid background colour (used when background_type is 'color').

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

Default: Black

Optional<string>background_type

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

Allowed values: color, image, blur

Default: color

Optional<string>background_image_url

Background image URL or data URI (used when background_type is 'image').

Default: null

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: video-to-video

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async

# 1. Submit a generation request
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "bria/video/background-removal/realtime",
  "image": ""
}'

# 2. If the response is still running, poll the returned id
curl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \
  -H "Authorization: Bearer $SANDBASE_API_KEY"

Response202 Accepted

{
  "id": "f3d2e8a1-7c4b-4a12-9d2e-123456789abc",
  "model": "bria/video/background-removal/realtime",
  "status": "running"
}