Bria Erase Foreground Serverless API
Seamlessly removes foreground subjects and regenerates backgrounds for flawless image editing.
POST /v2/bria-erase-foreground · 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-erase-foreground",
9 preserve_alpha=True,
10 visual_input_content_moderation=False,
11 visual_output_content_moderation=False,
12)
13print(result["status"]) # COMPLETED
14print(result.get("output")) # model output (e.g. media URL)
15print(result["metrics"]["inference_time"]) # server compute seconds
16
17# --- Or submit + poll manually (track request_id, control the cadence) ---
18from segmind import SegmindClient, InferenceFailed, InferenceTimeout
19
20client = SegmindClient() # reads SEGMIND_API_KEY
21payload = {
22 "preserve_alpha": True,
23 "visual_input_content_moderation": False,
24 "visual_output_content_moderation": False,
25}
26job = client.submit_async("bria-erase-foreground", **payload)
27print(job.request_id) # available immediately
28try:
29 result = job.wait(timeout=600, interval=1.0)
30except InferenceTimeout as e:
31 print("still running:", e.request_id)
32except InferenceFailed as e:
33 print("failed:", e.detail) 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-erase-foreground",
9 preserve_alpha=True,
10 visual_input_content_moderation=False,
11 visual_output_content_moderation=False,
12)
13print(result["status"]) # COMPLETED
14print(result.get("output")) # model output (e.g. media URL)
15print(result["metrics"]["inference_time"]) # server compute seconds
16
17# --- Or submit + poll manually (track request_id, control the cadence) ---
18from segmind import SegmindClient, InferenceFailed, InferenceTimeout
19
20client = SegmindClient() # reads SEGMIND_API_KEY
21payload = {
22 "preserve_alpha": True,
23 "visual_input_content_moderation": False,
24 "visual_output_content_moderation": False,
25}
26job = client.submit_async("bria-erase-foreground", **payload)
27print(job.request_id) # available immediately
28try:
29 result = job.wait(timeout=600, interval=1.0)
30except InferenceTimeout as e:
31 print("still running:", e.request_id)
32except InferenceFailed as e:
33 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/bria-erase-foregroundParameters
imagerequiredstring | stringProvide a source image through a URL or Base64 string. Use a URL for faster processing.
Option 1optionalstring (uri)Option 2optionalstringpreserve_alphaoptionalbooleanChoose to retain the image's alpha channel. Set to false for opaque outputs.
truevisual_input_content_moderationoptionalbooleanEnable to filter inappropriate content. Use for sensitive image handling.
falsevisual_output_content_moderationoptionalbooleanApply moderation on the output image. Ideal for public display verification.
falseResponse 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
POST /v2/bria-erase-foregroundSubmit — returns request_id, status_url, response_url
- 2
GET /v2/requests/{id}/statusPoll — until COMPLETED or FAILED
- 3
GET /v2/requests/{id}Result — final response body
Status states
- 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.
Bad Request
Invalid parameters or request format
Unauthorized
Missing or invalid API key
Forbidden
Insufficient permissions
Not Found
Model or endpoint not found
Insufficient Credits
Not enough credits to process request
Rate Limited
Too many requests
Server Error
Internal server error
Bad Gateway
Service temporarily unavailable
Timeout
Request timed out