openai/gpt-image-2.5-sunburst 的 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-sunburst
端点: POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst
- 等待结果
- 加入队列并稍后收集
相同的请求体,发送到
POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst/requests。运行一旦被接纳,Router 就会立即返回 201 和一个 request_id;结果就绪后即可收集,无论是由当前进程还是另一个进程。排队交付 详细介绍了状态、取消和收集。服务提供商
除非请求中指定了其他提供商,否则此模型由 Comfy Router 直接提供服务。下列提供商也在同一端点上、使用相同的模型 ID 为其提供服务,通过model_provider 查询参数进行选择。
- Comfy(默认):
POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst - fal,名称为
fal/fal-gpt-image-2.5-sunburst:POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst?model_provider=fal - Runware,名称为
runware/runware-gpt-image-2.5-sunburst:POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst?model_provider=runware - WaveSpeed,名称为
wavespeed/wavespeed-gpt-image-2.5-sunburst:POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst?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,或重定向到列表之外主机的 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
声明该字段是为了让发送它的调用方不被拒绝,但它在本接口上是无效的:Router 会在派发前将其固定为
false,因为 Router 捕获提供商的响应,而不是转发 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-sunburst/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 在图像生成响应中声明为必填的唯一成员,因此只要生成方是 OpenAI,该字段就一定存在;而在任何由 alt 后端支持的 id 上,由 fal、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 之一。它是已解析的档位,而不是对请求的回显,因为请求自身的 quality 默认为 auto。string
本次生成实际使用的像素尺寸,格式为
<width>x<height>。它是已解析的尺寸:请求中的 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 目前不支持的功能,以及替代方案。