openai/gpt-image-2.5-flare の API リファレンス。OpenAI から Comfy Router が提供しています。
クイックスタート
あなたの Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk と npm install @comfyorg/sdk)を使用します。cURL のスニペットは、同じ呼び出しを raw HTTP 経由で行うものです。
モデル ID: openai/gpt-image-2.5-flare
エンドポイント: POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-flare
- 結果を待つ
- キューに送信して後で収集する
同じボディを
POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-flare/requests に送信します。Router は実行が受け付けられるとすぐに 201 と request_id を返し、結果は準備ができ次第、このプロセスからでも別のプロセスからでも収集できます。キューの配信では、ステータス、キャンセル、収集について説明しています。提供プロバイダー
このモデルは、リクエストで別のプロバイダーを指定しない限り、Comfy Router が直接提供します。以下のプロバイダーも、同じエンドポイント、同じモデル ID でこのモデルを提供しており、model_provider クエリパラメータで選択します。
- Comfy(デフォルト):
POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-flare - fal、
fal/fal-gpt-image-2.5-flareとして:POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-flare?model_provider=fal - Runware、
runware/runware-gpt-image-2.5-flareとして:POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-flare?model_provider=runware - WaveSpeed、
wavespeed/wavespeed-gpt-image-2.5-flareとして:POST https://api.comfy.org/v2/models/openai/gpt-image-2.5-flare?model_provider=wavespeed
strict_mode のデフォルトは false であるため、Router はこのページに記載されているネイティブなリクエストボディをプロバイダー独自のスキーマに変換し、レスポンスを元の形式に変換し直します。API リファレンスの model_provider、strict_mode、fallback_provider を参照し、この方法でルーティングされるすべてのモデルについては提供プロバイダーを参照してください。
スキーマ
入力
string
背景の透明度。
auto はモデルに選択させます。指定可能な値: transparent, opaque, autostring | 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 はディスパッチ前にこのスキーマに基づいてそれを強制します。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, 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 に制限されています。string
実行する gpt-image モデル。Router がアドレス指定されたモデル ID を挿入するため、/v2/models/openai/gpt-image-2 をアドレス指定する呼び出し元はこれを送信しません。
string
コンテンツモデレーションの設定指定可能な値:
low, autointeger
生成する画像の数 (1-10)。範囲:
1 から 10integer
JPEG または WebP の圧縮レベル (0-100)範囲:
0 から 100string
出力画像の形式指定可能な値:
png, webp, jpeginteger
ライブストリームと併用する場合にのみ意味を持ちますが、このサーフェスはそれを提供できません。送信しても
stream は false に確定されます。生成では、0 または null 以外の値は、リクエストが stream: true も送信するかどうかに関わらず 400 で拒否されます。image を含むリクエストではこのフィールドは転送されず破棄されます。省略してください。範囲: 0 から 3string
必須
生成する画像、または
image に対して行う編集の内容を説明するテキスト。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, hdstring
画像のサイズ(例: 1024x1024、1536x1024、auto)
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 は送信されたまま転送されます。string
エンドユーザーの監視用の一意の識別子
GET /v2/models/openai/gpt-image-2.5-flare/openapi.json で提供するスキーマから生成されたもので、リクエストがプロバイダーに到達する前に呼び出しを検証する対象となるドキュメントと同じものです。
出力
object[]
string
Base64 でエンコードされた画像データ
string
修正されたプロンプト
string
画像の URL
object
integer
object
integer
integer
integer
object
integer
integer
integer
string
生成された画像の背景が
opaque か transparent か。OpenAI がこの生成に対して解決した値です。リクエストパラメータのデフォルトは auto なので、値を指定しなかった呼び出し元はここでどちらが生成されたかを知ることができます。integer
生成が完了した時刻の Unix タイムスタンプ(秒)。OpenAI が画像生成レスポンスで必須(REQUIRED)として宣言している唯一のメンバーであるため、OpenAI が生成元である場合は常に存在します。alt ベースの ID で fal、wavespeed、runware が処理したレスポンスでは、他の 4 つの解決済みパラメータのメンバーと同様に完全に省略されます。現在のエポック値は 2^31 に十分近いため
int64 として宣言されています。整形されていない integer では、多くの SDK ジェネレータが 32 ビットのフィールドを生成してしまうためです。形式: int64string
data[].b64_json 内のバイト列のエンコーディング(png、webp、jpeg のいずれか)。OpenAI が実際にエンコードした形式であり、リクエストで output_format が送信されていればその値、送信されていなければ png になります。そのためデコーダは、リクエストから形式を再導出するのではなく、この値をもとに判別できます。string
生成が実際に実行された品質ティア。OpenAI は
low、medium、high、xhigh、max のいずれかを報告します。これはリクエストのエコーではなく、解決済みのティアです。リクエスト側の quality のデフォルトは auto です。string
生成が実際に実行されたピクセル寸法(
<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 が現在対応していないことと、代替手段。