跳转到主要内容
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
相同的请求体,发送到 POST https://api.comfy.org/v2/models/openai/gpt-image-1.5/requests。只要运行被受理,Router 就会返回 201 和 request_id,结果就绪后即可收集,既可以在本进程中收集,也可以在另一个进程中收集。队列投递 会详细介绍状态、取消和结果收集。

Schema

输入

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 会在派发前依据此 schema 强制执行该限制。
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,也就是签名位于查询字符串中的那种。诸如 /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。
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
仅在配合实时流时才有意义,而本接口无法提供实时流:即使你发送了 stream,它也会被固定为 false。在生成请求中,任何不是 0 或 null 的值都会被以 400 拒绝,无论该请求是否同时发送 stream: true;在携带 image 的请求中,该字段会被丢弃而不是被转发。请省略它。范围: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
声明该字段是为了让发送它的调用方不被拒绝,但它在当前接口上是无效的: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 会按发送的内容原样转发。
string
用于终端用户监测的唯一标识符
由 Router 在 GET /v2/models/openai/gpt-image-1.5/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 在图像生成响应中声明为 REQUIRED 的唯一成员,因此只要由 OpenAI 生成就一定存在;而在任何 alt 后端 id 上由 fal、pika、wavespeed 或 runware 提供的响应会完全省略它,与其他四个已解析参数成员一样。声明为 int64,是因为当前的纪元值已经足够接近 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 目前不支持的功能,以及替代方案。