Skip to main content
OpenAI から提供され、Comfy Router が配信する openai/gpt-image-2 の API リファレンスです。

クイックスタート

Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python、TypeScript、Swift のスニペットは Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk、および ComfySwiftSDK Swift パッケージ)を使用しています。cURL スニペットは、同じ呼び出しを raw HTTP 経由で行うものです。 モデル ID: openai/gpt-image-2 エンドポイント: POST https://api.comfy.org/v2/models/openai/gpt-image-2

提供プロバイダー

このモデルは、リクエストで別のプロバイダーを指定しない限り、Comfy Router が直接提供します。以下のプロバイダーも同じエンドポイント、同じモデル ID で提供しており、model_provider クエリパラメータで選択します。
  • Comfy(デフォルト): POST https://api.comfy.org/v2/models/openai/gpt-image-2
  • fal(fal/fal-gpt-image-2 として): POST https://api.comfy.org/v2/models/openai/gpt-image-2?model_provider=fal
  • Runware(runware/runware-gpt-image-2 として): POST https://api.comfy.org/v2/models/openai/gpt-image-2?model_provider=runware
strict_mode のデフォルトは false です。そのため Router は、このページに記載されているネイティブのリクエストボディをそのプロバイダー独自のスキーマに変換し、レスポンスを元の形式に翻訳し直します。API リファレンスの model_provider、strict_mode、fallback_provider と、この方法でルーティングされるすべてのモデルについては提供プロバイダーを参照してください。

スキーマ

入力

string
背景の透過指定可能な値: transparent、opaque
string | 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、<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、auto
integer
生成する画像の数(1〜10)。範囲: 1〜10
integer
JPEG または WebP の圧縮レベル(0〜100)範囲: 0〜100
string
出力画像の形式指定可能な値: png、webp、jpeg
string
必須
image に対して生成する画像、または実行する編集のテキスト説明。
string
生成または編集された画像の品質指定可能な値: low、medium、high、standard、hd
string
画像のサイズ(例: 1024x1024、1536x1024、auto)
string
エンドユーザーの監視用の一意の識別子
これは Router が 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
生成された画像の背景が opaque か transparent か。これは OpenAI が今回の生成に対して解決した値です。リクエストパラメータのデフォルトは auto であるため、ピン留めしなかった呼び出し元はここでどちらが生成されたのかを知ることになります。
integer
生成が完了した時刻を示す Unix タイムスタンプ(秒)。これは OpenAI が画像生成レスポンスで REQUIRED と宣言している唯一のメンバーであるため、OpenAI が生成元である場合は常に存在します。fal が提供する openai/gpt-image-2 のレスポンスでは、他の 4 つの解決済みパラメータメンバーと同様に完全に省略されます。int64 と宣言されているのは、現在のエポック値が 2^31 に十分近く、フォーマットされていない integer では多くの SDK ジェネレーターが 32 ビットフィールドを生成してしまうためです。フォーマット: int64
string
data[].b64_json 内のバイト列のエンコーディング(png、webp、jpeg のいずれか)。これは OpenAI が実際にエンコードしたフォーマットであり、リクエストで指定されていればその output_format、指定されていなければ png になります。そのためデコーダーは、リクエストからフォーマットを再導出するのではなく、これを基準にできます。
string
生成が実際に実行された品質ティア。OpenAI は low、medium、high、xhigh、max のいずれかを報告します。これはリクエストのエコーではなく、解決済み(RESOLVED)のティアです。リクエスト側の quality はデフォルトで auto になります。
string
生成が実際に実行されたピクセル寸法(<width>x<height> 形式)。これは解決済み(RESOLVED)のサイズです。リクエストの 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 が現在対応していないことと、代替手段。