openai/gpt-image-1.5 の 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-1.5
エンドポイント: POST https://api.comfy.org/v2/models/openai/gpt-image-1.5
- 結果を待つ
- キューに送信して後で収集
同じボディを
POST https://api.comfy.org/v2/models/openai/gpt-image-1.5/requests に送信します。Router は実行が受理されるとすぐに 201 と request_id を返し、結果は準備ができた時点で、このプロセスからでも別のプロセスからでも収集できます。キュー配信では、ステータス、キャンセル、収集について説明しています。スキーマ
入力
string
背景の透明度。
auto はモデルに選択させます。指定可能な値: transparent、opaque、autostring | 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 はディスパッチ前にこのスキーマに基づいてそれを強制します。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-1.5/openapi.json で Router が提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に 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、runware が提供する、alt 対応 ID のいずれかのレスポンスでは、他の 4 つの解決済みパラメータのメンバーと同様に、これは完全に省略されます。現代の epoch 値は 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 です。リクエストの 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 が現在対応していないことと、代替手段。