> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# 通过 Comfy Router 使用视频背景移除

> 通过 Comfy Router 调用 veed/video-background-removal：端点、请求形状以及 Router 返回的响应。

`veed/video-background-removal` 的 API 参考，由 Comfy Router 从 Veed 提供。

**输入：** 视频 · **输出：** 视频

## 快速开始

在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥，并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK（`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`）；cURL 代码片段是通过原始 HTTP 进行的相同调用。

**模型 ID：** `veed/video-background-removal`

**端点：** `POST https://api.comfy.org/v2/models/veed/video-background-removal`

**等待结果**

```python Python theme={null}
from comfy_sdk import Comfy

# 从环境中读取 COMFY_API_KEY。
# SDK 会自动创建幂等键，并在自动重试时复用它。
with Comfy() as client:
    result = client.models.run(
        "veed/video-background-removal",
        {
            "output_codec": "vp9",
            "refine_foreground_edges": True,
            "subject_is_person": True,
            "video_url": "https://static-assets.veed.io/api-examples/bg-v2v-input.mp4",
        },
    )

print(result)
```

```typescript TypeScript theme={null}
import { comfy } from "@comfyorg/sdk";

// 从环境中读取 COMFY_API_KEY。
// SDK 会自动创建幂等键，并在自动重试时复用它。
const { data } = await comfy.models.run("veed/video-background-removal", {
  output_codec: "vp9",
  refine_foreground_edges: true,
  subject_is_person: true,
  video_url: "https://static-assets.veed.io/api-examples/bg-v2v-input.mp4",
});

console.log(data);
```

```bash cURL theme={null}
curl https://api.comfy.org/v2/models/veed/video-background-removal \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"output_codec\": \"vp9\", \"refine_foreground_edges\": true, \"subject_is_person\": true, \"video_url\": \"https://static-assets.veed.io/api-examples/bg-v2v-input.mp4\"}"
```

**加入队列并稍后收集**

将相同的请求体发送到 `POST https://api.comfy.org/v2/models/veed/video-background-removal/requests`。一旦运行被接纳，Router 就会立即以 `201` 返回 `request_id`，结果就绪后即可收集，无论由当前进程还是另一个进程完成。[排队投递](/zh/development/comfy-router/queue.md)会介绍状态、取消和收集的完整流程。

```python Python theme={null}
import asyncio
from comfy_sdk import AsyncComfy

# 从环境中读取 COMFY_API_KEY。
# 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
async def main():
    async with AsyncComfy() as client:
        handle = await client.models.submit(
            "veed/video-background-removal",
            {
                "output_codec": "vp9",
                "refine_foreground_edges": True,
                "subject_is_person": True,
                "video_url": "https://static-assets.veed.io/api-examples/bg-v2v-input.mp4",
            },
        )
        print("request_id:", handle.request_id)  # 配合模型 ID，这就是另一个进程所需的全部信息

        # 轮询直到请求完成，每次按服务器指定的 Retry-After 等待。
        async for update in handle.iter_events():
            print(update.status, update.queue_position)

        # 提供商自己的载荷，与 models.run() 返回的值相同。
        # 失败或已取消的请求会在这里抛出类型化的 Router 错误。
        result = await handle.get()

    print(result)

asyncio.run(main())
```

```typescript TypeScript theme={null}
import { comfy } from "@comfyorg/sdk";

// 从环境中读取 COMFY_API_KEY。
// 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
const handle = await comfy.models.submit("veed/video-background-removal", {
  output_codec: "vp9",
  refine_foreground_edges: true,
  subject_is_person: true,
  video_url: "https://static-assets.veed.io/api-examples/bg-v2v-input.mp4",
});
console.log("requestId:", handle.requestId); // 配合模型 ID，这就是另一个进程所需的全部信息

// 轮询直到请求完成，每次按服务器指定的 Retry-After 等待。
for await (const update of handle.events()) {
  console.log(update.status, update.queuePosition);
}

// 与 models.run() 返回的结果相同。失败或已取消的请求会在这里被拒绝。
const result = await handle.get();

console.log(result.data);
```

```bash cURL theme={null}
# 1. 提交。Router 会以 201 返回 request_id、status_url、response_url 和 cancel_url。
curl https://api.comfy.org/v2/models/veed/video-background-removal/requests \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"output_codec\": \"vp9\", \"refine_foreground_edges\": true, \"subject_is_person\": true, \"video_url\": \"https://static-assets.veed.io/api-examples/bg-v2v-input.mp4\"}"

# 2. 轮询直到状态为 COMPLETED，每次响应都会指定需要等待的 Retry-After 秒数。
REQUEST_ID="<request_id from the 201 body>"
curl -i https://api.comfy.org/v2/models/veed/video-background-removal/requests/$REQUEST_ID/status \
  -H "X-API-Key: $COMFY_API_KEY"

# 3. 收集。返回 200 和模型的原始输出；仍在运行时返回 202 和状态响应体。
curl https://api.comfy.org/v2/models/veed/video-background-removal/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"
```

