openai/gpt-image-2.5-flare 的 API 参考,由 Comfy Router 从 OpenAI 提供。
输入: 文本, 图像 · 输出: 图像
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 进行的同一调用。
模型 ID: openai/gpt-image-2.5-flare
端点: POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-flare
- 等待结果
- 排队并稍后收集
相同的请求体,发送到
POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-flare/requests。一旦运行被接纳,Router 就会返回 201 和 request_id,结果就绪后再从当前进程或其他进程收集。队列投递 介绍了状态、取消和收集。服务提供商
除非请求中指定了其他提供商,否则此模型由 Comfy Router 直接提供服务。下列提供商也在同一端点上以相同的模型 ID 提供该模型,可通过model_provider 查询参数进行选择。
- Comfy(默认):
POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-flare - fal,名称为
fal/fal-gpt-image-2.5-flare:POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-flare?model_provider=fal - Runware,名称为
runware/runware-gpt-image-2.5-flare:POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-flare?model_provider=runware - WaveSpeed,名称为
wavespeed/wavespeed-gpt-image-2.5-flare:POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-flare?model_provider=wavespeed
strict_mode 默认为 false,因此 Router 会将本页所述的原始请求体转换为提供商自身的 schema,并将响应转换回来。请参阅 API 参考中的 model_provider、strict_mode 和 fallback_provider,以及服务提供商了解所有以此方式路由的模型。
Schema
输入
string
背景透明度。
auto 表示由模型自行选择。可选值:transparent、opaque、autostring | string[]
要编辑的来源图像。存在此字段即选择编辑操作;若要执行文生图生成,则完全省略此字段。
模型公开的示例是生成调用,其中省略了此字段。添加
image 就是两种模式之间的全部差异(相同的端点、相同的模型 id),只不过编辑提示词描述的是你想要的更改,而不是场景,因此下面的编辑请求体读起来与生成示例不同,尽管结构上新增的只有这一个字段。
它可以完全按所印内容原样复制:{"prompt": "give the rocketship rainbow coloring", "image": ["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="], "size": "1024x1024"}。其中 payload 是一个完整的 1x1 PNG,而不是缩写,并且该请求体在 Router 自身的请求验证测试中被固定为可接受的用例。请替换为你自己图像的字节。
接受一张图像或其数组;gpt-image-1 及后续版本最多接受 16 张,Router 会在分发前根据此 schema 强制执行该限制。string
单张图像,可以是 Router 代调用方抓取的 https URL,也可以是内联携带字节的
data:image/<format>;base64,<payload> URI。接受的图像类型为 png、webp 和 jpeg,该集合在解析时即被强制执行,而不是交由提供商决定:svg、gif、avif 或 tiff 会在此处被拒绝,并指明你发送的那张图像,而不会变成距原因两跳之外的合作伙伴错误。
优先使用 URL 形式。base64 payload 大约会膨胀到 4/3,而整个请求体上限为 100 MiB,因此内联形式对来源图像的上限约为 75 MB;使用 URL 则可完全避开这一点。本描述末尾所述的每张图像与每次请求的媒体上限比请求体上限更严格,因此对于任何实际大小的图像,你首先遇到的会是这些上限。
该 URL 必须在无需你的凭证的情况下可解析。Router 在服务器端抓取它,并且不会随请求发送任何调用方凭证,因此受支持的形式是预签名 URL,即签名位于查询字符串中的 URL。诸如 /api/assets/{id}/content 这样需要认证的端点会向 Router 返回 401 而不是图像;请自行请求该 URL,并传入它重定向到的已签名 URL。
抓取仅限于一组命名的主机,而不是开放的互联网,并且同一份列表会重新应用于每一个重定向跳转以及你发送的 URL,因此在任何其他主机上的 URL,或者会重定向到列表之外的主机,都会在联系任何提供商之前被拒绝。目前该列表仅包含 Comfy 自身的资产交付:Comfy 资产桶下的已签名 storage.googleapis.com URL,也就是 /api/assets/{id}/content 将你重定向到的形式。合作伙伴 CDN 或普通的 https 主机不在此列表中。
有两项放宽正在逐步推出,并且目前默认均为关闭状态。它们位于同一个切换开关之后并一同启用,因此请将以下内容视为即将推出,而不是现在就可以针对其进行开发:在依赖其中任何一项之前请先询问。
第一项是 POST /customers/storage 为你的上传签名写入的桶。在推出到达你的环境之前,来自该端点的上传 URL 会在此处被拒绝,即使该桶是 Comfy 自己的、主机也相同,因此“上传到 Comfy,然后传入该 URL”目前并不可行,可行的形式是 /api/assets/{id}/content 重定向到的已签名 URL。
第二项是按帐户启用,而不是一次性对所有人生效,因为这些主机背后的桶属于你而不是我们:即使上面的开关已打开,未启用第三方入站媒体的帐户仍会被拒绝,并且会以这些措辞告知,而不是告知该主机不受支持。请联系你的 Comfy 对接人以在你的帐户上启用它。它还会接纳以下第三方对象存储主机,这些主机上的桶属于你,Router 对其不作任何所属声明:Cloudflare R2(<account>.r2.cloudflarestorage.com、pub-<hash>.r2.dev)、Amazon S3(s3.amazonaws.com 和 s3.<region>.amazonaws.com,路径样式或带 <bucket>. 前缀的形式均可)、Azure Blob Storage(<account>.blob.core.windows.net)以及阿里云 OSS(<bucket>.oss-<region>.aliyuncs.com,包括 oss-accelerate 端点)。这些具体是对象存储端点:同一提供商域上的通用端点,例如阿里云函数计算触发器,不在列表中,会被拒绝。
匹配的是主机名形式,而不是提供商,因此上面提到某个提供商并不意味着该提供商能发出的每个 URL 都被接受;有三种近似情形值得明确指出,因为调用方完全可能以其中每一种形式到来。R2 自定义域(cdn.example.com)不被接受:Cloudflare 将 pub-<hash>.r2.dev 记录为受速率限制的调试主机名,并建议生产流量改用自定义域,但自定义域的主机名中没有任何内容表明它属于 R2,因此 Router 无法将其与其他任何主机区分开来,只会拒绝它:请对 <account>.r2.cloudflarestorage.com 端点进行预签名,或使用 pub-<hash>.r2.dev 形式。S3 的 IPv6 dualstack 端点(s3.dualstack.<region>.amazonaws.com)同样不被接受,请使用普通的区域端点。Azure Blob 的备用 DNS 区(<account>.z<N>.blob.storage.azure.net)也不被接受,请使用 <account>.blob.core.windows.net。你收到的拒绝信息会指明这些相同的形式,因此你不必来这里阅读它们。
上面的 <account> 和 pub-<hash> 占位符展示的是你通常会传入的形式;它们并不是对深度的限制。匹配针对的是对象存储的域名后缀,因此同一命名空间下更深的名称(a.b.pub-<hash>.r2.dev)同样会被接受。但命名空间本身并不会因此放宽:后缀仍必须是所列出的后缀之一。下面的示例只展示形状:真实的值还会携带签名查询参数,这里有意省略,因为发布出来的示例会永远留在规范中,而真实的签名既是被泄露的凭据,也是一个会失效的链接。每张图像的上限为 25 MiB,单个请求中的图像总量上限为 64 MiB。string
要运行的 gpt-image 模型。Router 会把所寻址的模型 id 拼接进来,因此寻址 /v2/models/openai/gpt-image-2 的调用方不会发送该字段。
string
内容审核设置可能的值:
low、autointeger
要生成的图像数量(1-10)。范围:
1 到 10integer
JPEG 或 WebP 的压缩级别(0-100)范围:
0 到 100string
输出图像的格式可能的值:
png、webp、jpeginteger
仅在配合实时流时才有意义,而本接口无法提供实时流:即使你发送了
stream,它也会被固定为 false。在生成请求中,任何不是 0 或 null 的值都会被以 400 拒绝,无论该请求是否同时发送 stream: true;在携带 image 的请求中,该字段会被丢弃,而不是被转发。请省略该字段。范围:0 到 3string
必填
要生成的图像或要对
image 所做编辑的文本描述。string
已生成或已编辑图像的质量。
xhigh 和 max 是新增 gpt-image-2.5-flare 与 gpt-image-2.5-sunburst 时所针对的两个档位;standard 和 hd 是 dall-e 时代的写法,没有任何已准入的模型会读取它们。可能的值:auto、low、medium、high、xhigh、max、standard、hdstring
图像的尺寸(例如 1024x1024、1536x1024、auto)
boolean
声明该字段是为了让发送它的调用方不被拒绝,但它在接口上是惰性的(INERT):Router 会在分发之前将其固定为
false,因为它捕获的是提供商的响应,而不是转发 text/event-stream(携带 image 的请求则会改为丢弃该字段,因为编辑会在不包含该字段的情况下重新编码)。没有任何 Comfy 接口提供 gpt-image 的部分图像流式传输:v1 的 POST /proxy/openai/images/generations 入口会以 400 拒绝 stream: true,并且绝不会把请求转发到上游,因此请省略该字段,并将已完成的响应作为一个 JSON 主体来读取。由于流从未打开,OpenAI 关于将 stream: true 与大于 1 的 n 组合使用的限制在这里并不适用;n 会按发送时的原样转发。string
用于最终用户监控的唯一标识符
GET /v2/models/openai/gpt-image-2.5-flare/openapi.json 提供的 schema 生成,这也是在请求到达提供商之前它用来校验调用的同一份文档。
输出
object[]
string
Base64 编码的图像数据
string
修订后的提示词
string
图像的 URL
object
integer
object
integer
integer
integer
object
integer
integer
integer
string
已生成图像的背景是
opaque 还是 transparent,即 OpenAI 为本次生成解析出的结果。该请求参数默认为 auto,因此没有将它固定下来的调用方可以在这里得知实际生成的是哪一种。integer
生成完成时的 Unix 时间戳,单位为秒。它是 OpenAI 在图像生成响应中声明为 REQUIRED(必填)的唯一成员,因此只要生产者是 OpenAI 就一定会出现;而在任何 alt 后端的 id 上,由 fal、pika、wavespeed 或 runware 提供的响应会完全省略它,与另外四个已解析参数成员一样。声明为
int64,因为当今的 epoch 值已足够接近 2^31,未格式化的 integer 在许多 SDK 生成器中会生成 32 位字段。格式: int64string
data[].b64_json 中字节的编码格式,可为 png、webp 或 jpeg。它是 OpenAI 实际完成编码所用的格式:发送了请求的 output_format 时即为该值,未发送时为 png,因此解码器可以直接依据它,而不必从请求中重新推导格式。string
本次生成实际运行的质量层级:OpenAI 会报告
low、medium、high、xhigh 或 max 之一。它是已解析(RESOLVED)的层级,而不是对请求的回显,请求自身的 quality 默认为 auto。string
本次生成实际运行的像素尺寸,格式为
<width>x<height>。它是已解析(RESOLVED)的尺寸:请求的 size 默认为 auto 且明确接受 auto,因此这里是唯一会报告实际所用尺寸的地方。示例
输入
输出
发布前须知
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 目前不支持的功能,以及替代方案。