将 Video Edit V1 与 Comfy Router 配合使用
通过 Comfy Router 调用 bfl/video-edit-v1:端点、请求结构以及 Router 返回的响应。
将 Video Edit V1 与 Comfy Router 配合使用
通过 Comfy Router 调用 bfl/video-edit-v1:端点、请求结构以及 Router 返回的响应。
bfl/video-edit-v1 的 API 参考文档,由 Comfy Router 从 Black Forest Labs 提供。
输入: 视频, 文本 · 输出: 视频
快速开始
在你的 Comfy 工作区中创建密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 发起的同一调用。
模型 ID: bfl/video-edit-v1
端点: POST https://api.comfy.org/v2/models/bfl/video-edit-v1
[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "bfl/video-edit-v1", { "prompt": "Remove the orange bucket.", "video": "https://example.com/clip.mp4", }, ) print(result)``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用它。 const { data } = await comfy.models.run("bfl/video-edit-v1", { prompt: "Remove the orange bucket.", video: "https://example.com/clip.mp4", }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/bfl/video-edit-v1 \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"prompt\": \"Remove the orange bucket.\", \"video\": \"https://example.com/clip.mp4\"}"``
[tab] 排队并稍后收集 相同的请求体,发送到POST https://api.comfy.org/v2/models/bfl/video-edit-v1/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( "bfl/video-edit-v1", { "prompt": "Remove the orange bucket.", "video": "https://example.com/clip.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("bfl/video-edit-v1", { prompt: "Remove the orange bucket.", video: "https://example.com/clip.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/bfl/video-edit-v1/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"prompt\": \"Remove the orange bucket.\", \"video\": \"https://example.com/clip.mp4\"}" # 2. 轮询直到状态为 COMPLETED,每次响应指定的 Retry-After 秒数都要等待。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/bfl/video-edit-v1/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 和模型的原始输出;仍在运行时返回 202 和状态请求体。 curl https://api.comfy.org/v2/models/bfl/video-edit-v1/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
prompt string required
编辑指令。指明需要更改的对象、场景、风格、屏幕文字或对话;未指明的内容都会被保留。
safety\_tolerance integer (default: 2)
输入和输出审核的阈值等级,0 为最严格。
范围:0 到 4
video string required
要编辑的视频,可以是 HTTP(S) URL,也可以是 base64 编码的 MP4。来源素材最长 15 秒、最大 50 MiB,每一边至少 160 像素;高于 720p 的来源会被降采样到 720p。
本 Schema 由 Router 在 GET /v2/models/bfl/video-edit-v1/openapi.json 提供,Router 在请求到达提供商之前,正是依据同一份文档来校验调用的。
输出
cost number
提供商报告的积分成本,任务进入 Ready 后填充。
格式:float
id string required
BFL 任务标识符。
progress number
BFL 报告的生成进度,可选。
范围:0 到 1
格式:float
result object required
已完成的生成结果。此处不可为空:该组件的 required 条目承诺 200 响应必定携带 result,若 result 可空,就会退化为仅检查键是否存在。
result.cost number
提供商报告的本次生成成本。这是 BFL 的数值,而非 Comfy 的收费。
格式:double
result.duration number
提供商报告的生成时长,单位为秒。
格式:double
result.end\_time number
提供商报告的本次生成完成时间,为自 Unix 纪元起的秒数。出于与 start_time 相同的原因使用 double。
格式:double
result.prompt string
本次生成实际执行的提示词,即经过任何提示词上采样之后的结果。
result.sample string (uri)
已生成资产的签名 URL。Router 会将资产重新托管到 Comfy 存储上并重写此字段,因此它通常是 Comfy 托管的 URL,有效期最长 24 小时:签发时按 24 小时签名,并从 23 小时的缓存记录中回放,因此后续轮询可能返回剩余有效期短至一小时的链接;若某个叶子节点的重新托管无法完成,则会保留 BFL 自己的短期分发 URL,视频大约两小时,图像大约十分钟。无论哪种情况链接都会过期,因此请下载资产,而不要保存 URL。
格式:uri
result.seed integer
本次生成使用的种子,无论是传入的还是由提供商选择的。声明为 int64,因为 BFL 会返回大于 2^31 的种子(例如 2784347701),而未指定格式的 integer 在许多 SDK 生成器中会生成 32 位字段。
格式:int64
result.start\_time number
提供商报告的本次生成开始时间,为自 Unix 纪元起的秒数。使用 double 而非 float:在当今的纪元数值附近,float32 的间隔约为 128 秒,会把一次生成的整个时间跨度坍缩为单个解码值。
格式:double
status string required
任务状态:Pending、Reasoning、Generating、Ready、Request Moderated、Content Moderated、Error 或 Task not found。
示例
输入
{
"prompt": "Remove the orange bucket.",
"video": "https://example.com/clip.mp4"
}
输出
{
"cost": null,
"id": "b2e0c1a4-0f2f-4a55-9f2e-2f9a1c0d4e77",
"progress": null,
"result": {
"cost": null,
"duration": 3.4,
"end_time": 1767225603.4,
"prompt": "A watercolor painting of a lighthouse at dawn, soft light on the water",
"sample": "https://example.invalid/bfl/flux-pro-1.1/sample.png",
"seed": 2784347701,
"start_time": 1767225600
},
"status": "Ready"
}
发布前须知
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 目前不支持的功能,以及替代方案。