Skip to main content
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,以及 服务提供商,了解所有以这种方式路由的模型。

架构

输入

string
背景透明度。auto 由模型自行选择。可选值:transparent、opaque、auto
string | 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 会在派发前依据此架构强制执行该限制。
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、<id>.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 端点)。这些特指对象存储端点:同一提供商域名上的常规端点,例如阿里云函数计算的触发器,不在列表中,会被拒绝。 下面的示例仅展示形状:真实的值还会携带签名查询参数,此处有意省略,因为已发布的示例会永久留在规范中,而真实签名既是泄露的凭据,也是一个会失效的链接。 每张图像上限为 25 MiB,单个请求的图像总量上限为 64 MiB。
string
要运行的 gpt-image 模型。Router 会将所寻址的模型 id 拼接进去,因此寻址 /v2/models/openai/gpt-image-2 的调用方无需发送此字段。
string
内容审核设置可选值:low、auto
integer
要生成的图像数量(1-10)。范围:1 至 10
integer
JPEG 或 WebP 的压缩级别(0-100)范围:0 至 100
string
输出图像的格式可选值:png、webp、jpeg
integer
仅适用于 gpt-image。流式输出期间要发出的部分图像数量(0-3)。仅在配合 stream: true 时才有意义。范围:0 至 3
string
必填
要生成的图像的文本描述,或要对 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、hd
string
图像尺寸(例如 1024x1024、1536x1024、auto)
boolean
仅适用于 gpt-image。在图像生成过程中流式返回部分图像。OpenAI 拒绝将 stream: true 与大于 1 的 n 组合使用。
string
用于终端用户监控的唯一标识符
根据 Router 在 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 生成就一定会出现;由 fal 或 wavespeed 提供的 openai/gpt-image-2 响应则会完全省略它,与其他四个已解析参数成员一样。声明为 int64,因为当今的 epoch 值已接近 2^31,未指定格式的 integer 在许多 SDK 生成器中会生成 32 位字段。格式:int64
string
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 目前不支持的功能,以及替代方案。