VEED Video Background Removal Serverless API
Remove any video's background with no green screen, or cleanly key chroma footage, using AI matting.
POST /v2/veed-video-background-removal · submit + poll 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3from segmind import SegmindClient, InferenceFailed, InferenceTimeout
4
5# Async (v2) — recommended for long-running / video models.
6# run() blocks up to 600s; submit_async + job.wait(timeout=...) sets a longer
7# deadline and keeps the request_id so you can re-poll later.
8client = SegmindClient() # reads SEGMIND_API_KEY
9payload = {
10 "video_url": "https://segmind-resources.s3.amazonaws.com/input/veed-video-background-removal-input.mp4",
11 "mode": "standard",
12}
13job = client.submit_async("veed-video-background-removal", **payload)
14print(job.request_id) # available immediately
15try:
16 result = job.wait(timeout=900, interval=2.0)
17 print(result["status"]) # COMPLETED
18 print(result.get("output")) # model output (e.g. video URL)
19except InferenceTimeout as e:
20 print("still running:", e.request_id) # re-poll later with this id
21except InferenceFailed as e:
22 print("failed:", e.detail)
23
24# Fast models (<=600s) can use the one-liner instead:
25# result = segmind.run("veed-video-background-removal", **payload) 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3from segmind import SegmindClient, InferenceFailed, InferenceTimeout
4
5# Async (v2) — recommended for long-running / video models.
6# run() blocks up to 600s; submit_async + job.wait(timeout=...) sets a longer
7# deadline and keeps the request_id so you can re-poll later.
8client = SegmindClient() # reads SEGMIND_API_KEY
9payload = {
10 "video_url": "https://segmind-resources.s3.amazonaws.com/input/veed-video-background-removal-input.mp4",
11 "mode": "standard",
12}
13job = client.submit_async("veed-video-background-removal", **payload)
14print(job.request_id) # available immediately
15try:
16 result = job.wait(timeout=900, interval=2.0)
17 print(result["status"]) # COMPLETED
18 print(result.get("output")) # model output (e.g. video URL)
19except InferenceTimeout as e:
20 print("still running:", e.request_id) # re-poll later with this id
21except InferenceFailed as e:
22 print("failed:", e.detail)
23
24# Fast models (<=600s) can use the one-liner instead:
25# result = segmind.run("veed-video-background-removal", **payload)API Endpoint
https://api.segmind.com/v1/veed-video-background-removalParameters
video_urlrequiredstring (uri)Input video (mp4, mov, webm, m4v, gif).
modeoptionalstringstandard: best quality, no green screen. fast: cheaper/quicker. green-screen: for chromakey footage (with spill suppression).
"standard""standard""fast""green-screen"output_codecoptionalstringvp9: single video with alpha channel. h264: returns JSON with separate RGB + alpha video URLs (better RGB quality).
"vp9""vp9""h264"refine_foreground_edgesoptionalbooleanHigher-quality edges at a higher per-frame rate. Standard/fast modes only.
truespill_suppression_strengthoptionalnumberGreen-screen mode only. Increase if green remains; decrease if subject colors shift.
0.8Range: 0 - 1subject_is_personoptionalbooleanOptimize matting for people. Standard/fast modes only.
trueResponse Type
Returns: Video
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/veed-video-background-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
- 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