> ## 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 调用 bria/video-edit-replace-background：端点、请求形状以及 Router 返回的响应。

`bria/video-edit-replace-background` 的 API 参考，由 Comfy Router 提供，来源于 Bria。

## 快速开始

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

**模型 ID：** `bria/video-edit-replace-background`

**端点：** `POST https://api.comfy.org/v2/models/bria/video-edit-replace-background`

<Tabs>
  <Tab title="Wait for the result">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # The SDK automatically creates an idempotency key and reuses it for automatic retries.
      with Comfy() as client:
          result = client.models.run(
              "bria/video-edit-replace-background",
              {
                  "background_url": "https://example.com/background.mp4",
                  "video": "https://example.com/input.mp4",
              },
          )

      print(result)
      ```

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

      // Reads COMFY_API_KEY from the environment.
      // The SDK automatically creates an idempotency key and reuses it for automatic retries.
      const { data } = await comfy.models.run("bria/video-edit-replace-background", {
        background_url: "https://example.com/background.mp4",
        video: "https://example.com/input.mp4",
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/bria/video-edit-replace-background \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"background_url\": \"https://example.com/background.mp4\", \"video\": \"https://example.com/input.mp4\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Queue and collect later">
    将相同的请求体发送到 `POST https://api.comfy.org/v2/models/bria/video-edit-replace-background/requests`。运行被受理后，Router 会立即返回 `201` 和 `request_id`；结果就绪后，可以从本进程或其他进程收集。状态、取消与收集的细节见 [Queued delivery](/zh/development/comfy-router/queue)。

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

      # Reads COMFY_API_KEY from the environment.
      # Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      with Comfy() as client:
          handle = client.models.submit(
              "bria/video-edit-replace-background",
              {
                  "background_url": "https://example.com/background.mp4",
                  "video": "https://example.com/input.mp4",
              },
          )
          print("request_id:", handle.request_id)  # with the model ID, all another process needs

          # Poll until the request completes, waiting the Retry-After the server names.
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # The provider's own payload, the same value models.run() returns.
          # A request that failed or was cancelled raises the typed Router error here.
          result = handle.get()

      print(result)
      ```

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

      // Reads COMFY_API_KEY from the environment.
      // Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      const handle = await comfy.models.submit("bria/video-edit-replace-background", {
        background_url: "https://example.com/background.mp4",
        video: "https://example.com/input.mp4",
      });
      console.log("requestId:", handle.requestId); // with the model ID, all another process needs

      // Poll until the request completes, waiting the Retry-After the server names.
      for await (const update of handle.events()) {
        console.log(update.status, update.queuePosition);
      }

      // The same result models.run() returns. A request that failed or was cancelled rejects here.
      const result = await handle.get();

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

      ```bash cURL theme={null}
      # 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
      curl https://api.comfy.org/v2/models/bria/video-edit-replace-background/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"background_url\": \"https://example.com/background.mp4\", \"video\": \"https://example.com/input.mp4\"}"

      # 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/bria/video-edit-replace-background/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
      curl https://api.comfy.org/v2/models/bria/video-edit-replace-background/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### 输入

<ParamField body="background_url" type="string" required>
  可公开访问的背景素材（图像或视频）URL，用于合成到前景之后。必须与前景的宽高比匹配。
</ParamField>

<ParamField body="output_container_and_codec" type="string">
  输出容器与编解码器预设。

  可能的值：`mp4_h264`、`mp4_h265`、`webm_vp9`、`mov_h265`、`mov_proresks`、`mkv_h264`、`mkv_h265`、`mkv_vp9`、`gif`
</ParamField>

<ParamField body="preserve_audio" type="boolean">
  是否保留输入（前景）视频中的音频。
</ParamField>

<ParamField body="video" type="string" required>
  可公开访问的输入（前景）视频 URL。输入分辨率最高支持 16000x16000（16K）。最大时长为 60 秒。
</ParamField>

根据 Router 在 `GET /v2/models/bria/video-edit-replace-background/openapi.json` 提供的 schema 生成，这也是 Router 在请求到达提供商之前校验调用时所依据的同一份文档。

### 输出

<ResponseField name="error" type="object">
  错误对象（仅当状态为 ERROR 时存在）
</ResponseField>

<ResponseField name="error.code" type="integer">
  错误码。
</ResponseField>

<ResponseField name="error.details" type="string">
  补充的错误详情。
</ResponseField>

<ResponseField name="error.message" type="string">
  报错信息。
</ResponseField>

<ResponseField name="request_id" type="string">
  请求的唯一标识符。
</ResponseField>

<ResponseField name="result" type="object">
  结果对象（仅当状态为 COMPLETED 时存在）
</ResponseField>

<ResponseField name="result.image_url" type="string">
  已生成/编辑后图像的 URL。
</ResponseField>

<ResponseField name="result.prompt" type="string">
  原始提示词。
</ResponseField>

<ResponseField name="result.refined_prompt" type="string">
  提示词的精炼版本；若为 Bria 未进行精炼的 COMPLETED 生成，则为 null。之所以可为 null，是因为该键是存在并携带 null，而非被省略；已在 bria/image-edit-gen-fill 上实际观察到。
</ResponseField>

<ResponseField name="result.seed" type="integer">
  生成所用的种子。
</ResponseField>

<ResponseField name="result.structured_prompt" type="string">
  详细的 JSON 结构化提示词。
</ResponseField>

<ResponseField name="result.video_url" type="string">
  已生成视频的 URL。
</ResponseField>

<ResponseField name="status" type="string">
  请求的当前状态。

  可能的值：`IN_PROGRESS`、`COMPLETED`、`ERROR`、`UNKNOWN`
</ResponseField>

## 示例

### 输入

```json theme={null}
{
  "background_url": "https://example.com/background.mp4",
  "video": "https://example.com/input.mp4"
}
```

### 输出

```json theme={null}
{
  "request_id": "0b3f9d7e-2c41-4a8b-9f10-6d5c8e2a4b71",
  "result": {
    "video_url": "https://example.invalid/bria/video-edit-replace-background/generated.mp4"
  },
  "status": "COMPLETED"
}
```

## 发布前须知

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

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

<CardGroup cols={3}>
  <Card title="请求头" icon="list" href="/zh/development/comfy-router/quickstart">
    身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
  </Card>

  <Card title="使用 Router API" icon="code" href="/zh/development/comfy-router/quickstart">
    模型发现、校验错误、重试与计费。
  </Card>

  <Card title="限制" icon="triangle-exclamation" href="/zh/development/comfy-router/limitations">
    Router 目前不支持的功能，以及替代方案。
  </Card>
</CardGroup>