将 GPT Image 1 与 Comfy Router 配合使用

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

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

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

等待结果

Python

from comfy_sdk import Comfy

# 从环境变量中读取 COMFY_API_KEY。
# SDK 会自动创建幂等键，并在自动重试时复用它。
with Comfy() as client:
    result = client.models.run(
        "openai/gpt-image-1",
        {
            "prompt": "a rocketship on a launchpad",
            "quality": "low",
            "size": "1024x1024",
        },
    )

print(result)

排队，稍后收集

将同样的请求体发送到 POST https://api.comfy.org/v2/models/openai/gpt-image-1/requests。只要运行被接纳，Router 就会立即返回 201 和一个 request_id，结果在就绪后再收集，可以由当前进程或另一个进程完成。排队投递 详细介绍了状态、取消和收集。

Python

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",
            {
                "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())

​

Schema

​

输入

background · string

背景透明度。auto 让模型自行选择。

可选值：transparent、opaque、auto

image · string | string[]

要编辑的来源图像。出现此字段即选择了编辑操作：完全省略该字段则进行文生图。 模型发布的示例是生成（GENERATION）调用，它省略了此字段。添加 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）和阿里云 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。

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 · 必填

要生成的图像的文本描述，或要对 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/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 它就会出现；在任何 alt-backed id 上由 fal、wavespeed 或 runware 提供的响应都会完全省略它，与另外四个已解析参数成员一样。声明为 int64，因为当前时代的 epoch 值已接近 2^31，在许多 SDK 生成器中未格式化的 integer 会生成 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。

请求头

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

使用 Router API

模型发现、验证错误、重试与计费。

限制

Router 目前不支持的功能，以及替代方案。