> ## 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.6 Sunburst を使用する > Comfy Router 経由で openai/gpt-image-2.6-sunburst を呼び出します。エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。 OpenAI の `openai/gpt-image-2.6-sunburst` を Comfy Router が提供する際の 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 のスニペットは、生の HTTP で同じ呼び出しを行うものです。 **モデル ID:** `openai/gpt-image-2.6-sunburst` **エンドポイント:** `POST https://api.comfy.org/v2/models/openai/gpt-image-2.6-sunburst` > [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.6-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.6-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.6-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\"}" > ``` > [tab] キューに送信して後で取得 > > 同じボディを `POST https://api.comfy.org/v2/models/openai/gpt-image-2.6-sunburst/requests` に送信します。Router は実行が受け付けられるとすぐに `201` と `request_id` を返し、結果は準備ができ次第、このプロセスまたは別のプロセスから取得します。[キュー配信](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.6-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.6-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); > ``` > > ```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.6-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="" > curl -i https://api.comfy.org/v2/models/openai/gpt-image-2.6-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.6-sunburst/requests/$REQUEST_ID \ > -H "X-API-Key: $COMFY_API_KEY" > ``` ## スキーマ ### 入力 **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/;base64,` 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 (`.r2.cloudflarestorage.com`、`pub-.r2.dev`)、Amazon S3 (`s3.amazonaws.com` および `s3..amazonaws.com`、パス形式または `.` プレフィックス形式のいずれか)、Azure Blob Storage (`.blob.core.windows.net`)、Alibaba Cloud OSS (`.oss-.aliyuncs.com`、`oss-accelerate` エンドポイントを含む)。これらはオブジェクトストレージのエンドポイントに限られます。同じプロバイダードメイン上の汎用エンドポイント（Alibaba Function Compute のトリガーなど）はリストになく拒否されます。 照合されるのはプロバイダーではなくホスト名の形式です。したがって、上記でプロバイダーを挙げたからといって、そのプロバイダーが発行しうるすべての URL が受け入れられるわけではありません。呼び出し元が合理的にたどり着きうる 3 つの紛らわしい形式を明記します。R2 のカスタムドメイン（`cdn.example.com`）は受け入れられません。Cloudflare は `pub-.r2.dev` をレート制限付きのデバッグ用ホスト名とし、本番トラフィックはカスタムドメインに向けるよう案内していますが、カスタムドメインのホスト名には R2 であることを示す情報がないため、Router は他のホストと区別できず拒否します。`.r2.cloudflarestorage.com` エンドポイントに署名するか、`pub-.r2.dev` 形式を使用してください。S3 の IPv6 dualstack エンドポイント（`s3.dualstack..amazonaws.com`）も受け入れられません。通常のリージョナルエンドポイントを使用してください。Azure Blob の代替 DNS ゾーン（`.z.blob.storage.azure.net`）も同様です。`.blob.core.windows.net` を使用してください。返される拒否メッセージにはこれらの形式が記載されているので、ここに戻って読む必要はありません。 上記の `` と `pub-` プレースホルダーは、通常どのような形式で到達するかを示したものです。これは深さの制限ではありません。マッチングはオブジェクトストレージのドメインサフィックスに対して行われるため、同じ名前空間の下にあるより深い名前（`a.b.pub-.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 の partial-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.6-sunburst/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、pika、wavespeed、runware が提供するレスポンスでは、他の 4 つの解決済みパラメータのメンバーと同様に、これ自体が完全に省略されます。現在のエポック値は 2^31 に十分近いため `int64` と宣言されています。整形されていない `integer` は、多くの SDK ジェネレーターで 32 ビットのフィールドを生成してしまうからです。 形式: `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` 生成が実際に実行されたピクセル寸法（`x` 形式）。これは解決済みのサイズです。リクエストの `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.