# Video Background Removal API

> 無需綠幕即可移除影片背景，適用於人物或其他主體

隔離 `video_url` 中的主體，並根據 `output_codec` 輸出單一含 alpha 通道的 VP9 影片，或分開的 RGB 與 alpha H264 影片。`refine_foreground_edges` 可改善邊緣，對非人物主體可關閉 `subject_is_person`。這是標準版本。

- Model id: `veed/video-background-removal`
- Made by: VEED
- Category: Background Removal
- Output: video
- Price per 30 frames of your input video: from $0.015 / 30 frames of input video (cheapest run $0.015 (15 API credits))
- Run: `POST https://api.doitong.com/v1/run/veed/video-background-removal`
- Quote: `POST https://api.doitong.com/v1/quote/veed/video-background-removal`
- Docs page: https://doitong.com/zh-TW/developers/models/veed/video-background-removal

## Pricing

Price: **from $0.015 / 30 frames of input video** (the lowest tier; the quote prices your exact input). Price per 30 frames of your input video: the input files are measured before the run (length, resolution, frame rate). The quote measures the same files and is exactly what the run charges.

The full example input below costs $0.225 = 225 API credits (10 × 30 frames input video × $0.0225).

Prices are the upstream price in USD, paid from the API balance in API credits (1000 API credits = 1 USD). `POST https://api.doitong.com/v1/quote/veed/video-background-removal` with the same JSON body returns the exact price for that input; the quote is exactly what a run charges. Invalid input is never charged and failed or canceled requests are refunded automatically.

## Input parameters

Send either the canonical name or the native field name (not both). Canonical names are the same across models.

| Parameter | Canonical name | Type | Required | Default | Allowed values / range | Description |
|---|---|---|---|---|---|---|
| `video_url` | `video` | string (video URL) | yes |  | 1 – 2083 characters |  |
| `output_codec` |  | enum (string) | no | `vp9` | `vp9`, `h264` | 影片轉碼器選擇：H264 建議用於較佳 RGB 品質，並會產生分開的 rgb 與 alpha 影片。VP9 則會將色彩與 alpha 通道封裝在同一部影片中。 |
| `refine_foreground_edges` |  | boolean | no | `true` |  | 邊緣細化，以改善擷取物件的邊界品質。 |
| `subject_is_person` |  | boolean | no | `true` |  | 人物主體設定；對非人類主體使用 False。 |

File parameters (`video`) take a public `https://` URL, a `data:` URI up to 10 MB, or the `file_url` of an upload from `POST /files`.

## Example input

Required parameters only:

```json
{
  "video": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
}
```

A fuller example:

```json
{
  "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
}
```

## Run it

Set `DOITONG_API_KEY` to a key from https://doitong.com/developers/dashboard#keys. `?wait=20` returns the finished request in the same call when it is ready within 20 seconds; otherwise poll `GET /requests/{id}` (it also accepts `?wait=`), or pass `webhook_url`.

### curl

```bash
# Run the model; wait up to 20 s for the finished result in the same call
curl -X POST "https://api.doitong.com/v1/run/veed/video-background-removal?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
  }'

# Still "queued" or "running"? Poll with the id from the response:
curl "https://api.doitong.com/v1/requests/REQUEST_ID?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY"
```

### JavaScript

```javascript
const API = "https://api.doitong.com/v1";
const headers = {
  "Authorization": "Bearer " + process.env.DOITONG_API_KEY,
  "Content-Type": "application/json",
};

// Run the model; wait up to 20 s for the finished result in the same call
let res = await fetch(API + "/run/veed/video-background-removal?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
  }),
});
let request = await res.json();
if (!res.ok) throw new Error(request.error.code + ": " + request.error.message);

// Not finished yet: long-poll until it is
while (request.status === "queued" || request.status === "running") {
  res = await fetch(API + "/requests/" + request.id + "?wait=20", { headers });
  request = await res.json();
}
if (request.status !== "succeeded") throw new Error(JSON.stringify(request.error));
console.log(request.outputs.map((o) => o.url), request.cost.credits + " API credits ($" + request.cost.usd + ")");
```

### Python