## Schema

### 输入

**output\_codec** `string` (default: "vp9")

输出编码：vp9（一个带透明度的 WebM）或 h264（RGB 视频和一个透明度蒙版）。

**refine\_foreground\_edges** `boolean` (default: true)

提升主体边缘的质量。

**subject\_is\_person** `boolean` (default: true)

当主体不是人物时，设置为 false。

**video\_url** `string` *required*

来源视频的公开 http(s) URL。

根据 Router 在 `GET /v2/models/veed/video-background-removal/openapi.json` 提供的 schema 生成，该 schema 与 Router 在请求到达提供商之前用于校验调用的文档相同。

### 输出

**data** `object`

**data.credits\_charged** `integer`

VEED 为该任务收取的积分。任务变为 COMPLETED 后出现。

**data.credits\_estimated** `integer`

任务运行前 VEED 给出的积分预估。仅在提交响应中出现。

**data.error** `object`

失败信息。任务变为 FAILED 后出现。

**data.error.code** `string`

机器可读的失败代码。

**data.error.details** `object[]`

**data.error.message** `string`

人类可读的失败消息。

**data.job\_id** `string`

用于轮询状态的任务ID。

**data.result** `object`

生成的媒体。任务变为 COMPLETED 后出现。视频路由返回 `video`，Clean Audio 返回 `audio`，视频背景移除返回 `files`。

**data.result.audio** `object`

**data.result.audio.content\_type** `string`

文件的 MIME 类型。

**data.result.audio.file\_name** `string`

文件名。

**data.result.audio.file\_size** `integer`

文件大小，以字节为单位。

格式：`int64`

**data.result.audio.url** `string`

可下载该文件的 URL。

**data.result.files** `object[]`

视频背景移除的输出。对于 `vp9`，为一个带透明度的 WebM；对于 `h264`，为 RGB 视频和一个透明度蒙版。

**data.result.files\[].content\_type** `string`

文件的 MIME 类型。

**data.result.files\[].file\_name** `string`

文件名。

**data.result.files\[].file\_size** `integer`

文件大小，以字节为单位。

格式：`int64`

**data.result.files\[].url** `string`

可下载该文件的 URL。

**data.result.video** `object`

**data.result.video.content\_type** `string`

文件的 MIME 类型。

**data.result.video.file\_name** `string`

文件名。

**data.result.video.file\_size** `integer`

文件大小，以字节为单位。

格式：`int64`

**data.result.video.url** `string`

可下载该文件的 URL。

**data.status** `string`

任务状态：PROCESSING、COMPLETED、FAILED 或 CANCELLED。

## 示例

### 输入

```json theme={null}
{
  "output_codec": "vp9",
  "refine_foreground_edges": true,
  "subject_is_person": true,
  "video_url": "https://static-assets.veed.io/api-examples/bg-v2v-input.mp4"
}
```

### 输出

```json theme={null}
{
  "data": {
    "credits_charged": 23,
    "job_id": "2a8065b6-9f4e-4132-bb7f-e99db65726bd",
    "result": {
      "files": [
        {
          "content_type": "application/octet-stream",
          "url": "https://example.invalid/veed/foreground.webm"
        }
      ]
    },
    "status": "COMPLETED"
  }
}
```

## 发布前须知

SDK 会生成 `Idempotency-Key` 并在自动重试中复用它。手动重试时，请复用原始 key。Router 最长可保持连接 10 分钟。

请求失败时，Router 会发送 `X-Comfy-Error-Type` 响应头说明原因。`422` 表示 Router 在调用提供商之前就拒绝了输入，`413` 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载，因为[结果 URL 会过期](/zh/development/comfy-router/reference.md#结果资产)。

上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。Router 会对整个请求体另行设置上限，base64 编码的媒体内容也计入其中：参见[请求体大小](/zh/development/comfy-router/limitations.md)。

本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 `comfy-sdk` / `@comfyorg/sdk` 包还提供第二个客户端，用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图：`Comfy(api_key=...)` / `new Comfy({ apiKey })`，并带有 `client.workflows`、`client.assets` 和 `client.jobs`。请参阅 [Comfy SDKs](/zh/development/api-development/sdks.md)。

> **[请求头](/zh/development/comfy-router/headers.md)**
>
> 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。

> **[使用 Router API](/zh/development/comfy-router/api.md)**
>
> 模型发现、验证错误、重试与计费。

> **[限制](/zh/development/comfy-router/limitations.md)**
>
> Router 目前不支持的功能，以及替代方案。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.