> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-matt-router-pricing-pika-and-guard.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 将 GPT Image 1 与 Comfy Router 配合使用

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

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

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

<Tabs defaultTabIndex={1}>
  <Tab title="等待结果">
    <CodeGroup>
      ```python Python theme={null}
      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)
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // 从环境变量中读取 COMFY_API_KEY。
      // SDK 会自动创建幂等键，并在自动重试时复用它。
      const { data } = await comfy.models.run("openai/gpt-image-1", {
        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-1 \
        -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\"}"
      ```
    </CodeGroup>
  </Tab>

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

    <CodeGroup>
      ```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-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())
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // 从环境变量中读取 COMFY_API_KEY。
      // 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
      const handle = await comfy.models.submit("openai/gpt-image-1", {
        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-1/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-1/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. 收集。返回 200 和模型的原生输出；如果请求仍在运行，则返回 202 和状态正文。
      curl https://api.comfy.org/v2/models/openai/gpt-image-1/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### 输入

<ParamField body="background" type="string">
  背景透明度。`auto` 让模型自行选择。

  可选值：`transparent`、`opaque`、`auto`
</ParamField>

<ParamField body="image" type="string | string[]">
  待编辑的来源图像。该字段的存在即选定编辑操作，若要文生图生成则完全省略它。
  模型公布的示例是 GENERATION 调用，它省略了该字段。添加 `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 强制执行该限制。
</ParamField>

<ParamField body="mask" type="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 双栈端点（`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。
</ParamField>

<ParamField body="model" type="string">
  要运行的 gpt-image 模型。Router 会把所寻址的模型 id 拼接进去，因此寻址 /v2/models/openai/gpt-image-2 的调用方不会发送该字段。
</ParamField>

<ParamField body="moderation" type="string">
  内容审核设置

  可能的值：`low`、`auto`
</ParamField>

<ParamField body="n" type="integer">
  要生成的图像数量（1-10）。

  范围：`1` 到 `10`
</ParamField>

<ParamField body="output_compression" type="integer">
  JPEG 或 WebP 的压缩级别（0-100）

  范围：`0` 到 `100`
</ParamField>

<ParamField body="output_format" type="string">
  输出图像的格式

  可能的值：`png`、`webp`、`jpeg`
</ParamField>

<ParamField body="partial_images" type="integer">
  仅在与实时流配合使用时才有意义，而本接口无法提供实时流：即使你发送 `stream`，它也会被固定为 `false`。在生成请求中，任何不是 `0` 或 `null` 的值都会被以 400 拒绝，无论该请求是否同时发送 `stream: true`；在携带 `image` 的请求中，该字段会被丢弃而不是转发。请省略它。

  范围：`0` 到 `3`
</ParamField>

<ParamField body="prompt" type="string" required>
  对要生成的图像的文字描述，或要对 `image` 所做的编辑的描述。
</ParamField>

<ParamField body="quality" type="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`
</ParamField>

<ParamField body="size" type="string">
  图像的大小（例如 1024x1024、1536x1024、auto）
</ParamField>

<ParamField body="stream" type="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` 会按发送时的原样转发。
</ParamField>

<ParamField body="user" type="string">
  用于最终用户监控的唯一标识符
</ParamField>

由 Router 在 `GET /v2/models/openai/gpt-image-1/openapi.json` 提供的 schema 生成，它与 Router 在请求到达提供商之前用于校验调用的文档是同一份。

### 输出

<ResponseField name="data" type="object[]" />

<ResponseField name="data[].b64_json" type="string">
  Base64 编码的图像数据
</ResponseField>

<ResponseField name="data[].revised_prompt" type="string">
  修订后的提示词
</ResponseField>

<ResponseField name="data[].url" type="string">
  图像的 URL
</ResponseField>

<ResponseField name="usage" type="object" />

<ResponseField name="usage.input_tokens" type="integer" />

<ResponseField name="usage.input_tokens_details" type="object" />

<ResponseField name="usage.input_tokens_details.image_tokens" type="integer" />

<ResponseField name="usage.input_tokens_details.text_tokens" type="integer" />

<ResponseField name="usage.output_tokens" type="integer" />

<ResponseField name="usage.output_tokens_details" type="object" />

<ResponseField name="usage.output_tokens_details.image_tokens" type="integer" />

<ResponseField name="usage.output_tokens_details.text_tokens" type="integer" />

<ResponseField name="usage.total_tokens" type="integer" />

<ResponseField name="background" type="string">
  已生成图像的背景是 `opaque` 还是 `transparent`，即 OpenAI 为本次生成所判定的结果。请求参数默认为 `auto`，因此未将其固定的调用方可以在这里得知实际生成的是哪一种。
</ResponseField>

<ResponseField name="created" type="integer">
  生成完成时的 Unix 时间戳，单位为秒。它是 OpenAI 在图像生成响应中声明为 REQUIRED 的唯一成员，因此只要由 OpenAI 生成就会存在；而在任何由 alt 支持的 id 上，由 fal、pika、wavespeed 或 runware 提供的响应会完全省略它，就像其他四个已解析参数成员一样。之所以声明为 `int64`，是因为当下的 epoch 值已接近 2^31，未格式化的 `integer` 在许多 SDK 生成器中会生成 32 位字段。

  格式：`int64`
</ResponseField>

<ResponseField name="output_format" type="string">
  `data[].b64_json` 中字节的编码：`png`、`webp` 或 `jpeg`。它是 OpenAI 实际编码使用的格式，即发送了请求的 `output_format` 时取该值，未发送时取 `png`，因此解码器可以据此判断，而不必从请求中重新推导格式。
</ResponseField>

<ResponseField name="quality" type="string">
  本次生成实际使用的质量档位：OpenAI 会报告 `low`、`medium`、`high`、`xhigh` 或 `max` 之一。它是已解析的档位，而不是对请求的回显，因为请求自身的 `quality` 默认为 `auto`。
</ResponseField>

<ResponseField name="size" type="string">
  本次生成实际使用的像素尺寸，格式为 `<width>x<height>`。它是已解析的尺寸：请求的 `size` 默认为 `auto` 且明确接受 `auto`，因此这里是唯一报告实际所用尺寸的地方。
</ResponseField>

## 示例

### 输入

```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 会过期](/zh/development/comfy-router/reference#结果资产)。

上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。Router 会对整个请求体另行设置上限，base64 编码的媒体内容也计入其中：参见[请求体大小](/zh/development/comfy-router/limitations)。

本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 `comfy-sdk` / `@comfyorg/sdk` 包还提供第二个客户端，用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图：`Comfy(api_key=...)` / `new Comfy({ apiKey })`，并带有 `client.workflows`、`client.assets` 和 `client.jobs`。请参阅 [Comfy SDKs](/zh/development/api-development/sdks)。

<CardGroup cols={3}>
  <Card title="请求头" icon="list" href="/zh/development/comfy-router/headers">
    身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
  </Card>

  <Card title="使用 Router API" icon="code" href="/zh/development/comfy-router/api">
    模型发现、验证错误、重试与计费。
  </Card>

  <Card title="限制" icon="triangle-exclamation" href="/zh/development/comfy-router/limitations">
    Router 目前不支持的功能，以及替代方案。
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.