openai/gpt-image-1 の 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
エンドポイント: POST https://api.comfy.org/v2/models/openai/gpt-image-1
- 結果を待つ
- 後でキューに入れて収集する
同じボディを
POST https://api.comfy.org/v2/models/openai/gpt-image-1/requests に送信します。Router は実行が受け付けられるとすぐに request_id とともに 201 を返し、結果は準備ができ次第、このプロセスまたは別のプロセスから収集されます。キューの配信では、ステータス、キャンセル、収集について説明します。スキーマ
入力
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 のような認証済みエンドポイントは Router に画像ではなく 401 を返します。その 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、path-style または <bucket>. プレフィックス形式のいずれか)、Azure Blob Storage(<account>.blob.core.windows.net)、Alibaba Cloud OSS(oss-accelerate エンドポイントを含む <bucket>.oss-<region>.aliyuncs.com)。これらは特にオブジェクトストレージのエンドポイントです。同じプロバイダードメイン上の汎用エンドポイント、たとえば 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/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 つの解決済みパラメータのメンバーと同様に完全に省略されます。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 が現在対応していないことと、代替手段。