快速开始
在你的 Comfy 工作区中创建密钥,并将其导出为COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk);cURL 代码片段是通过原始 HTTP 发出的同一调用。
选择你要调用的模型。下面的全部内容,从代码片段到 schema 和示例,都随你的选择而变化。
- Kontext Pro
- Kontext Max
Model ID: 由 Router 在 该 URL 是临时的。如果需要保留图像,请及时下载。
bfl/flux-kontext-proEndpoint: POST https://api.comfy.org/v2/models/bfl/flux-kontext-pro- Wait for the result
- Queue and collect later
Schema
输入
string
输出的宽高比,介于 21:9 和 9:21 之间,例如 16:9。当提供了输入图像时,默认为输入图像的宽高比,否则为 1:1。
string
要编辑的图像,为 base64 编码的图像或 http(s) URL。可选;不提供时,模型仅根据提示词生成。
string
额外的参考图像,base64 编码或 http(s) URL(实验性多参考)。
string
额外的参考图像,base64 编码或 http(s) URL(实验性多参考)。
string
额外的参考图像,base64 编码或 http(s) URL(实验性多参考)。
string
默认值:"\"png\""
输出图像格式。可能的值:
jpeg、png、webpstring
必填
描述要应用于 input_image 的编辑操作,或在未提供 input_image 时要生成的图像的文本提示词。
boolean
默认值:"false"
是否对提示词进行上采样。如果启用,提示词会被自动修改,以便进行更具创造性的生成。
integer
默认值:"2"
输入和输出审核的阈值级别,介于 0(最严格)和 6(最宽松)之间。范围:
0 到 6integer
用于可复现性的可选种子。省略时使用随机种子。
string
用于 webhook 签名验证的可选密钥。
string (uri)
接收 webhook 通知的 URL。格式:
uriGET /v2/models/bfl/flux-kontext-pro/openapi.json 提供的 schema 生成,这也是请求到达提供商之前 Router 用于验证调用的同一份文档。输出
number
提供商报告的以积分计的费用,任务变为 Ready 后填充。格式:
floatstring
必填
BFL 任务标识符。
number
BFL 报告的可选生成进度。范围:
0 到 1格式:floatobject
必填
已完成的生成。此处不可为空:该组件的
required 条目承诺 200 会携带结果,而可为空的 result 会将其降格为仅检查键是否存在。number
提供商报告的生成费用。这是 BFL 的数值,而非 Comfy 的收费。格式:
doublenumber
提供商报告的生成时长,以秒为单位。格式:
doublenumber
提供商报告的生成完成时间,为自 Unix 纪元起的秒数。原因与
start_time 相同,使用 double。格式:doublestring
经过任何提示词上采样后,生成实际运行的提示词。
string (uri)
已生成资产的签名 URL。Router 会将资产重新托管到 Comfy 存储上并重写此字段,因此它通常是有效的 Comfy 托管 URL,有效期最长 24 小时:签发时签名为 24 小时,并从 23 小时的缓存中重放,因此稍后的轮询可能返回仅剩一小时有效期的 URL;如果某个叶子节点无法执行重新托管,则会保留 BFL 自己的短期交付 URL,视频约为两小时,图像约为十分钟。无论哪种情况,链接都会过期,因此请下载资产,而不要存储 URL。格式:
uriinteger
生成所使用的种子,无论是由用户提供还是由提供商选择。声明为
int64 是因为 BFL 会返回大于 2^31 的种子(例如 2784347701),而未格式化的 integer 在许多 SDK 生成器中会生成 32 位字段。格式:int64number
提供商报告的生成开始时间,为自 Unix 纪元起的秒数。使用
double 而非 float:在当前的纪元值附近,float32 的间隔约为 128 秒,这会把整次生成的时间跨度压缩为单个解码值。格式:doublestring
必填
任务状态: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 目前不支持的功能,以及替代方案。