> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Comfy Router で GPT Image 2 を使用する

> Comfy Router 経由で openai/gpt-image-2 を呼び出す方法: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。

OpenAI から提供され、Comfy Router が配信する `openai/gpt-image-2` の API リファレンスです。

**入力：** テキスト, 画像 · **出力：** 画像

## クイックスタート

[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 スニペットは、同じ呼び出しを raw HTTP 経由で行うものです。

**モデル ID:** `openai/gpt-image-2`

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

> [tab] 結果を待つ
>
> ```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);
> ```
>
> ```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\"}"
> ```

> [tab] キューに送信して後で収集する
>
> 同じボディを `POST https://api.comfy.org/v2/models/openai/gpt-image-2/requests` に送信します。Router は実行が受け付けられるとすぐに `request_id` とともに `201` を返し、結果は準備ができた時点で、このプロセスまたは別のプロセスから収集されます。[キューによる配信](https://docs.comfy.org/ja/development/comfy-router/queue.md)では、ステータス、キャンセル、収集について説明します。
>
> ```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",
>             {
>                 "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", {
>   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 は request_id、status_url、response_url、cancel_url とともに 201 を返します。
> 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"
> ```

## 提供プロバイダー

このモデルは、リクエストで別のプロバイダーを指定しない限り、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`
* **MiniMax**（`minimax/minimax-gpt-image-2` として）: `POST https://api.comfy.org/v2/models/openai/gpt-image-2?model_provider=minimax`
* **Runware**（`runware/runware-gpt-image-2` として）: `POST https://api.comfy.org/v2/models/openai/gpt-image-2?model_provider=runware`
* **WaveSpeed**（`wavespeed/wavespeed-gpt-image-2` として）: `POST https://api.comfy.org/v2/models/openai/gpt-image-2?model_provider=wavespeed`

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

## スキーマ

### 入力

**background** `string`

背景の透明度です。`auto` にするとモデルが選択します。

指定可能な値: `transparent`、`opaque`、`auto`

**image** `string | string[]`

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

**mask** `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 はサーバー側で取得し、リクエストに呼び出し元の認証情報を付けません。そのため、署名がクエリ文字列に含まれる形式、すなわち署名付き URL がサポートされる形式です。`/api/assets/{id}/content` のような認証が必要なエンドポイントは、画像ではなく Router に 401 を返します。その 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`、`pub-<hash>.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 のトリガーはリストに含まれず、拒否されます。
照合されるのはプロバイダーではなくホスト名の形式です。したがって、上でプロバイダーを挙げたからといって、そのプロバイダーが発行できるすべての URL が受け入れられるわけではありません。呼び出し元がこれらのいずれかを使ってしまうのはもっともなことなので、紛らわしい 3 つのケースを明示しておきます。R2 のカスタムドメイン（`cdn.example.com`）は受け入れられません。Cloudflare は `pub-<hash>.r2.dev` をレート制限のあるデバッグ用ホスト名として文書化し、本番トラフィックはカスタムドメインに向けるよう案内していますが、カスタムドメインのホスト名には R2 であることを示す情報がないため、Router は他のホストと区別できず拒否します。`<account>.r2.cloudflarestorage.com` エンドポイントの署名付き URL を生成するか、`pub-<hash>.r2.dev` 形式を使用してください。S3 の IPv6 dualstack エンドポイント（`s3.dualstack.<region>.amazonaws.com`）も受け入れられません。通常のリージョナルエンドポイントを使用してください。Azure Blob の代替 DNS ゾーン（`<account>.z<N>.blob.storage.azure.net`）も同様です。`<account>.blob.core.windows.net` を使用してください。返される拒否メッセージにはこれらの同じ形式が記載されているので、それらを読むためにここに来る必要はありません。
上記の `<account>` と `pub-<hash>` のプレースホルダーは、通常扱う形式を示すものであり、深さの制限ではありません。マッチングはオブジェクトストレージのドメインサフィックスに対して行われるため、同じ名前空間の下にあるより深い名前（`a.b.pub-<hash>.r2.dev`）も受け入れられます。ただし、これによって名前空間自体が広がるわけではありません。サフィックスは依然として一覧に記載されたもののいずれかでなければなりません。

以下の例は形状のみを示しています。実際の値には署名用のクエリパラメータも含まれますが、ここでは意図的に省略しています。公開された例は仕様に永久に残り、実際の署名は漏えいした認証情報であると同時に、機能しなくなるリンクでもあるためです。

各画像は 25 MiB に制限され、1 回のリクエストの画像は合計 64 MiB に制限されます。唯一の例外は ideogram/ideogram-4-5 Precise Edit（`image` を送信する呼び出し）で `context_window` が利用可能な場合です。そこでは各画像は最大 50 MB（50,000,000 バイト）かつ 67,108,864 ピクセルまで、1 回のリクエストの画像は合計 128 MiB まで可能です。

**model** `string`

実行する gpt-image モデル。Router はアドレス指定されたモデル ID を挿入するため、/v2/models/openai/gpt-image-2 をアドレス指定する呼び出し元はこれを送信しません。

**moderation** `string`

コンテンツモデレーション設定

可能な値: `low`、`auto`

**n** `integer`

生成する画像の数（1-10）。

範囲: `1` から `10`

**output\_compression** `integer`

JPEG または WebP の圧縮レベル（0-100）

範囲: `0` から `100`

**output\_format** `string`

出力画像の形式

可能な値: `png`、`webp`、`jpeg`

**partial\_images** `integer`

ライブストリームと併用する場合にのみ意味を持ちますが、このサーフェスでは提供できません。送信した場合でも `stream` は `false` に確定されます。生成時には、リクエストが `stream: true` も送信するかどうかに関係なく、`0` または `null` 以外の値は 400 で拒否されます。`image` を含むリクエストでは、このフィールドは転送されずに破棄されます。省略してください。

範囲: `0` から `3`

**prompt** `string` *required*

生成する画像、または `image` に加える編集についてのテキスト説明。

**quality** `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`

**size** `string`

画像のサイズ（例: 1024x1024、1536x1024、auto）

**stream** `boolean`

送信する呼び出し元が拒否されないように宣言されていますが、このサーフェスでは無効です。Router はディスパッチ前にこれを `false` に確定します。これは、`text/event-stream` を中継するのではなく、プロバイダーの応答をキャプチャするためです（`image` を含むリクエストでは、編集がそれなしで再エンコードされるため、代わりにこのフィールドが破棄されます）。Comfy のどのサーフェスも gpt-image の部分画像ストリーミングを提供しません。v1 の `POST /proxy/openai/images/generations` イングレスは `stream: true` を 400 で拒否し、リクエストをアップストリームに転送することはありません。そのため、このフィールドを省略し、完了した応答を 1 つの JSON ボディとして読み取ってください。ストリームが決して開かれないため、`stream: true` と 1 より大きい `n` の組み合わせに対する OpenAI の制限はここでは適用されません。`n` は送信されたまま転送されます。

**user** `string`

エンドユーザーの監視用の一意の識別子

Router が `GET /v2/models/openai/gpt-image-2/openapi.json` で提供するスキーマから生成されており、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使用されるのと同じドキュメントです。

### 出力

**data** `object[]`

**data\[].b64\_json** `string`

Base64 エンコードされた画像データ

**data\[].revised\_prompt** `string`

修正されたプロンプト

**data\[].url** `string`

画像の URL

**usage** `object`

**usage.input\_tokens** `integer`

**usage.input\_tokens\_details** `object`

**usage.input\_tokens\_details.image\_tokens** `integer`

**usage.input\_tokens\_details.text\_tokens** `integer`

**usage.output\_tokens** `integer`

**usage.output\_tokens\_details** `object`

**usage.output\_tokens\_details.image\_tokens** `integer`

**usage.output\_tokens\_details.text\_tokens** `integer`

**usage.total\_tokens** `integer`

**background** `string`

生成された画像の背景が `opaque` か `transparent` か。これはこの生成に対して OpenAI が解決した値です。リクエストパラメータのデフォルトは `auto` であるため、これをピン留めしなかった呼び出し元は、ここでどちらが生成されたのかを知ることになります。

**created** `integer`

生成が完了した時刻の Unix タイムスタンプ（秒）。これは OpenAI が画像生成レスポンスにおいて REQUIRED（必須）と宣言している唯一のメンバーであるため、OpenAI が生成元である場合は常に存在します。alt 系の id で fal、minimax、wavespeed、runware が提供するレスポンスでは、他の 4 つの解決済みパラメータのメンバーと同様に、これは完全に省略されます。現在のエポック値は 2^31 に十分近いため、書式指定のない `integer` は多くの SDK ジェネレータで 32 ビットフィールドを生成してしまいます。そのため `int64` として宣言されています。

フォーマット: `int64`

**output\_format** `string`

`data[].b64_json` 内のバイト列のエンコーディング。`png`、`webp`、`jpeg` のいずれかです。これは OpenAI が実際にエンコードしたフォーマットであり、リクエストで指定されていればそのリクエストの `output_format`、指定がなければ `png` になります。そのためデコーダは、リクエストからフォーマットを再導出するのではなく、この値をもとに判断できます。

**quality** `string`

生成が実際に実行された品質ティア。OpenAI は `low`、`medium`、`high`、`xhigh`、`max` のいずれかを報告します。これはリクエストの単なる反映ではなく、解決済みのティアです。リクエスト側の `quality` のデフォルトは `auto` です。

**size** `string`

生成が実際に実行されたピクセル寸法を `<width>x<height>` 形式で示します。これは解決済みのサイズです。リクエストの `size` はデフォルトが `auto` であり、`auto` を明示的に受け付けるため、実際に使用された寸法が報告されるのはここだけです。

## 例

### 入力

```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,
    "input_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 12
    },
    "output_tokens": 1056,
    "total_tokens": 1068
  }
}
```

## 出荷前の確認

SDK は `Idempotency-Key` を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。

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

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

このページは、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](https://docs.comfy.org/ja/development/api-development/sdks.md) を参照してください。

> [card] [ヘッダー](https://docs.comfy.org/ja/development/comfy-router/headers.md)
>
> 認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

> [card] [Router API の利用](https://docs.comfy.org/ja/development/comfy-router/api.md)
>
> モデルの検出、バリデーションエラー、リトライ、課金。

> [card] [制限事項](https://docs.comfy.org/ja/development/comfy-router/limitations.md)
>
> Router が現在対応していないことと、代替手段。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.