Bria Guided Remove Background API

Remove backgrounds by prompt into transparent PNG cutouts.

PlaygroundAPI
Pricing
~20.06s
POST /v2/bria-remove-background-guided · 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-remove-background-guided",
 9    image="https://segmind-resources.s3.amazonaws.com/input/bria-remove-background-guided-input.png",
10    prompt="only the red accordion",
11    preserve_alpha=True,
12    visual_input_content_moderation=False,
13    visual_output_content_moderation=False,
14)
15print(result["status"])                      # COMPLETED
16print(result.get("output"))                  # model output (e.g. media URL)
17print(result["metrics"]["inference_time"])   # server compute seconds
18
19# --- Or submit + poll manually (track request_id, control the cadence) ---
20from segmind import SegmindClient, InferenceFailed, InferenceTimeout
21
22client = SegmindClient()                      # reads SEGMIND_API_KEY
23payload = {
24    "image": "https://segmind-resources.s3.amazonaws.com/input/bria-remove-background-guided-input.png",
25    "prompt": "only the red accordion",
26    "preserve_alpha": True,
27    "visual_input_content_moderation": False,
28    "visual_output_content_moderation": False,
29}
30job = client.submit_async("bria-remove-background-guided", **payload)
31print(job.request_id)                         # available immediately
32try:
33    result = job.wait(timeout=600, interval=1.0)
34except InferenceTimeout as e:
35    print("still running:", e.request_id)
36except InferenceFailed as e:
37    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/bria-remove-background-guided

Parameters

imagerequired
string | string

Source image to cut out. Pass a public URL or a base64 data URI (JPEG, JPG, PNG, WEBP).

Default: "https://segmind-resources.s3.amazonaws.com/input/bria-remove-background-guided-input.png"
Exactly one of:
Option 1optional
string (uri)
Option 2optional
string
preserve_alphaoptional
boolean

Keep partial transparency from an input image that already has an alpha channel. When false, every kept pixel is rendered fully opaque. No effect on inputs without alpha.

Default: true
promptoptional
string

Plain words that change what the cutout keeps. Add to the default cut ('the person with the mat and the plant'), drop from it ('the woman at her desk without the lamp'), or narrow it to one item ('only the chair'). Leave blank for a standard background removal.

Default: "only the red accordion"
visual_input_content_moderationoptional
boolean

Run content moderation on the input image. Processing stops if the image fails moderation.

Default: false
visual_output_content_moderationoptional
boolean

Run content moderation on the cutout. The result is blocked if it fails moderation.

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-remove-background-guided

    Submit — returns request_id, status_url, response_url

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

    Poll — until COMPLETED or FAILED

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

    Result — final response body

Status states

QUEUED— Accepted, waiting for a worker
PROCESSING— Running on a worker
COMPLETED— Done — result body is ready
FAILED— Errored (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