Skip to main content
bfl/erase-v1 的 API 参考文档,由 Comfy Router 提供,模型来自 Black Forest Labs。

快速开始

你的 Comfy 工作区 中创建密钥并导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdknpm install @comfyorg/sdk);cURL 片段则是通过原始 HTTP 发出的同一调用。 Model ID: bfl/erase-v1 Endpoint: POST https://api.comfy.org/v2/models/bfl/erase-v1

架构

输入

integer
默认值:"10"
移除之前对遮罩进行膨胀的像素数。膨胀有助于覆盖对象边缘。最大为 25 像素。范围:025
string
必填
Base64 编码的输入图像,或 HTTP(S) 图片网址。
string
必填
Base64 编码的黑白遮罩,或 HTTP(S) 图片网址。白像素表示要移除的对象;黑像素则保留。必须与输入图像尺寸相同。
string
可选值:jpegpngwebp
integer
默认值:"2"
输入和输出审核的阈值级别。介于 0 与 5 之间,0 最严格,5 最宽松。范围:05
integer
可选种子,用于结果复现。
string
可选密钥,用于 webhook 签名验证。
string (uri)
接收 webhook 通知的网址。格式:uri
该文档根据 Router 在 GET /v2/models/bfl/erase-v1/openapi.json 提供的 schema 生成,也是请求到达提供商之前,Router 用来校验调用的同一份文档。

输出

number
提供商上报的积分成本,任务进入 Ready 后填充。格式:float
string
必填
BFL 任务标识符。
number
BFL 上报的可选生成进度。范围:01格式:float
object
必填
已完成的生成结果。此处不可为 null:该组件的 required 条目承诺 200 响应必定携带结果,而可为 null 的 result 会将其降格为仅检查键是否存在。
number
提供商上报的本次生成成本。这是 BFL 的数值,而非 Comfy 的计费。格式:double
number
提供商上报的生成时长,单位为秒。格式:double
number
提供商上报的生成完成时间,为自 Unix 纪元起的秒数。使用 double 的原因与 start_time 相同。格式:double
string
生成实际运行时使用的提示词,即经过提示词上采样之后的结果。
string (uri)
已生成资源的签名网址。Router 会将资源重新托管到 Comfy 存储并重写该字段,因此它通常是 Comfy 托管的网址,有效期最长 24 小时:签发时按 24 小时签名,并从 23 小时的备忘中重放,因此较晚的轮询可能拿回只剩一小时有效期的链接;如果某个叶节点的重新托管无法完成,则改为保留 BFL 自有的短时效分发网址:视频大约两小时,图像大约十分钟。无论哪种情况链接都会过期,因此请下载资源,而不要存储该网址。格式:uri
integer
生成所使用的种子,无论是外部提供还是由提供商选定。声明为 int64,因为 BFL 会返回超过 2^31 的种子(例如 2784347701),而未指定格式的 integer 在许多 SDK 生成器中会生成为 32 位字段。格式:int64
number
提供商上报的生成开始时间,为自 Unix 纪元起的秒数。使用 double 而非 float:在当前纪元值附近,float32 的间隔约为 128 秒,会把整次生成的跨度压缩成单个解码值。格式:double
string
必填
任务状态:Pending、Reasoning、Generating、Ready、Request Moderated、Content Moderated、Error 或 Task not found。

示例

输入

输出

发布前须知

SDK 会生成 Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。 请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入。生成的资源请及时下载,因为结果链接会过期

请求头

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

使用 Router API

模型发现、校验错误、重试与计费。

限制

Router 目前不支持的功能,以及替代方案。