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[]
編集するソース画像。このフィールドの存在が編集操作を選択します。テキストから画像への生成では完全に省略してください。
モデルが公開している例は生成呼び出しであり、このフィールドを省略しています。
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-1.5/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 が生成元である限り常に存在します。fal や wavespeed が提供する
openai/gpt-image-2 のレスポンスでは、他の 4 つの解決済みパラメータのメンバーと同様に、これは完全に省略されます。int64 として宣言されているのは、現在のエポック値が 2^31 に十分近く、フォーマットされていない 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 が現在対応していないことと、代替手段。