API reference · Bria

bria/background/replace

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

IMAGEAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDbria/background/replace

Input Schema

6 parameters · 2 required · 4 optional

Parameter	Type	Required	Description
`image`	string	Required	Input Image to erase from
`prompt`	string	Required	The prompt you would like to use to generate images. · Min length: 1
`fast`	boolean	Optional	Whether to use the fast model · Default: true
`seed`	integer	Optional	The same seed and the same prompt given to the same version of the model will output the same image every time. · Min: 0 · Max: 2147483647
`ref_image_url`	string	Optional	The URL of the reference image to be used for generating the new background. Use "" to leave empty. Either ref_image_url or bg_prompt has to be provided but not both. If both ref_image_url and ref_image_file are provided, ref_image_url will be used. Accepted formats are jpeg, jpg, png, webp. · Default: ""
`refine_prompt`	boolean	Optional	Whether to refine prompt · Default: true

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

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

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

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/background/replace",
  "fast": true,
  "image": "https://static.sandbase.ai/examples/bria/background/replace/input_image_1.jpg",
  "prompt": "Man leaning against a wall",
  "ref_image_url": "https://static.sandbase.ai/examples/bria/background/replace/input_ref_image_url_0.jpg",
  "refine_prompt": true
}'

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

← Back to Bria Background Replace