> ## 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.

# 通过 Comfy Router 使用 GPT Image 2.5 Sunburst

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

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

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

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

          # 提供商自身的 payload，与 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.5-sunburst", {
        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-2.5-sunburst",
          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")
      }

      // 提供商自身的 payload，与 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.5-sunburst/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.5-sunburst/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. 收集。仍在运行时返回 202 与状态主体，完成后返回 200 与模型的原始输出。
      curl https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### 输入

<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 会在分发前依据此 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 载荷大约会膨胀 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">
  已生成或已编辑图像的质量

  Possible values: `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-2.5-sunburst/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>