> ## Documentation Index > Fetch the complete documentation index at: https://docs.comfy.org/llms.txt > Use this file to discover all available pages before exploring further. # 将 GPT Image 2.6 Flare 与 Comfy Router 配合使用 > 通过 Comfy Router 调用 openai/gpt-image-2.6-flare：端点、请求形状以及 Router 返回的响应。 `openai/gpt-image-2.6-flare` 的 API 参考，由 Comfy Router 从 OpenAI 提供。 **输入：** 文本、图像 · **输出：** 图像 ## 快速开始 在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥，并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 片段使用 Comfy SDK（`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`）；cURL 片段则是通过原始 HTTP 发起的相同调用。 **模型 ID：** `openai/gpt-image-2.6-flare` **端点：** `POST https://api.comfy.org/v2/models/openai/gpt-image-2.6-flare` > [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.6-flare", > { > "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.6-flare", { > 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.6-flare \ > -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.6-flare/requests`。运行一旦被接纳，Router 会立即以 `201` 和 `request_id` 应答，结果就绪后即可收集，无论来自当前进程还是其他进程。[队列投递](https://docs.comfy.org/zh/development/comfy-router/queue.md) 详细介绍了状态、取消和收集。 > > ```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.6-flare", > { > "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.6-flare", { > 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-2.6-flare/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="" > curl -i https://api.comfy.org/v2/models/openai/gpt-image-2.6-flare/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.6-flare/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/;base64,` 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（`.r2.cloudflarestorage.com`、`pub-.r2.dev`）、Amazon S3（`s3.amazonaws.com` 和 `s3..amazonaws.com`，采用路径风格或带 `.` 前缀的形式均可）、Azure Blob Storage（`.blob.core.windows.net`）和 Alibaba Cloud OSS（`.oss-.aliyuncs.com`，包括 `oss-accelerate` 端点）。这些具体是对象存储端点：同一提供商域上的常规端点（例如阿里云函数计算触发器）不在列表中，会被拒绝。 匹配的是主机名形式，而不是提供商。因此，上面提到某个提供商并不意味着该提供商能够签发的每个 URL 都会被接受；有三种近似但不匹配的形式值得直接说明，因为调用方有理由可能遇到其中每一种。R2 自定义域名（`cdn.example.com`）不被接受：Cloudflare 将 `pub-.r2.dev` 记录为受速率限制的调试主机名，并将生产流量改为指向自定义域名，但自定义域名的主机名中不包含任何可将其标识为 R2 的内容，因此 Router 无法将其与任何其他主机区分开，并会拒绝它。请对 `.r2.cloudflarestorage.com` 端点进行预签名，或使用 `pub-.r2.dev` 形式。S3 的 IPv6 双栈端点（`s3.dualstack..amazonaws.com`）也不被接受；请使用普通的区域端点。Azure Blob 的备用 DNS 区域（`.z.blob.storage.azure.net`）同样不被接受；请使用 `.blob.core.windows.net`。你收到的拒绝信息会列出这些相同的形式，因此你不必回到这里阅读它们。 上面的 `` 和 `pub-` 占位符展示的是你通常拿到的形式，它们并不是对层级的限制。匹配针对的是对象存储的域名后缀，因此在同一命名空间下更深的名称（`a.b.pub-.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.6-flare/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 后端支持的 id 上，由 fal、pika、wavespeed 或 runware 提供的响应会完全省略它，与其他四个已解析参数成员一样。声明为 `int64` 是因为当前时代的 epoch 值已足够接近 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` 之一。它是已解析的档位，而不是对请求的回显，因为请求自身的 `quality` 默认为 `auto`。 **size** `string` 生成实际运行时使用的像素尺寸，格式为 `x`。它是已解析的尺寸：请求的 `size` 默认为 `auto` 且明确接受 `auto`，因此这里是唯一报告实际使用尺寸的地方。 ## 示例 ### 输入 ```json theme={null} { "prompt": "a rocketship on a launchpad", "quality": "low", "size": "1024x1024" } ``` ### 输出 ```json theme={null} { "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 会过期](https://docs.comfy.org/zh/development/comfy-router/reference.md#结果资产)。 上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。Router 会对整个请求体另行设置上限，base64 编码的媒体内容也计入其中：参见[请求体大小](https://docs.comfy.org/zh/development/comfy-router/limitations.md)。 本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 `comfy-sdk` / `@comfyorg/sdk` 包还提供第二个客户端，用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图：`Comfy(api_key=...)` / `new Comfy({ apiKey })`，并带有 `client.workflows`、`client.assets` 和 `client.jobs`。请参阅 [Comfy SDKs](https://docs.comfy.org/zh/development/api-development/sdks.md)。 > [card] [请求头](https://docs.comfy.org/zh/development/comfy-router/headers.md) > > 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。 > [card] [使用 Router API](https://docs.comfy.org/zh/development/comfy-router/api.md) > > 模型发现、验证错误、重试与计费。 > [card] [限制](https://docs.comfy.org/zh/development/comfy-router/limitations.md) > > Router 目前不支持的功能，以及替代方案。 This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.