```python
import os
import requests

API = "https://api.doitong.com/v1"
headers = {"Authorization": "Bearer " + os.environ["DOITONG_API_KEY"]}

payload = {
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/veed/video-background-removal", params={"wait": 20}, json=payload, headers=headers)
request = r.json()
if not r.ok:
    raise RuntimeError(request["error"]["code"] + ": " + request["error"]["message"])

# Not finished yet: long-poll until it is
while request["status"] in ("queued", "running"):
    request = requests.get(API + "/requests/" + request["id"], params={"wait": 20}, headers=headers).json()
if request["status"] != "succeeded":
    raise RuntimeError(request["error"])
print([o["url"] for o in request["outputs"]], request["cost"]["credits"], "API credits", "$" + request["cost"]["usd"])
```

### MCP

The MCP server at `https://api.doitong.com/v1/mcp` exposes the tools `search_models`, `get_model`, `quote`, `run`, `get_request`, `cancel_request`, `list_requests`, `create_upload` and `get_account`. A `run` call for this model:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "run",
    "arguments": {
      "model_id": "veed/video-background-removal",
      "input": {
        "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
      },
      "wait_seconds": 20
    }
  }
}
```

## Response

Every call returns a request object. `status` is one of `queued`, `running`, `succeeded`, `failed`, `canceled`. `outputs` lists the generated files with URLs on our storage (kept forever, or 7 days with `?storage=temporary`; `storage` says which); `output` is the model's own result object with the same URLs.

```json
{
  "id": "req_8k2m4q7x1z9c3v5b6n0p2r4t",
  "object": "request",
  "model": "veed/video-background-removal",
  "status": "succeeded",
  "created_at": "2026-10-20T12:00:00Z",
  "started_at": "2026-10-20T12:00:02Z",
  "completed_at": "2026-10-20T12:00:09Z",
  "queue_position": null,
  "cost": {
    "credits": 225,
    "usd": "0.225",
    "charged": 225,
    "refunded": 0
  },
  "input": {
    "video_url": "https://content.doitong.com/video/showcase/v3/gen_fox_cartoon.mp4"
  },
  "output": {
    "video": [
      {
        "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.mp4",
        "content_type": "video/mp4",
        "file_name": "0-output.mp4",
        "file_size": 1843200
      }
    ]
  },
  "outputs": [
    {
      "type": "video",
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.mp4",
      "content_type": "video/mp4",
      "file_size": 1843200,
      "width": 1280,
      "height": 720,
      "duration": 5,
      "stored": true
    }
  ],
  "error": null,
  "metrics": {
    "inference_seconds": 6.8
  },
  "urls": {
    "self": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t",
    "cancel": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t/cancel"
  }
}
```

### Output fields (`output`)

| Field | Type | Description |
|---|---|---|
| `video` | array of object {url, content_type, file_name, file_size} |  |

## Related models

- [Video Background Removal · Fast](https://doitong.com/developers/models/veed/video-background-removal/fast.md) (`veed/video-background-removal/fast`): from $0.008 / 30 frames of input video
- [Video Background Removal · Green Screen](https://doitong.com/developers/models/veed/video-background-removal/green-screen.md) (`veed/video-background-removal/green-screen`): $0.025 / 30 frames of input video
- [BiRefNet V2 Background Removal](https://doitong.com/developers/models/birefnet/v2.md) (`birefnet/v2`): $0.002 / run
- [Bria RMBG 2.0](https://doitong.com/developers/models/bria/background/remove.md) (`bria/background/remove`): from $0.018 / request
- [ben-v2-image](https://doitong.com/developers/models/ben/v2/image.md) (`ben/v2/image`): $0.102 / run
- [Ben-Video-Bg-Rm](https://doitong.com/developers/models/ben/v2/video.md) (`ben/v2/video`): $0.001 / megapixel of input video
- [Birefnet](https://doitong.com/developers/models/birefnet/v2/video.md) (`birefnet/v2/video`): $0.000575 / second of processing time
- [Birefnet Background Removal](https://doitong.com/developers/models/birefnet.md) (`birefnet`): $0.002 / run

## Links

- HTML page: https://doitong.com/developers/models/veed/video-background-removal
- All models and guides for AI agents: https://doitong.com/developers/llms.txt
- OpenAPI 3.1 with this model's typed request body: https://doitong.com/developers/openapi.json?model=veed/video-background-removal
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/veed/video-background-removal