Bria Generate Background Serverless API

Transform images through advanced background editing and generative content creation for diverse applications.

~18.71s
POST /v2/bria-replace-background · submit + poll
 1# pip install "segmind>=1.1.0"
 2# export SEGMIND_API_KEY="YOUR_API_KEY"
 3import segmind
 4
 5# Async (v2): submit to the queue and block until COMPLETED.
 6# run() returns the final result dict (600s deadline, 1.0s poll by default).
 7result = segmind.run(
 8    "bria-replace-background",
 9    ref_images="sample text",
10    enhance_ref_images=True,
11    prompt="In a parking lot",
12    refine_prompt=True,
13    prompt_content_moderation=True,
14    negative_prompt="no cars",
15    original_quality=False,
16    force_background_detection=False,
17    fast=False,
18    visual_input_content_moderation=False,
19    visual_output_content_moderation=False,
20    seed=1234,
21)
22print(result["status"])                      # COMPLETED
23print(result.get("output"))                  # model output (e.g. media URL)
24print(result["metrics"]["inference_time"])   # server compute seconds
25
26# --- Or submit + poll manually (track request_id, control the cadence) ---
27from segmind import SegmindClient, InferenceFailed, InferenceTimeout
28
29client = SegmindClient()                      # reads SEGMIND_API_KEY
30payload = {
31    "ref_images": "sample text",
32    "enhance_ref_images": True,
33    "prompt": "In a parking lot",
34    "refine_prompt": True,
35    "prompt_content_moderation": True,
36    "negative_prompt": "no cars",
37    "original_quality": False,
38    "force_background_detection": False,
39    "fast": False,
40    "visual_input_content_moderation": False,
41    "visual_output_content_moderation": False,
42    "seed": 1234,
43}
44job = client.submit_async("bria-replace-background", **payload)
45print(job.request_id)                         # available immediately
46try:
47    result = job.wait(timeout=600, interval=1.0)
48except InferenceTimeout as e:
49    print("still running:", e.request_id)
50except InferenceFailed as e:
51    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/bria-replace-background

Parameters

imagerequired
string | string

The primary image for processing; Keep quality high for best output. For example, use URLs like 'https://yourimage.com/main.jpg'.

Exactly one of:
Option 1optional
string (uri)
Option 2optional
string
enhance_ref_imagesoptional
boolean

Improves reference image quality; Set true for enhanced images, false for original.

Default: true
fastoptional
boolean

Speeds up processing; use true for quick outputs.

Default: false
force_background_detectionoptional
boolean

Detects background with transparency; true improves control.

Default: false
negative_promptoptional
string

Excludes unwanted elements; specify like 'no cars'.

Default: "no cars"
original_qualityoptional
boolean

Retains original resolution; true for high-res, false for faster results.

Default: false
promptoptional
string

Defines desired scene; use clear, simple language like 'sunny beach with palm trees'.

Default: "In a parking lot"
prompt_content_moderationoptional
boolean

Ensures prompt safety; always true for moderated content.

Default: true
ref_imagesoptional
string (uri)

Reference images for guidance; Use similar style images such as 'https://examples.com/ref1.jpg', 'https://examples.com/ref2.jpg'.

Default: null
refine_promptoptional
boolean

Refines complex descriptions; true for detailed prompts, false for straightforward.

Default: true
seedoptional
integer

Sets result reproducibility; use specific numbers like '1234'.

Default: 1234
visual_input_content_moderationoptional
boolean

Checks input for safety; enable during public demos.

Default: false
visual_output_content_moderationoptional
boolean

Ensures output safety; turn on when unsure of results.

Default: false

Response Type

Returns: Image

Asynchronous requests (v2)

Use Async for video, long-running (>~60s), or high-concurrency workloads; Sync is simplest for fast image & LLM calls. Async submits a request and you poll it to completion.

  1. 1
    POST /v2/bria-replace-background

    Submitreturns request_id, status_url, response_url

  2. 2
    GET /v2/requests/{id}/status

    Polluntil COMPLETED or FAILED

  3. 3
    GET /v2/requests/{id}

    Resultfinal response body

Status states

QUEUEDAccepted, waiting for a worker
PROCESSINGRunning on a worker
COMPLETEDDone — result body is ready
FAILEDErrored (incl. content/RAI blocks)
  • A FAILED request is served as HTTP 422 — the body still carries the error detail.
  • An unknown or expired request_id returns HTTP 404.
  • Results are retained for 1 hour, then expire.
  • Content / RAI blocks surface as FAILED, not a separate state.
  • Track completion by polling the status endpoint.

Common Error Codes

The API returns standard HTTP status codes. Detailed error messages are provided in the response body.

400

Bad Request

Invalid parameters or request format

401

Unauthorized

Missing or invalid API key

403

Forbidden

Insufficient permissions

404

Not Found

Model or endpoint not found

406

Insufficient Credits

Not enough credits to process request

429

Rate Limited

Too many requests

500

Server Error

Internal server error

502

Bad Gateway

Service temporarily unavailable

504

Timeout

Request timed out