ComfyPilotComfyPilot
文档 / 开发 / 将 GPT Image 2 与 Comfy Router 配合使用

将 GPT Image 2 与 Comfy Router 配合使用

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

开发 code 更新于 2026-10-31

查看官方原文

将 GPT Image 2 与 Comfy Router 配合使用

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

openai/gpt-image-2 的 API 参考，该模型由 OpenAI 提供，并通过 Comfy Router 服务。

输入： 文本, 图像 · 输出： 图像

快速开始

在你的 Comfy 工作区中创建一个密钥，并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK（pip install comfy-sdk 和 npm install @comfyorg/sdk）；cURL 代码片段则是通过原始 HTTP 发起的同一调用。

模型 ID： openai/gpt-image-2

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

[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", { "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", { 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 \ -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/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", { "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-2", { 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() 返回的结果相同。失败或已取消的请求会在此处 reject。 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/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/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/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
  • fal，以 fal/fal-gpt-image-2 的形式：POST https://api.comfy.org/v2/models/openai/gpt-image-2?model_provider=fal
  • Pika，以 pika/pika-gpt-image-2 的形式：POST https://api.comfy.org/v2/models/openai/gpt-image-2?model_provider=pika
  • Runware，以 runware/runware-gpt-image-2 的形式：POST https://api.comfy.org/v2/models/openai/gpt-image-2?model_provider=runware
  • WaveSpeed，以 wavespeed/wavespeed-gpt-image-2 的形式：POST https://api.comfy.org/v2/models/openai/gpt-image-2?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"}。其中的 payload 是一个完整的 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 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。唯一的例外是 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/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 在图像生成响应中声明的唯一 REQUIRED 成员，因此只要由 OpenAI 作为生产者，它就一定存在；而在任何 alt 后端的 id 上由 fal、pika、wavespeed 或 runware 提供的响应会完全省略它，就像其他四个已解析参数成员一样。声明为 int64，是因为当前的 epoch 值已接近 2^31，在许多 SDK 生成器中，未格式化的 integer 会生成 32 位字段。

Format: 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 目前不支持的功能，以及替代方案。