通过 Comfy Router 使用 GPT Image 2.5 Sunburst

通过 Comfy Router 调用 openai/gpt-image-2.5-sunburst：端点、请求结构以及 Router 返回的响应。

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

[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键，并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "openai/gpt-image-2.5-sunburst", { "prompt": "a rocketship on a launchpad", "quality": "low", "size": "1024x1024", }, ) print(result) ` `typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键，并在自动重试时复用它。 const { data } = await comfy.models.run("openai/gpt-image-2.5-sunburst", { prompt: "a rocketship on a launchpad", quality: "low", size: "1024x1024", }); console.log(data); ` `bash cURL theme={null} curl https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"prompt\": \"a rocketship on a launchpad\", \"quality\": \"low\", \"size\": \"1024x1024\"}" ``

[tab] 加入队列并稍后收集相同的请求体，发送到 POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst/requests。运行一旦被接纳，Router 就会立即返回 201 和一个 request_id；结果就绪后即可收集，无论是由当前进程还是另一个进程。排队交付详细介绍了状态、取消和收集。 ``python Python theme={null} import asyncio from comfy_sdk import AsyncComfy # 从环境变量中读取 COMFY_API_KEY。 # 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。 async def main(): async with AsyncComfy() as client: handle = await client.models.submit( "openai/gpt-image-2.5-sunburst", { "prompt": "a rocketship on a launchpad", "quality": "low", "size": "1024x1024", }, ) print("request_id:", handle.request_id) # 加上模型 ID，就是另一个进程所需的全部 # 轮询直到请求完成，等待服务器给出的 Retry-After 时长。 async for update in handle.iter_events(): print(update.status, update.queue_position) # 提供商自身的 payload，与 models.run() 返回的值相同。 # 失败或已取消的请求会在这里抛出带类型的 Router 错误。 result = await handle.get() print(result) asyncio.run(main()) ` `typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。 const handle = await comfy.models.submit("openai/gpt-image-2.5-sunburst", { prompt: "a rocketship on a launchpad", quality: "low", size: "1024x1024", }); console.log("requestId:", handle.requestId); // 加上模型 ID，就是另一个进程所需的全部 // 轮询直到请求完成，等待服务器给出的 Retry-After 时长。 for await (const update of handle.events()) { console.log(update.status, update.queuePosition); } // 与 models.run() 返回的结果相同。失败或已取消的请求会在这里被拒绝。 const result = await handle.get(); console.log(result.data); ` `bash cURL theme={null} # 1. 提交。Router 返回 201，并带上 request_id、status_url、response_url 和 cancel_url。 curl https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"prompt\": \"a rocketship on a launchpad\", \"quality\": \"low\", \"size\": \"1024x1024\"}" # 2. 轮询直到状态为 COMPLETED，每次响应都会给出需要等待的 Retry-After 秒数。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 与模型的原始输出；仍在运行时则返回 202 与状态主体。 curl https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

服务提供商

除非请求中指定了其他提供商，否则此模型由 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

输入

background string

背景透明度。auto 表示由模型自行选择。

可选值：transparent、opaque、auto

image string | string[]

要编辑的来源图像。此字段一旦存在即选择编辑操作：文生图生成请完全省略该字段。模型公布的示例是生成调用，其中省略了该字段。添加 image 就是两种模式之间的全部差异：相同的端点、相同的模型 ID。区别在于编辑提示词描述的是你想要的更改，而不是场景，因此下面的编辑请求体与生成示例读起来不同，尽管在结构上只有这个字段是新增的。它可以按原样复制：{"prompt": "give the rocketship rainbow coloring", "image": ["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="], "size": "1024x1024"}。该载荷是一个完整的 1x1 PNG，并非缩写，并且这个请求体已被固定为 Router 自身请求验证测试中的一个通过用例。请替换为你自己图像的字节。接受一张图像或其数组；gpt-image-1 及更高版本最多接受 16 张，Router 会在分发之前依据此 schema 强制执行该限制。

mask string

