> ## Documentation Index
> Fetch the complete documentation index at: https://comfyuiwiki.com/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 が提供する `openai/gpt-image-2.5-sunburst` の API リファレンス。Comfy Router が配信します。

## クイックスタート

[お使いの 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-2.5-sunburst`

**エンドポイント:** `POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst`

<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-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);
      ```

      ```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` を返し、結果は準備ができ次第、このプロセスからでも別のプロセスからでも取得できます。[キュー配信](/ja/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-2.5-sunburst",
                  {
                      "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-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() が返すのと同じ結果です。失敗またはキャンセルされたリクエストは、ここで reject されます。
      const result = await handle.get();

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

      ```bash cURL theme={null}
      # 1. 送信。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。
      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. 取得。200 はモデルのネイティブ出力、実行中はステータスボディとともに 202 を返します。
      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>

## 提供プロバイダー

このモデルは、リクエストで別のプロバイダーを指定しない限り、Comfy Router が直接提供します。以下のプロバイダーも同じエンドポイント、同じモデル ID で提供しており、`model_provider` クエリパラメータで選択します。

* **Comfy**（デフォルト）: `POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst`
* **fal**、`fal/fal-gpt-image-2.5-sunburst` として: `POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst?model_provider=fal`
* **Runware**、`runware/runware-gpt-image-2.5-sunburst` として: `POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst?model_provider=runware`
* **WaveSpeed**、`wavespeed/wavespeed-gpt-image-2.5-sunburst` として: `POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-sunburst?model_provider=wavespeed`

`strict_mode` のデフォルトは false です。そのため Router は、このページで説明されているネイティブのリクエストボディをプロバイダー独自のスキーマに変換し、レスポンスを元の形式に変換して返します。API リファレンスの [`model_provider`、`strict_mode`、`fallback_provider`](/ja/development/comfy-router/reference#post-v2modelsprovidermodel) と、この方法でルーティングされるすべてのモデルについては [提供プロバイダー](/ja/development/comfy-router/providers) を参照してください。

## スキーマ

### 入力

<ParamField body="background" type="string">
  背景の透明性。`auto` はモデルに選択させます。

  指定可能な値: `transparent`、`opaque`、`auto`
</ParamField>

<ParamField body="image" type="string | string[]">
  編集するソース画像。このフィールドの有無が編集操作を選択します。テキストから画像への生成では完全に省略してください。
  モデルが公開している例はこのフィールドを省略した生成呼び出しです。2つのモードの違いは `image` を追加することだけです。エンドポイントもモデル ID も同じですが、編集プロンプトはシーンではなく希望する変更を記述するため、構造的に新しいのがこのフィールドだけであっても、以下の編集用ボディは生成の例とは異なる内容になります。
  記載どおりにそのままコピーできます: `{"prompt": "give the rocketship rainbow coloring", "image": ["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="], "size": "1024x1024"}`。ペイロードは省略形ではなく完全な 1x1 PNG で、このボディは Router 自身のリクエスト検証テストで受け入れられるケースとしてピン留めされています。ご自身の画像のバイト列に置き換えてください。
  1枚の画像、またはその配列を受け付けます。gpt-image-1 以降では最大16枚までで、Router はディスパッチ前にこのスキーマに基づいて強制します。
</ParamField>

<ParamField body="mask" type="string">
  1枚の画像で、Router が呼び出し元に代わって取得する https URL、またはバイト列をインラインで含む `data:image/<format>;base64,<payload>` URI のいずれかの形式です。受け入れられる画像形式は png、webp、jpeg で、このセットはプロバイダーに任されるのではなく解決時に強制されます。svg、gif、avif、tiff はここで拒否され、原因から2ホップ離れたパートナーエラーになる代わりに、送信した画像を名指しして通知されます。
  URL 形式を推奨します。base64 ペイロードは約 4/3 に膨張し、リクエストボディ全体は 100 MiB に制限されるため、インライン形式ではソース画像が約 75 MB で上限に達します。URL ならこれを完全に回避できます。この説明の最後に記載する画像あたりおよびリクエストあたりのメディア上限はボディ上限よりも厳しいため、実際のサイズの画像ではまずこちらに達します。
  URL は認証情報なしで解決できる必要があります。Router はサーバー側で取得し、リクエストに呼び出し元の認証情報を付けません。そのため、署名がクエリ文字列に含まれる presigned URL がサポートされる形式です。`/api/assets/{id}/content` のような認証済みエンドポイントは画像ではなく 401 を Router に返します。その URL はご自身でリクエストし、リダイレクト先の署名付き URL を渡してください。
  フェッチはオープンなインターネットではなく、名前を挙げたホスト群に限定され、同じリストが送信した URL だけでなくすべてのリダイレクトホップにも再適用されます。したがって、それ以外のホストの URL や、リスト外にリダイレクトする URL は、プロバイダーに接触する前に拒否されます。現在このリストは Comfy 自身のアセット配信のみです。つまり Comfy のアセットバケット配下の署名付き `storage.googleapis.com` URL で、これは `/api/assets/{id}/content` がリダイレクトする形式です。パートナー CDN や通常の https ホストはリストに含まれません。
  2つの拡張がロールアウト中で、どちらも現在はデフォルトで無効です。これらは1つの切り替えの背後で提供され、同時に有効になります。したがって以下はすべて近日提供予定のものとして扱い、まだ依存して実装する対象とはしないでください。いずれかに依存する前に確認してください。
  1つ目は `POST /customers/storage` がアップロード先として署名するバケットです。ロールアウトがお使いの環境に到達するまで、そのエンドポイントからのアップロード URL はここで拒否されます。バケットが Comfy 自身のものでホストも同じであってもです。そのため「Comfy にアップロードしてから URL を渡す」はまだ機能せず、機能する形式は `/api/assets/{id}/content` がリダイレクトする署名付き URL です。
  2つ目は全員一斉ではなくアカウント単位で有効化されます。これらのホストの背後にあるバケットが弊社のものではなくお客様のものであるためです。上記の切り替えがオンになっていても、サードパーティの受信メディアが有効化されていないアカウントは拒否され、ホストがサポート外であるとは告げられず、その旨の文言で通知されます。お使いのアカウントで有効化するよう Comfy の担当者にご依頼ください。また、バケットがお客様のもので Router が所有権を主張しない以下のサードパーティのオブジェクトストレージホストを追加で許可します: Cloudflare R2（`<account>.r2.cloudflarestorage.com`、`<id>.r2.dev`）、Amazon S3（`s3.amazonaws.com` および `s3.<region>.amazonaws.com`、path-style 形式または `<bucket>.` を前置する形式のいずれか）、Azure Blob Storage（`<account>.blob.core.windows.net`）、Alibaba Cloud OSS（`<bucket>.oss-<region>.aliyuncs.com`、`oss-accelerate` エンドポイントを含む）。これらは特にオブジェクトストレージのエンドポイントです。同じプロバイダードメイン上の汎用エンドポイント、たとえば Alibaba Function Compute のトリガーはリストに含まれず拒否されます。
  以下の例は形状のみを示しています。実際の値には署名のクエリパラメータも含まれますが、公開された例は仕様に永遠に残り、実際の署名は漏洩した認証情報であると同時に機能しなくなるリンクでもあるため、ここでは意図的に省略しています。
  各画像は 25 MiB、1リクエストの画像は合計 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 のために追加された 2 つのティアです。`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>

`GET /v2/models/openai/gpt-image-2.5-sunburst/openapi.json` で 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 が画像生成レスポンスで必須と宣言している唯一のメンバーであるため、OpenAI が生成元である限り必ず存在します。fal や wavespeed が提供する `openai/gpt-image-2` のレスポンスでは、他の 4 つの解決済みパラメータのメンバーと同様に、これ自体が完全に省略されます。現在のエポック値は 2^31 に十分近いため、フォーマットされていない `integer` は多くの SDK ジェネレータで 32 ビットフィールドを生成してしまいます。そのため `int64` として宣言されています。

  形式: `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` を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。

リクエストが失敗すると、Router は理由を説明する `X-Comfy-Error-Type` レスポンスヘッダーを送信します。`422` は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、`413` はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは [結果 URL の有効期限](/ja/development/comfy-router/reference#結果アセット) があるため、早めにダウンロードしてください。

上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。[リクエスト本文のサイズ](/ja/development/comfy-router/limitations) を参照してください。

このページは、Comfy Router 経由で呼び出す 1 つのパートナーモデルについて説明しています。同じ `comfy-sdk` / `@comfyorg/sdk` パッケージには、Comfy Cloud 上で ComfyUI のワークフローグラフ全体を実行するための 2 つ目のクライアントも含まれています: `Comfy(api_key=...)` / `new Comfy({ apiKey })`、および `client.workflows`、`client.assets`、`client.jobs`。[Comfy SDKs](/ja/development/api-development/sdks) を参照してください。

<CardGroup cols={3}>
  <Card title="ヘッダー" icon="list" href="/ja/development/comfy-router/headers">
    認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
  </Card>

  <Card title="Router API の利用" icon="code" href="/ja/development/comfy-router/api">
    モデルの検出、バリデーションエラー、リトライ、課金。
  </Card>

  <Card title="制限事項" icon="triangle-exclamation" href="/ja/development/comfy-router/limitations">
    Router が現在対応していないことと、代替手段。
  </Card>
</CardGroup>