Bria Eraser Serverless API

AI object removal with seamless context-aware inpainting.

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

API Endpoint

POSThttps://api.segmind.com/v1/bria-eraser

Parameters

imagerequired
string | string

Source image URL (JPEG/PNG). Use high-resolution for best fill quality.

Default: "https://segmind-resources.s3.amazonaws.com/input/eb8b89ca-9506-4e67-8356-6214f5f6162e-4d423914-87ba-4e92-8f28-21538c9c6154.jpeg"
Exactly one of:
Option 1optional
string (uri)
Option 2optional
string
maskrequired
string (uri)

Mask URL highlighting regions to erase. White areas are removed and refilled.

Default: "https://segmind-resources.s3.amazonaws.com/examples/sample-mask-img.jpg"
mask_typeoptional
string

manual for brush-defined masks; automatic for AI-detected object removal.

Default: "manual"
Allowed values :
"manual""automatic"
visual_input_content_moderationoptional
boolean

Screens input image for inappropriate content. Enable for compliance pipelines.

Default: true
visual_output_content_moderationoptional
boolean

Screens output image before return. Enable for public or regulated deliveries.

Default: true

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-eraser

    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