> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-chore-mintlify-theme-mint.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

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

> 通过 Comfy Router 调用 openai/gpt-image-2：端点、请求结构，以及 Router 返回的响应。

`openai/gpt-image-2` 的 API 参考，该模型由 OpenAI 提供，并通过 Comfy Router 服务。

## 快速开始

在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥，并将其导出为 `COMFY_API_KEY`。Python、TypeScript 和 Swift 代码片段使用 Comfy SDK（`pip install comfy-sdk`、`npm install @comfyorg/sdk`，以及 [`ComfySwiftSDK`](https://github.com/Comfy-Org/comfy-swift-sdk) Swift 包）；cURL 代码片段则是通过原始 HTTP 发起的同一调用。

**模型 ID：** `openai/gpt-image-2`

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

<Tabs>
  <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-2",
              {
                  "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", {
        prompt: "a rocketship on a launchpad",
        quality: "low",
        size: "1024x1024",
      });

      console.log(data);
      ```

      ```swift Swift theme={null}
      import Foundation
      import ComfySwiftSDK

      // 从环境中读取 COMFY_API_KEY。
      // SDK 会在每次调用时生成幂等键，并在自动重试时复用它。
      let client = ComfyCloudClient(apiKey: ProcessInfo.processInfo.environment["COMFY_API_KEY"]!)
      let result = try await client.models.run(
          "openai/gpt-image-2",
          input: [
              "prompt": "a rocketship on a launchpad",
              "quality": "low",
              "size": "1024x1024",
          ]
      )

      print(result.output)
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/openai/gpt-image-2 \
        -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-2/requests`。只要运行被接纳，Router 就会立即返回 `201` 和一个 `request_id`，结果准备就绪后再进行收集，可以由当前进程或另一个进程完成。[排队投递](/zh/development/comfy-router/queue) 会详细讲解状态、取消和收集。

    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # 从环境变量中读取 COMFY_API_KEY。
      # 每次调用 submit() 都会生成自己的 Idempotency-Key，并在自动重试时复用它。
      with Comfy() as client:
          handle = client.models.submit(
              "openai/gpt-image-2",
              {
                  "prompt": "a rocketship on a launchpad",
                  "quality": "low",
                  "size": "1024x1024",
              },
          )
          print("request_id:", handle.request_id)  # 加上模型 ID，就是另一个进程所需的全部信息

          # 轮询直到请求完成，等待服务器指定的 Retry-After。
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # 提供商自己的响应载荷，与 models.run() 返回的值相同。
          # 失败或已取消的请求会在此处抛出带类型的 Router 错误。
          result = handle.get()

      print(result)
      ```

      ```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", {
        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() 返回的结果相同。失败或已取消的请求会在此处 reject。
      const result = await handle.get();

      console.log(result.data);
      ```

      ```swift Swift theme={null}
      import Foundation
      import ComfySwiftSDK

      // 从环境变量中读取 COMFY_API_KEY。
      // 每次调用 submit() 都会生成自己的 Idempotency-Key，并在自动重试时复用它。
      let client = ComfyCloudClient(apiKey: ProcessInfo.processInfo.environment["COMFY_API_KEY"]!)
      let handle = try await client.models.submit(
          "openai/gpt-image-2",
          input: [
              "prompt": "a rocketship on a launchpad",
              "quality": "low",
              "size": "1024x1024",
          ]
      )
      print("requestId:", handle.requestId)  // 加上模型 ID，就是另一个进程所需的全部信息

      // 轮询直到请求完成，等待服务器指定的 Retry-After。
      for try await update in handle.events() {
          print(update.state.rawValue, update.queuePosition.map(String.init) ?? "unknown")
      }

      // 提供商自己的响应载荷，与 models.run() 返回的值相同。
      // 失败或已取消的请求会在此处抛出带类型的 Router 错误。
      let result = try await handle.result()

      print(result.output)
      ```

      ```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/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-2/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/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## 服务提供商

除非请求中指定了其他提供商，否则此模型由 Comfy Router 直接提供服务。以下提供商也在同一端点上、使用相同的模型 ID 提供该模型，通过 `model_provider` 查询参数来选择。

* **Comfy**（默认）：`POST https://api.comfy.org/v2/models/openai/gpt-image-2`
* **fal**，以 `fal/fal-gpt-image-2` 的形式：`POST https://api.comfy.org/v2/models/openai/gpt-image-2?model_provider=fal`
* **Runware**，以 `runware/runware-gpt-image-2` 的形式：`POST https://api.comfy.org/v2/models/openai/gpt-image-2?model_provider=runware`

`strict_mode` 默认为 false，因此 Router 会将本页记录的原生请求体转换为提供商自己的 schema，并把响应转换回来。请参阅 API 参考中的 [`model_provider`、`strict_mode` 和 `fallback_provider`](/zh/development/comfy-router/reference#post-v2modelsprovidermodel)，以及[服务提供商](/zh/development/comfy-router/providers)，了解所有以这种方式路由的模型。

## 架构

### 输入

<ParamField body="background" type="string">
  背景透明度

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

<ParamField body="image" type="string | string[]">
  要编辑的来源图像。此字段的存在即选定编辑操作：纯文生图生成时请完全省略它。
  该模型公布的示例是生成调用，其中省略了此字段。添加 `image` 就是这两种模式之间的全部差异：相同的 endpoint、相同的 model id。区别仅在于编辑提示词描述的是你想要的更改而非场景，因此即便结构上只有此字段是新增的，下面的编辑请求体读起来也与生成示例不同。
  它可以原样复制：`{"prompt": "give the rocketship rainbow coloring", "image": ["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="], "size": "1024x1024"}`。其中的 payload 是一个完整的 1x1 PNG，而非缩写形式，并且此请求体在 Router 自身的请求验证测试中已顶固为可接受用例。请替换为你自己图像的字节。
  接受单张图像或其数组；gpt-image-1 及更高版本最多接受 16 张，Router 会在分发前依据此架构强制执行该限制。
</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` 这类需要认证的 endpoint 会向 Router 返回 401 而非图像；请自行请求该 URL，并传入它重定向到的已签名 URL。
  获取操作被限定在一组具名主机内，而非开放互联网，并且同一份列表既应用于你发送的 URL，也重新应用于每一次重定向跳转。因此，位于任何其他主机的 URL，或重定向到列表之外主机的 URL，都会在联系任何提供商之前被拒绝。目前该列表仅包含 Comfy 自身的资产分发：Comfy 资产桶下已签名的 `storage.googleapis.com` URL，也就是 `/api/assets/{id}/content` 重定向指向的形式。合作伙伴 CDN 或普通 https 主机不在列表中。
  两项放宽措施正在逐步推出，且目前均默认关闭。它们由同一个切换开关控制并一同启用，因此请将以下所有内容视为即将推出，而非现在就可以依赖的功能：在依赖其中任何一项之前请先咨询。
  第一项是 `POST /customers/storage` 为你的上传签名的目标存储桶。在推广覆盖到你的环境之前，来自该 endpoint 的上传 URL 会在此处被拒绝，即便该桶属于 Comfy 自身且主机相同。因此“先上传到 Comfy，再传入 URL”目前不可行，可行的形式是 `/api/assets/{id}/content` 重定向到的已签名 URL。
  第二项按账户启用，而非面向所有人一次性开启，因为这些主机背后的存储桶属于你而非我们：即便上述开关已打开，未启用第三方入站媒体的账户仍会被拒绝，并且收到的提示就是这句话，而不是被告知该主机不受支持。请联系你的 Comfy 对接人为你的账户启用它。它还会额外接纳以下第三方对象存储主机，这些主机上的存储桶属于你，Router 不对其主张任何所有权：Cloudflare R2（`<account>.r2.cloudflarestorage.com`、`<id>.r2.dev`）、Amazon S3（`s3.amazonaws.com` 与 `s3.<region>.amazonaws.com`，路径式或 `<bucket>.` 前缀式均可）、Azure Blob Storage（`<account>.blob.core.windows.net`）以及 Alibaba Cloud OSS（`<bucket>.oss-<region>.aliyuncs.com`，包括 `oss-accelerate` endpoint）。这些特指对象存储 endpoint：同一提供商域名下的通用 endpoint（例如阿里云函数计算的触发器）不在列表中，会被拒绝。下面的示例仅展示形状：真实值还会携带签名查询参数，这里有意省略，因为公布的示例会永久留在 spec 中，而真实签名既是泄露的凭据，也是一条会失效的链接。
  每张图像上限为 25 MiB，单个请求的图像总量上限为 64 MiB。
</ParamField>

<ParamField body="model" type="string">
  要运行的 gpt-image 模型。Router 会拼接所寻址的 model 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="prompt" type="string" required>
  要生成的图像，或要对 `image` 所做的编辑的文本描述。
</ParamField>

<ParamField body="quality" type="string">
  已生成或已编辑图像的质量

  可选值：`low`、`medium`、`high`、`standard`、`hd`
</ParamField>

<ParamField body="size" type="string">
  图像尺寸（例如 1024x1024、1536x1024、自动）
</ParamField>

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

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

### 输出

<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 在图像生成响应上声明为必填的唯一成员,因此只要生产者是 OpenAI,它就会出现;由 fal 提供的 `openai/gpt-image-2` 响应则完全省略它,与其他四个已解析参数成员一样。声明为 `int64` 是因为当前时代的 epoch 值已足够接近 2^31,以致在许多 SDK 生成器中,未指定格式的 `integer` 会生成 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,
    "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>