Background Removal Serverless API
This model removes the background image from any image
~1.67s
POST /v2/bg-removal · 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 "bg-removal",
9 image="/bg-removal.jpg",
10 method="object",
11)
12print(result["status"]) # COMPLETED
13print(result.get("output")) # model output (e.g. media URL)
14print(result["metrics"]["inference_time"]) # server compute seconds
15
16# --- Or submit + poll manually (track request_id, control the cadence) ---
17from segmind import SegmindClient, InferenceFailed, InferenceTimeout
18
19client = SegmindClient() # reads SEGMIND_API_KEY
20payload = {
21 "image": "/bg-removal.jpg",
22 "method": "object",
23}
24job = client.submit_async("bg-removal", **payload)
25print(job.request_id) # available immediately
26try:
27 result = job.wait(timeout=600, interval=1.0)
28except InferenceTimeout as e:
29 print("still running:", e.request_id)
30except InferenceFailed as e:
31 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 "bg-removal",
9 image="/bg-removal.jpg",
10 method="object",
11)
12print(result["status"]) # COMPLETED
13print(result.get("output")) # model output (e.g. media URL)
14print(result["metrics"]["inference_time"]) # server compute seconds
15
16# --- Or submit + poll manually (track request_id, control the cadence) ---
17from segmind import SegmindClient, InferenceFailed, InferenceTimeout
18
19client = SegmindClient() # reads SEGMIND_API_KEY
20payload = {
21 "image": "/bg-removal.jpg",
22 "method": "object",
23}
24job = client.submit_async("bg-removal", **payload)
25print(job.request_id) # available immediately
26try:
27 result = job.wait(timeout=600, interval=1.0)
28except InferenceTimeout as e:
29 print("still running:", e.request_id)
30except InferenceFailed as e:
31 print("failed:", e.detail)API Endpoint
POST
https://api.segmind.com/v1/bg-removalParameters
imagerequiredstring (uri)Input Image
methodoptionalstringMethod
Default:
"object"Allowed values :
"object""human"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
POST /v2/bg-removalSubmit — 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
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