> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-claude-comfy-concurrency-limits-page-s84u33.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

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

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

`openai/gpt-image-1` の API リファレンス。OpenAI から 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-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 は実行が受け付けられるとすぐに `request_id` とともに `201` を返し、結果は準備ができ次第、このプロセスまたは別のプロセスから収集されます。[キューの配信](/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-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() が返すのと同じ結果です。失敗またはキャンセルされたリクエストはここで 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-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` を追加することが 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（presigned 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`、パス形式または `<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` エンドポイントに署名するか、`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 に制限されます。
</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">
  ライブストリームと併用する場合にのみ意味を持ちますが、このサーフェスはそれを提供できません。送信しても `stream` は `false` に確定されます。生成では、`0` または `null` 以外の値は、リクエストが `stream: true` も送信するかどうかに関わらず 400 で拒否されます。`image` を含むリクエストではこのフィールドは転送されず破棄されます。省略してください。

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

<ParamField body="user" type="string">
  エンドユーザーの監視用の一意の識別子
</ParamField>

`GET /v2/models/openai/gpt-image-1/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 が生成元である場合は必ず存在します。alt ベースの id で fal、wavespeed、runware が処理したレスポンスでは、他の 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` のいずれかを報告します。これは解決済みのティアであり、リクエストのエコーではありません。リクエスト自体の `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,
    "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 の有効期限](/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>


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