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

快速开始

你的 Comfy 工作区中创建密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdknpm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 发起的同一调用。 模型 ID: openai/gpt-image-2 端点: POST https://api.comfy.org/v2/models/openai/gpt-image-2

Schema

输入

string
背景透明度可选值:transparentopaque
string | string[]
要编辑的源图像。存在此字段即选择编辑操作,若要进行文生图,则请完全省略该字段。 可接受单张图像或图像数组;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 载荷大约会膨胀至 4/3,而整个请求体的上限为 10 MiB,因此内联形式的上限约为 7.5 MB 的源图像;使用 URL 则可完全避开这一限制。 该 URL 必须无需你的凭据即可解析。Router 在服务器端获取它,且不会随请求发送任何调用方凭据,因此受支持的形式是 Comfy 签名的资产 URL,即签名位于查询字符串中的 URL。诸如 /api/assets/{id}/content 这类需认证的端点会向 Router 返回 401 而不是图像;请自行请求该 URL,并传入它重定向到的签名 URL。无论是在你发送的 URL 上,还是在每个重定向跳转上,获取都被限制在 Comfy 自己的资产存储桶内,而非开放的互联网,因此第三方 URL 或会重定向的 URL 都会被拒绝。 下面的示例仅展示形式:真实值还带有签名查询参数,此处有意省略,因为已发布的示例会永远留在规范中,而真实的签名既是泄露的凭据,也是一个会失效的链接。 每张图像上限为 25 MiB,单个请求的图像总量上限为 64 MiB。
string
要运行的 gpt-image 模型。Router 会拼接所寻址的模型 id,因此寻址 /v2/models/openai/gpt-image-2 的调用方无需发送该字段。
string
内容审核设置可选值:lowauto
integer
要生成的图像数量(1-10)。范围:110
integer
JPEG 或 WebP 的压缩级别(0-100)范围:0100
string
输出图像的格式可选值:pngwebpjpeg
string
必填
对要生成的图像的文本描述,或对 image 要进行的编辑的文本描述。
string
生成或编辑后图像的质量可选值:lowmediumhighstandardhd
string
图像的尺寸(例如 1024x1024、1536x1024、auto)
string
用于终端用户监控的唯一标识符
由 Router 在 GET /v2/models/openai/gpt-image-2/openapi.json 提供的 schema 生成,这也是它在请求到达提供商之前校验调用时所依据的同一份文档。

输出

object[]
string
Base64 编码的图像数据
string
修订后的提示词
string
图像的 URL
object
integer
object
integer
integer
integer
object
integer
integer
integer
string
生成图像的背景是不透明还是透明。仅在由 fal 提供服务的分支中填充,该分支报告 opaque
integer
生成完成时的 Unix 时间戳(秒)。声明为 int64,因为当前的 epoch 值已接近 2^31,若使用未格式化的 integer,许多 SDK 生成器会生成 32 位字段。格式:int64
string
data[].b64_json 中字节的编码格式(例如 png)。在由 fal 提供服务的分支中填充;在由 OpenAI 提供服务的分支中缺省,此时以调用方请求的 output_format 为准。
string
生成实际运行时所使用的质量档位。在由 fal 提供服务的分支中,若能够解析出该值时填充;否则缺省。
string
生成实际运行时所使用的像素尺寸,格式为 <width>x<height>。在由 fal 提供服务的分支中,若能够解析出该值时填充;否则缺省。

示例

输入

输出

发布前须知

SDK 会生成 Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。 请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入,413 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载,因为结果 URL 会过期 上文任何字段描述中提到的尺寸限制,都是提供商对该字段自身的限定,引自提供商的规范。Router 会对整个请求体另行设置上限,base64 编码的媒体内容也计入其中:参见请求体大小

请求头

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

使用 Router API

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

限制

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