Skip to main content
bfl/flux-pro-1.0-canny 的 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/flux-pro-1.0-canny 端点: POST https://api.comfy.org/v2/models/bfl/flux-pro-1.0-canny
将相同的请求体发送到 POST https://api.comfy.org/v2/models/bfl/flux-pro-1.0-canny/requests。运行被受理后,Router 会立即返回 201 和 request_id;结果就绪后,可以从本进程或其他进程收集。状态、取消与收集的细节见 队列投递。

架构

输入

integer
默认值:"200"
Canny 边缘检测的高阈值范围:0 到 500
integer
默认值:"50"
Canny 边缘检测的低阈值范围:0 到 500
string
在未提供预处理图像时用作控制输入的 Base64 编码图像
number
默认值:"30"
图像生成过程的引导强度范围:1 到 100
`jpeg`, `png`, `webp`
默认值:"\"jpeg\""
已生成图像的输出格式。可以是 ‘jpeg’ 或 ‘png’。
string
可选,用于跳过控制预处理步骤的预处理图像
string
必填
用于图像生成的文本提示词
boolean
默认值:"false"
是否对提示词执行上采样
integer
默认值:"2"
输入和输出审核的阈值。介于 0 和 6 之间,0 最严格,6 最宽松。范围:0 到 6
integer
用于可复现性的可选种子
integer
默认值:"50"
图像生成过程的步数范围:15 到 50
string
用于 webhook 签名验证的可选密钥
string (uri)
用于接收 webhook 通知的 URL
根据 Router 在 GET /v2/models/bfl/flux-pro-1.0-canny/openapi.json 处提供的 schema 生成,这也是请求到达提供商之前,Router 用来验证调用的同一份文档。

输出

number
提供商报告的以积分计的费用,在任务变为 Ready 后填充。格式:float
string
必填
BFL 任务标识符。
number
BFL 报告的可选生成进度。范围:0 到 1格式:float
object
必填
已完成的生成结果。此处不可为空:此组件的 required 条目是一项承诺,即 200 会携带结果,而可空的 result 会使其退化为仅检查键是否存在的检查。
number
提供商报告的生成费用。这是 BFL 的数值,而非 Comfy 的计费。格式:double
number
提供商报告的生成时长(以秒为单位)。格式:double
number
提供商报告的生成完成时间,以自 Unix 纪元起的秒数表示。与 start_time 同理,使用 double。格式:double
string
生成实际运行时使用的提示词,即经过任何提示词上采样之后的提示词。
string (uri)
已生成资源的签名 URL。Router 会将资源重新托管到 Comfy 存储并重写此字段,因此它通常是一个有效期最长 24 小时的 Comfy 托管 URL:签发时按 24 小时签名,并从 23 小时的备忘录中重放,因此稍后轮询可能返回一个仅剩一小时有效期的链接;如果某个叶节点的重新托管无法执行,则会保留 BFL 自己的短时效交付 URL:视频约为两小时,图像约为十分钟。无论哪种情况,链接都会过期,因此请下载资源,而不要存储该 URL。格式:uri
integer
生成所使用的种子,无论是提供的还是由提供商选择的。声明为 int64,因为 BFL 会返回大于 2^31 的种子(例如 2784347701),而许多 SDK 生成器会把未指定格式的 integer 生成为 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 在调用提供商之前就拒绝了输入,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。

请求头

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

使用 Router API

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

限制

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