> ## 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 を使用する

> 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、Swift のスニペットは Comfy SDK（`pip install comfy-sdk`、`npm install @comfyorg/sdk`、および [`ComfySwiftSDK`](https://github.com/Comfy-Org/comfy-swift-sdk) Swift パッケージ）を使用しています。cURL スニペットは、同じ呼び出しを raw HTTP 経由で行うものです。

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

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

<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",
              {
                  "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);
      ```

      ```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",
          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 \
        -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/requests` に送信します。Router は実行が受け付けられるとすぐに `request_id` とともに `201` を返し、結果は準備ができた時点で、このプロセスまたは別のプロセスから収集されます。[キューによる配信](/ja/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",
              {
                  "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-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);
      ```

      ```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",
          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 は 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"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## 提供プロバイダー

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

`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">
  背景の透過

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

<ParamField body="image" type="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 はディスパッチ前にこのスキーマに基づいてそれを強制します。
</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 はサーバー側で取得し、リクエストに呼び出し元の認証情報を付けません。そのため、署名がクエリ文字列にあるような署名付き 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`、パス形式または `<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="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-2/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 が画像生成レスポンスで REQUIRED と宣言している唯一のメンバーであるため、OpenAI が生成元である場合は常に存在します。fal が提供する `openai/gpt-image-2` のレスポンスでは、他の 4 つの解決済みパラメータメンバーと同様に完全に省略されます。`int64` と宣言されているのは、現在のエポック値が 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` を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。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>