API reference · Bria

bria/video/background-removal/realtime

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

VIDEOAsyncOpen model
Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run
Model IDbria/video/background-removal/realtime
01

Input Schema

5 parameters · 1 required · 4 optional

ParameterTypeRequiredDescription
imagestringRequiredPlayground webcam/video source. Media is sent over WebRTC. · Default: ""
blur_strengthintegerOptionalBackground blur strength, 0-100 (used when background_type is 'blur'). · Min: 0 · Max: 100 · Default: 50
background_typestringOptionalHow to replace the background: 'color', 'image', or 'blur'. · Options: color, image, blur · Default: "color"
colorimageblur
background_colorstringOptionalSolid background colour (used when background_type is 'color'). · Options: Black, White, Gray, Red, Green, Blue, Yellow, Cyan, Magenta, Orange · Default: "Black"
BlackWhiteGrayRedGreenBlueYellowCyanMagentaOrange
background_image_urlstringOptionalBackground image URL or data URI (used when background_type is 'image'). · Default: null
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

  1. Submit — POST to /v1/run, receive an id
  2. Poll — GET /v1/run/{id} until status is completed, failed, or timeout
  3. Retrieve — Read outputs from the completed response
03

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "bria/video/background-removal/realtime",
  "image": "",
  "blur_strength": 50,
  "background_type": "color",
  "background_color": "Black",
  "background_image_url": null,
  "prompt": "a beautiful sunset over mountains"
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"