> ## 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 1.5 与 Comfy Router 配合使用

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

`openai/gpt-image-1.5` 的 API 参考，由 Comfy Router 从 OpenAI 提供。

## 快速开始

在[你的 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-1.5`

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

<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-1.5",
              {
                  "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.5", {
        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-1.5",
          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-1.5 \
        -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.5/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-1.5",
              {
                  "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-1.5", {
        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);
      ```

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

## 架构

### 输入

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

  可能的值：`transparent`、`opaque`
</ParamField>

<ParamField body="image" type="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 会在分发前根据此架构强制执行。
</ParamField>

<ParamField body="mask" type="string">
  一张图像，可以是 Router 代表调用方获取的 https URL，也可以是携带内联字节的 `data:image/<format>;base64,<payload>` 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（`<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`）以及阿里云 OSS（`<bucket>.oss-<region>.aliyuncs.com`，包括 `oss-accelerate` 端点）。这些具体是对象存储端点：同一提供商域上的通用端点，例如阿里云函数计算触发器，不在列表中，会被拒绝。
  下面的示例仅展示形状：真实值还携带签名查询参数，这里故意省略，因为发布的示例会永远留在规范中，而真实签名既是泄露的凭据，也是会失效的链接。
  每张图像上限为 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="prompt" type="string" required>
  要生成的图像或要对 `image` 进行的编辑的文本描述。
</ParamField>

<ParamField body="quality" type="string">
  生成或编辑的图像的质量可选值：`low`、`medium`、`high`、`standard`、`hd`
</ParamField>

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

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

该文档根据 Router 在 `GET /v2/models/openai/gpt-image-1.5/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 在图像生成响应中声明为 REQUIRED（必填）的唯一成员，因此只要由 OpenAI 生成就一定存在；而由 fal 提供的 `openai/gpt-image-2` 响应则会完全省略它，与其余四个已解析参数成员一样。声明为 `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` 之一。它是已解析（RESOLVED）的等级，而不是对请求的回显，因为请求自身的 `quality` 默认为 `auto`。
</ResponseField>

<ResponseField name="size" type="string">
  本次生成实际运行的像素尺寸，格式为 `<width>x<height>`。它是已解析（RESOLVED）的尺寸：请求的 `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>