一张图像，可以是 Router 代表调用方抓取的 https URL，也可以是内联携带字节的 data:image/<format>;base64,<payload> URI。可接受的图像类型为 png、webp 和 jpeg，该集合在解析阶段强制执行，而不是留给提供商处理：svg、gif、avif 或 tiff 会在此处被拒绝，并指明你发送的图像，而不会在距离原因两个环节之外变成合作伙伴错误。优先使用 URL 形式。base64 载荷会膨胀约 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。唯一例外是 ideogram/ideogram-4-5 Precise Edit（发送 image 的调用），其中 context_window 可用：此时每张图像最高可达 50 MB（50,000,000 字节）和 67,108,864 像素，单个请求的图像总计最高可达 128 MiB。

model string

要运行的 gpt-image 模型。Router 会拼入所寻址的模型 ID，因此调用方寻址 /v2/models/openai/gpt-image-2 时不会发送该字段。

moderation string

内容审核设置

可能的值：low、auto

n integer

要生成的图像数量（1-10）。

范围：1 到 10

output\_compression integer

JPEG 或 WebP 的压缩级别（0-100）

范围：0 到 100

output\_format string

输出图像的格式

可能的值：png、webp、jpeg

partial\_images integer

仅在与实时流配合时才有意义，而此接口无法提供实时流：即使你发送 stream，它也会被置为 false。在生成请求中，任何不是 0 或 null 的值都会被以 400 拒绝，无论请求是否同时发送 stream: true；在携带 image 的请求中，该字段会被丢弃而不是转发。请省略它。

范围：0 到 3

prompt string required

用于描述要生成的图像，或要对 image 进行的编辑的文本。

quality 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

size string

图像尺寸（例如 1024x1024、1536x1024、auto）

stream boolean

声明该字段是为了让发送它的调用方不会被拒绝，但它在当前接口上是无作用的：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 会按原样转发。

user string

用于最终用户监控的唯一标识符

该内容生成自 Router 在 GET /v2/models/openai/gpt-image-2.5-sunburst/openapi.json 提供的 schema，也就是它在请求到达提供商之前用于校验调用的同一份文档。

输出

data object[]

data\[].b64\_json string

Base64 编码的图像数据

data\[].revised\_prompt string

修订后的提示词

data\[].url string

图像的 URL

usage object

usage.input\_tokens integer

usage.input\_tokens\_details object

usage.input\_tokens\_details.image\_tokens integer

usage.input\_tokens\_details.text\_tokens integer

usage.output\_tokens integer

usage.output\_tokens\_details object

usage.output\_tokens\_details.image\_tokens integer

usage.output\_tokens\_details.text\_tokens integer

usage.total\_tokens integer

background string

已生成图像的背景是 opaque 还是 transparent，以 OpenAI 为本次生成解析的结果为准。请求参数默认为 auto，因此未固定该参数的调用方可以在这里得知实际生成的是哪一种。

created integer

生成为已完成状态时的 Unix 时间戳（秒）。它是 OpenAI 在图像生成响应中声明为必填的唯一成员，因此只要生产者是 OpenAI，它就会出现；而在任何基于备用提供方的 id 上，由 fal、pika、wavespeed 或 runware 提供的响应都会完全省略它，与其他四个已解析参数成员一样。声明为 int64 是因为当前纪元的数值已足够接近 2^31，未格式化时 integer 会让许多 SDK 生成器生成 32 位字段。

格式：int64

output\_format string

data[].b64_json 中字节的编码，取值为 png、webp 或 jpeg。它是 OpenAI 实际编码所用的格式：发送了请求的 output_format 时就是该值，未发送时则为 png，因此解码器可以直接依据它，而不必从请求中重新推导格式。

quality string

生成实际运行所用的质量档位，OpenAI 会报告 low、medium、high、xhigh 或 max 之一。它是解析后的档位，而不是对请求的回显，因为请求自身的 quality 默认为 auto。

size string

生成实际运行所用的像素尺寸，格式为 <width>x<height>。它是解析后的尺寸：请求的 size 默认为 auto 且明确接受 auto，因此这里才是实际所用尺寸的唯一报告位置。

示例

输入

{
  "prompt": "a rocketship on a launchpad",
  "quality": "low",
  "size": "1024x1024"
}

输出

{
  "created": 1767225600,
  "data": [
    {
      "b64_json": "PGJhc2U2ND4="
    }
  ],
  "usage": {
    "input_tokens": 12,
    "input_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 12
    },
    "output_tokens": 1056,
    "total_tokens": 1068
  }
}

发布前须知

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。

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

[card] 使用 Router API 模型发现、验证错误、重试与计费。

[card] 限制 Router 目前不支持的功能，以及替代方案。