openai/gpt-image-2.6-sunburst を Comfy Router が提供する際の API リファレンス。
入力: テキスト、画像 · 出力: 画像
クイックスタート
ご利用の Comfy ワークスペースでキーを作成し、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
- 結果を待つ
- キューに送信して後で取得
同じボディを
POST https://api.comfy.org/v2/models/openai/gpt-image-2.6-sunburst/requests に送信します。Router は実行が受け付けられるとすぐに 201 と request_id を返し、結果は準備ができ次第、このプロセスまたは別のプロセスから取得します。キュー配信では、ステータス、キャンセル、取得について説明します。提供プロバイダー
このモデルは、リクエストで別のプロバイダーを指定しない限り、Comfy Router が直接提供します。以下のプロバイダーも同じエンドポイント、同じモデル ID で提供しており、model_provider クエリパラメータで選択します。
- Comfy(デフォルト):
POST https://api.comfy.org/v2/models/openai/gpt-image-2.6-sunburst - MiniMax(
minimax/minimax-gpt-image-2.6-sunburstとして):POST https://api.comfy.org/v2/models/openai/gpt-image-2.6-sunburst?model_provider=minimax
strict_mode のデフォルトは false です。そのため Router は、このページに記載されているネイティブのリクエストボディをそのプロバイダー独自のスキーマに変換し、レスポンスを元の形式に翻訳し直します。API リファレンスの model_provider、strict_mode、fallback_provider と、この方法でルーティングされるすべてのモデルについては提供プロバイダーを参照してください。
スキーマ
入力
アニメーション GIF のフレーム数(2〜16、OpenAI 自身の範囲)です。
output_format: "gif" の場合にのみ意味を持ち、他の output_format と併用すると拒否されます。GIF リクエストで省略した場合は OpenAI 自身のデフォルトである 9 になります。ただし Comfy は環境ごとにこのフィールドへ追加の上限を設定します(ROUTER_OPENAI_IMAGE_GIF_MAX_FRAMES、このフィールド自体の最大値 16 を超えることはありません)。設定された上限を超える値は拒否され、デフォルトの 9 自体が設定された上限を超える場合は、省略された frame_count が黙って引き下げられるのではなく拒否されます。そのため呼び出し元は、OpenAI のデフォルトより静かに小さいアニメーションを受け取るのではなく、frame_count を明示的に設定するよう告げられます。フレーム数はプリフライト見積もりと 64 MiB の結果上限も制約し、そのどちらもフレーム数に応じてスケールします。範囲: 2 から 16各フレームが表示される時間(ミリ秒、OpenAI 自身の範囲は 20〜2000 で 10 ms 単位に丸められます)。
output_format: "gif" の場合にのみ意味を持ち、他の output_format と併用すると拒否されます。GIF リクエストで省略した場合は OpenAI 自身のデフォルトである 200 になります。範囲: 20 から 2000編集対象のソース画像。このフィールドの有無によって編集操作が選択されます。テキストから画像への生成では完全に省略してください。
モデルが公開している例は 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 はディスパッチ前にこのスキーマに基づいてそれを強制します。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、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 に制限されます。唯一の例外は ideogram/ideogram-4-5 Precise Edit(image を送信する呼び出し)で context_window が利用可能な場合です。その場合、各画像は最大 50 MB(50,000,000 バイト)かつ 67,108,864 ピクセル、1 回のリクエストの画像は合計で最大 128 MiB となります。実行する gpt-image モデル。Router はアドレス指定されたモデル ID を挿入するため、/v2/models/openai/gpt-image-2.6-flare をアドレス指定する呼び出し元はこれを送信しません。
生成する画像の数(1〜10)。GIF リクエスト(
output_format を参照)は 1 以外の値を拒否します。OpenAI 自身の説明では、GIF リクエストの n を「アニメーションの数」と呼んでいますが、Router は v1 ではこの料金を計算しません。範囲: 1 から 10出力画像の形式。
gif はさらに、image(GIF 編集はまだ利用できません)、1 以外の n、512x512 以外の size(省略、auto、不正な形式、1024x1024 のような正常なサイズを含む)、stream: true、0 より大きい partial_images、および output_compression を拒否します(各フィールドの説明を参照してください)。また、Comfy がこの環境で gif を有効にしていない限り一律に拒否されます。image を伴わない GIF 生成での mask は拒否されずに取り除かれます(mask を参照)。可能な値: png、webp、jpeg、gifライブストリームと併用する場合にのみ意味を持ちますが、このサーフェスはライブストリームを提供できません。これは OpenAIImageRouterRequest の場合とまったく同じです(そのフィールドの説明を参照)。GIF リクエストでは 0 より大きい値は拒否されます。理由は
stream: true の場合と同じです。0 は受け入れられます。範囲: 0 から 3生成済みまたは編集済みの画像の品質。
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画像のサイズ(例: 1024x1024、1536x1024、auto)。GIF リクエスト(
output_format を参照)は 512x512 のみを受け入れ、このフィールドの省略、auto、不正な値、および他のすべての正しい形式のサイズ(1024x1024 を含む)を拒否します。明示的な 512x512 のサイズが、フレーム数によって乗算される前に、プリフライト見積もりと 64 MiB の結果上限を有限に保つためです。送信する呼び出し元が拒否されないように宣言されていますが、このサーフェスでは OpenAIImageRouterRequest の場合とまったく同様に無効です(そのフィールドの説明を参照)。GIF リクエストでは
true は拒否されます(OpenAI のガイドでは、GIF 出力はストリーミングをサポートしないと記載されています)。false は受け入れられます。GET /v2/models/openai/gpt-image-2.6-sunburst/openapi.json で提供するスキーマから生成されたもので、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使用するのと同じドキュメントです。
出力
生成された画像の背景が
opaque か transparent か。これは OpenAI がこの生成のために解決した結果です。リクエストパラメータのデフォルトは auto なので、これを指定しなかった呼び出し元は、ここでどちらが生成されたのかを知ることができます。生成が完了したときの Unix タイムスタンプ(秒)。これは OpenAI が画像生成レスポンスで REQUIRED(必須)と宣言している唯一のメンバーであるため、OpenAI が生成元である場合は必ず含まれます。一方、alt ベースの id で fal、minimax、wavespeed、runware が提供するレスポンスでは、他の 4 つの解決済みパラメータのメンバーと同様に、これ自体が完全に省略されます。現在のエポック値は 2^31 に十分近いため
int64 と宣言されています。整形されていない integer は、多くの SDK ジェネレーターで 32 ビットのフィールドを生成してしまうからです。形式: int64data[].b64_json 内のバイト列のエンコーディング(png、webp、jpeg)。これは OpenAI が実際にエンコードした形式であり、リクエストで output_format が送信されていればその値、送信されていなければ png になります。そのためデコーダーは、リクエストから形式を再導出するのではなく、この値に基づいて処理できます。生成が実際に実行された品質ティア。OpenAI は
low、medium、high、xhigh、max のいずれかを報告します。これはリクエストのエコーではなく、解決済みのティアです。リクエスト側の quality のデフォルトは auto です。生成が実際に実行されたピクセル寸法(
<width>x<height> 形式)。これは解決済みのサイズです。リクエストの size はデフォルトが auto で、auto を明示的に許容するため、実際に使用された寸法が報告されるのはここだけです。例
入力
出力
出荷前の確認
SDK はIdempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。
リクエストが失敗すると、Router は理由を説明する X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、413 はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。リクエスト本文のサイズ を参照してください。
このページは、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 を参照してください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。