Bria Extract Object Serverless API
Extract any named object into a transparent PNG cutout.
POST /v2/bria-extract-object · 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-extract-object",
9 image="https://segmind-resources.s3.amazonaws.com/input/bria-extract-object-input.jpg",
10 prompt="the bright red ceramic coffee mug",
11 autocrop=True,
12 remove_background=False,
13 visual_input_content_moderation=False,
14 visual_output_content_moderation=False,
15)
16print(result["status"]) # COMPLETED
17print(result.get("output")) # model output (e.g. media URL)
18print(result["metrics"]["inference_time"]) # server compute seconds
19
20# --- Or submit + poll manually (track request_id, control the cadence) ---
21from segmind import SegmindClient, InferenceFailed, InferenceTimeout
22
23client = SegmindClient() # reads SEGMIND_API_KEY
24payload = {
25 "image": "https://segmind-resources.s3.amazonaws.com/input/bria-extract-object-input.jpg",
26 "prompt": "the bright red ceramic coffee mug",
27 "autocrop": True,
28 "remove_background": False,
29 "visual_input_content_moderation": False,
30 "visual_output_content_moderation": False,
31}
32job = client.submit_async("bria-extract-object", **payload)
33print(job.request_id) # available immediately
34try:
35 result = job.wait(timeout=600, interval=1.0)
36except InferenceTimeout as e:
37 print("still running:", e.request_id)
38except InferenceFailed as e:
39 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-extract-object",
9 image="https://segmind-resources.s3.amazonaws.com/input/bria-extract-object-input.jpg",
10 prompt="the bright red ceramic coffee mug",
11 autocrop=True,
12 remove_background=False,
13 visual_input_content_moderation=False,
14 visual_output_content_moderation=False,
15)
16print(result["status"]) # COMPLETED
17print(result.get("output")) # model output (e.g. media URL)
18print(result["metrics"]["inference_time"]) # server compute seconds
19
20# --- Or submit + poll manually (track request_id, control the cadence) ---
21from segmind import SegmindClient, InferenceFailed, InferenceTimeout
22
23client = SegmindClient() # reads SEGMIND_API_KEY
24payload = {
25 "image": "https://segmind-resources.s3.amazonaws.com/input/bria-extract-object-input.jpg",
26 "prompt": "the bright red ceramic coffee mug",
27 "autocrop": True,
28 "remove_background": False,
29 "visual_input_content_moderation": False,
30 "visual_output_content_moderation": False,
31}
32job = client.submit_async("bria-extract-object", **payload)
33print(job.request_id) # available immediately
34try:
35 result = job.wait(timeout=600, interval=1.0)
36except InferenceTimeout as e:
37 print("still running:", e.request_id)
38except InferenceFailed as e:
39 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/bria-extract-objectParameters
imagerequiredstring | stringSource image to extract from. Pass a public URL or a base64 data URI (JPEG, JPG, PNG, WEBP).
"https://bria-datasets.s3.amazonaws.com/object-extraction/tools_construction_flatlay.jpg"Option 1optionalstring (uri)Option 2optionalstringpromptrequiredstringNatural-language description of the object to extract, e.g. 'the red car'. When similar objects appear in the image, be specific — 'the sneaker on the left' rather than 'the sneaker'.
"yellow hammer"autocropoptionalbooleanTighten the output canvas around the extracted object. When false, the cutout is returned on a canvas matching the input image dimensions.
falseremove_backgroundoptionalbooleanRefine the cutout's alpha with background removal (RMBG) for softer, matte-quality edges. Leave off when matting would over-trim text, logos or graphics.
falsevisual_input_content_moderationoptionalbooleanRun content moderation on the input image. Processing stops if the image fails moderation.
falsevisual_output_content_moderationoptionalbooleanRun content moderation on the extracted image. The result is blocked if it fails moderation.
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-extract-objectSubmit — 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