使用 Comfy Router 进行视频编辑替换背景

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

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

输入： 视频, 文本 · 输出： 视频

快速开始

在你的 Comfy 工作区中创建密钥，并将其导出为 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

[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键，并在自动重试时复用它。 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"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键，并在自动重试时复用它。 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\"}" ``

[tab] 排队并稍后收集将相同的请求体发送到 POST https://api.comfy.org/v2/models/bria/video-edit-replace-background/requests。运行被受理后，Router 会立即返回 201 和 request_id；结果就绪后，可以从本进程或其他进程收集。队列投递介绍了状态、取消与收集。 ``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( "bria/video-edit-replace-background", { "background_url": "https://example.com/background.mp4", "video": "https://example.com/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("bria/video-edit-replace-background", { background_url: "https://example.com/background.mp4", video: "https://example.com/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() 返回的结果相同。失败或已取消的请求会在此处 reject。 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/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. 轮询直到状态为 COMPLETED，每个响应给出多少秒 Retry-After 就等待多少秒。 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. 收集。仍在运行时返回 200 及模型的原始输出，202 及状态信息体。 curl https://api.comfy.org/v2/models/bria/video-edit-replace-background/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

Schema

输入

background\_url string required

可公开访问的背景素材（图像或视频）URL，用于合成到前景之后。必须与前景的宽高比匹配。

output\_container\_and\_codec string

输出容器与编解码器预设。

可能的值：mp4_h264、mp4_h265、webm_vp9、mov_h265、mov_proresks、mkv_h264、mkv_h265、mkv_vp9、gif

preserve\_audio boolean

是否保留输入（前景）视频中的音频。

video string required

可公开访问的输入（前景）视频 URL。输入分辨率最高支持 16000x16000（16K）。最大时长为 60 秒。

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

输出

error object

错误对象（仅当状态为 ERROR 时存在）

error.code integer

错误码。

error.details string

补充的错误详情。

error.message string

报错信息。

request\_id string

请求的唯一标识符。

result object

结果对象（仅当状态为 COMPLETED 时存在）

result.image\_url string

已生成/编辑后图像的 URL。

result.prompt string

原始提示词。

result.refined\_prompt string

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

result.seed integer

生成所用的种子。

result.structured\_instruction string

结构化指令，即由 /v2/structured_instruction/generate 返回的、以字符串形式序列化的 JSON 文档。该操作不会填充任何一个 URL。

result.structured\_prompt string

详细的 JSON 结构化提示词。

result.video\_url string

已生成视频的 URL。

status string

请求的当前状态。

可能的值：IN_PROGRESS、COMPLETED、ERROR、UNKNOWN

示例

输入

{
  "background_url": "https://example.com/background.mp4",
  "video": "https://example.com/input.mp4"
}

输出

{
  "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 在调用提供商之前就拒绝了输入，413 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载，因为结果 URL 会过期。

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

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

[card] 请求头身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。

[card] 使用 Router API 模型发现、验证错误、重试与计费。

[card] 限制 Router 目前不支持的功能，以及替代方案。