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、<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 が上限です。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
gpt-image のみ。ストリーミング中に出力する部分画像の数(0〜3)。
stream: true と併用する場合にのみ意味があります。範囲: 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
gpt-image のみ。生成され次第、部分的な画像をストリーミングで返します。OpenAI は
stream: true と 1 より大きい n の組み合わせを拒否します。string
エンドユーザー監視のための一意の識別子
GET /v2/models/openai/gpt-image-2.5-flare/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用するのと同じドキュメントです。
出力
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 が生成元である場合は常に存在します。fal または wavespeed が提供する
openai/gpt-image-2 のレスポンスでは、他の 4 つの解決済みパラメータメンバーと同様に、これは完全に省略されます。現在のエポック値は 2^31 に十分近いため、書式を指定しない integer は多くの SDK ジェネレーターで 32 ビットフィールドを生成してしまいます。そのため int64 として宣言されています。形式: 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 が現在対応していないことと、代替手段。