ComfyPilotComfyPilot
文档 / 开发 / 配合 Comfy Router 使用 Video Edit Green Screen

配合 Comfy Router 使用 Video Edit Green Screen

通过 Comfy Router 调用 bria/video-edit-green-screen:端点、请求结构以及 Router 返回的响应。

开发 code 更新于 2026-10-19

查看官方原文

配合 Comfy Router 使用 Video Edit Green Screen

通过 Comfy Router 调用 bria/video-edit-green-screen:端点、请求结构以及 Router 返回的响应。

bria/video-edit-green-screen 的 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-green-screen

端点: POST https://api.comfy.org/v2/models/bria/video-edit-green-screen

[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-green-screen", { "green_shade": "broadcast_green", "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-green-screen", { green_shade: "broadcast_green", video: "https://example.com/input.mp4", }); console.log(data); ` `bash cURL theme={null} curl https://api.comfy.org/v2/models/bria/video-edit-green-screen \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"green_shade\": \"broadcast_green\", \"video\": \"https://example.com/input.mp4\"}" ``
[tab] 排队并稍后收集 相同的请求体,发送到 POST https://api.comfy.org/v2/models/bria/video-edit-green-screen/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-green-screen", { "green_shade": "broadcast_green", "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) # 提供商自身的 payload,与 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-green-screen", { green_shade: "broadcast_green", 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() 返回的结果相同。失败或已取消的请求会在此处被拒绝。 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-green-screen/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"green_shade\": \"broadcast_green\", \"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-green-screen/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集结果。成功时返回 200 及模型的原始输出,仍在运行时返回 202 及状态正文。 curl https://api.comfy.org/v2/models/bria/video-edit-green-screen/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

Schema

输入

green\_shade string

用于色度抠像、应用在前景后方的纯色背景底色。默认值为 broadcast\_green。

可选值:broadcast_green、chroma_green、blue_screen

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-green-screen/openapi.json 提供的 schema 生成,Router 在请求送达提供商之前,会用同一份文档来校验调用。

输出

error object

错误对象(仅在 status 为 ERROR 时存在)

error.code integer

错误码。

error.details string

额外的错误详情。

error.message string

报错信息。

request\_id string

请求的唯一标识符。

result object

结果对象(仅在 status 为 COMPLETED 时存在)

result.image\_url string

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

result.prompt string

原始提示词。

result.refined\_prompt string

提示词的优化版本;若某次 COMPLETED 的生成中 Bria 未做优化,则为 null。之所以可为空,是因为该键是存在的并携带 null,而非被省略;这是在 bria/image-edit-gen-fill 上实测观察到的。

result.seed integer

生成所用的种子。

result.structured\_instruction string

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

result.structured\_prompt string

详细的 JSON 结构化提示词。

result.video\_url string

已生成视频的 URL。

status string

请求的当前状态。

可选值:IN_PROGRESS、COMPLETED、ERROR、UNKNOWN

示例

输入

{
  "green_shade": "broadcast_green",
  "video": "https://example.com/input.mp4"
}

输出

{
  "request_id": "0b3f9d7e-2c41-4a8b-9f10-6d5c8e2a4b71",
  "result": {
    "video_url": "https://example.invalid/bria/video-edit-green-screen/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 目前不支持的功能,以及替代方案。