将 GPT Image 1.5 与 Comfy Router 配合使用

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

openai/gpt-image-1.5 的 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-1.5

端点： POST https://api.comfy.org/v2/models/openai/gpt-image-1.5

[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-1.5", { "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-1.5", { 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-1.5 \ -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-1.5/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-1.5", { "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) # 提供商自己的载荷，与 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-1.5", { 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-1.5/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-1.5/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集结果。返回 200 及模型的原生输出；仍在运行时则返回 202 及状态正文。 curl https://api.comfy.org/v2/models/openai/gpt-image-1.5/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

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，或一个会重定向到列表之外的 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）以及 Alibaba Cloud OSS（<bucket>.oss-<region>.aliyuncs.com，包括 oss-accelerate 端点）。这些具体是对象存储端点：同一提供商域上的通用端点，例如 Alibaba Function Compute 触发器，不在列表中，会被拒绝。匹配的是主机名形式，而不是提供商：因此，上面列出一个提供商并不意味着该提供商可以签发的每个 URL 都会被接受，并且有三种近似但不符合的形式值得直接说明，因为调用方确实可能带着其中每一种形式到来。R2 自定义域名（cdn.example.com）不被接受：Cloudflare 将 pub-<hash>.r2.dev 记录为受速率限制的调试主机名，并改为将生产流量指向自定义域名，但自定义域名的主机名中没有任何信息能将其标识为 R2，因此 Router 无法将其与任何其他主机区分开，会予以拒绝：请对 <account>.r2.cloudflarestorage.com 端点进行预签名，或使用 pub-<hash>.r2.dev 形式。S3 的 IPv6 双栈端点（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，因为 Router 捕获的是提供商响应，而不是中继 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-1.5/openapi.json 处提供的 schema 生成，该文档与 Router 在请求到达提供商之前用于校验调用的文档相同。

输出

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 在图像生成响应中声明为 REQUIRED 的唯一成员，因此只要由 OpenAI 生成，该字段就会出现；对于任何 alt-backed 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 之一。这是 RESOLVED 后的层级，而不是对请求的回显；请求自身的 quality 默认为 auto。

size string

生成实际运行时所使用的像素尺寸，格式为 <width>x<height>。这是 RESOLVED 后的尺寸：请求的 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 目前不支持的功能，以及替代方案。