openai/gpt-image-2 の API リファレンスです。OpenAI のモデルを Comfy Router が提供します。
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk)を使用しています。cURL のスニペットは、生の HTTP で同じ呼び出しを行うものです。
モデル ID: openai/gpt-image-2
エンドポイント: POST https://api.comfy.org/v2/models/openai/gpt-image-2
- Wait for the result
- Queue and collect later
スキーマ
入力
string
背景の透明度指定可能な値:
transparent、opaquestring | string[]
編集するソース画像。このフィールドの存在によって編集操作が選択されます。テキストから画像への生成では完全に省略してください。
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 に膨張し、リクエストボディ全体は 10 MiB に制限されているため、インライン形式ではソース画像が約 7.5 MB で上限に達します。URL ならこれを完全に回避できます。
URL は認証情報なしで解決できる必要があります。Router はこれをサーバーサイドで取得し、リクエストに呼び出し元の認証情報を一切付けません。そのため、署名がクエリ文字列に含まれる Comfy 署名済みアセット URL がサポートされる形式です。/api/assets/{id}/content のような認証済みエンドポイントは、画像ではなく 401 を Router に返します。その URL を自分でリクエストし、リダイレクト先の署名済み URL を渡してください。取得はオープンインターネットではなく Comfy 自身のアセットバケットに限定され、送信した URL だけでなくすべてのリダイレクトホップにも適用されるため、サードパーティの URL やリダイレクトする URL は拒否されます。
以下の例は形状のみを示しています。実際の値には署名クエリパラメータも含まれますが、ここでは意図的に省略しています。公開された例は仕様の中に永久に残り、実際の署名は漏洩した認証情報であると同時に、機能しなくなるリンクでもあるからです。
各画像は 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、jpegstring
必須
生成する画像のテキスト記述、または
image に対して行う編集のテキスト記述。string
生成または編集された画像の品質指定可能な値:
low、medium、high、standard、hdstring
画像のサイズ(例: 1024x1024、1536x1024、auto)
string
エンドユーザー監視用の一意の識別子
GET /v2/models/openai/gpt-image-2/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する対象となるドキュメントと同じです。
出力
object[]
string
Base64 エンコードされた画像データ
string
改訂されたプロンプト
string
画像の URL
object
integer
object
integer
integer
integer
object
integer
integer
integer
string
生成された画像の背景が不透明か透明かを示します。fal が処理するブランチでのみ設定され、そこでは
opaque が報告されます。integer
生成が完了した時刻の Unix タイムスタンプ(秒)。
int64 として宣言されています。現在のエポック値は 2^31 に十分近いため、書式なしの integer では多くの SDK ジェネレーターが 32 ビットフィールドを生成してしまうからです。フォーマット: int64string
data[].b64_json 内のバイト列のエンコーディング(例: png)。fal が処理するブランチで設定され、OpenAI が処理するブランチでは存在しません。後者では呼び出し元が要求した output_format が優先されます。string
その生成が実際に実行された品質ティア。fal が処理するブランチで解決できる場合に設定され、それ以外では存在しません。
string
その生成が実際に実行されたピクセル寸法(
<width>x<height> 形式)。fal が処理するブランチで解決できる場合に設定され、それ以外では存在しません。例
入力
出力
出荷前の確認
SDK はIdempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。
リクエストが失敗すると、Router は理由を説明する X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、413 はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。リクエスト本文のサイズ を参照してください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。