将 Video Edit Erase 与 Comfy Router 搭配使用
通过 Comfy Router 调用 bria/video-edit-erase:端点、请求形状以及 Router 返回的响应。
将 Video Edit Erase 与 Comfy Router 搭配使用
通过 Comfy Router 调用 bria/video-edit-erase:端点、请求形状以及 Router 返回的响应。
bria/video-edit-erase 的 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-erase
端点: POST https://api.comfy.org/v2/models/bria/video-edit-erase
[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-erase", { "auto_trim": True, "mask": "https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_mask.mp4", "video": "https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_video.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-erase", { auto_trim: true, mask: "https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_mask.mp4", video: "https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_video.mp4", }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/bria/video-edit-erase \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"auto_trim\": true, \"mask\": \"https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_mask.mp4\", \"video\": \"https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_video.mp4\"}"``
[tab] 提交并稍后收集 相同的请求体,发送到POST https://api.comfy.org/v2/models/bria/video-edit-erase/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-erase", { "auto_trim": True, "mask": "https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_mask.mp4", "video": "https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_video.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-erase", { auto_trim: true, mask: "https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_mask.mp4", video: "https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_video.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-erase/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"auto_trim\": true, \"mask\": \"https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_mask.mp4\", \"video\": \"https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_video.mp4\"}" # 2. 轮询直到状态为 COMPLETED,每个响应都会指定需要等待的 Retry-After 秒数。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/bria/video-edit-erase/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 以及模型的原生输出;仍在运行时返回 202 以及状态正文。 curl https://api.comfy.org/v2/models/bria/video-edit-erase/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
auto\_trim boolean
当为 true 时,超过 5 秒的视频会被裁剪为前 5 秒。当为 false(默认)时,更长的视频会被拒绝。
mask 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。除非 auto\_trim 为 true,否则最长时长为 5 秒。支持的输入分辨率最高为 750p;更大的输入会被缩小。
本文档根据 Router 在 GET /v2/models/bria/video-edit-erase/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
提示词的优化版本;在 Bria 未进行优化的已完成生成中为 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
示例
输入
{
"auto_trim": true,
"mask": "https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_mask.mp4",
"video": "https://bria-test-images.s3.us-east-1.amazonaws.com/videos/eraser/video1_video.mp4"
}
输出
{
"request_id": "0b3f9d7e-2c41-4a8b-9f10-6d5c8e2a4b71",
"result": {
"video_url": "https://example.invalid/bria/video-edit-erase/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 目前不支持的功能,以及替代方案。