> ## Documentation Index
> Fetch the complete documentation index at: https://comfyuiwiki.com/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>

## 模式

### 输入

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

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

<ParamField body="image" type="string | string[]">
  要编辑的来源图像。存在此字段即表示选择了编辑操作，若要进行文生图生成，请完全省略该字段。
  模型公开的示例是生成调用，它省略了此字段。添加 `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 会在分发前依据此模式强制执行该限制。
</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`、`<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="partial_images" type="integer">
  仅 gpt-image。流式传输时发出多少个部分图像（0-3）。仅在配合 `stream: true` 时才有意义。

  范围：`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">
  仅 gpt-image 支持。在图像生成过程中流式返回部分图像。OpenAI 会拒绝 `stream: true` 与大于 1 的 `n` 同时使用。
</ParamField>

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

根据 Router 在 `GET /v2/models/openai/gpt-image-1/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 或 wavespeed 提供的 `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">
  本次生成实际运行的 quality 层级：OpenAI 会报告 `low`、`medium`、`high`、`xhigh` 或 `max` 之一。这是已解析后的层级，而不是对请求的回显，因为请求自身的 `quality` 默认为 `auto`。
</ResponseField>

<ResponseField name="size" type="string">
  本次生成实际运行的像素尺寸，格式为 `<宽度>x<高度>`。这是已解析后的尺寸：请求的 `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>