openai/gpt-4o の 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-4o
エンドポイント: POST https://api.comfy.org/v2/models/openai/gpt-4o
- 結果を待つ
- キューに送信して後で収集
同じボディを
POST https://api.comfy.org/v2/models/openai/gpt-4o/requests に送信します。Router は実行が受け付けられ次第 201 と request_id を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得の詳細はキュー配信を参照してください。スキーマ
入力
モデルへのテキスト、画像、ファイル入力であり、応答の生成に使用される。この契約で Router が提供できない唯一のフィールドで、以下の
required にある唯一のエントリでもある。応答のために生成されるトークン数の上限。可視出力トークンと reasoning トークンを含む。reasoning id では、この上限は非表示の reasoning トークンと共有されるため、小さな値だと可視テキストが現れる前に予算全体を消費してしまう。これが、reasoning のスモークケースでは 1024 を送信し、chat のケースでは 16 を送信する理由である。範囲:
1 ~ …OpenAI モデル識別子。Comfy Router ではこのフィールドは任意であり、Router は
{model} パスセグメントからこれを埋める。明示的な null も同じ方法で置き換えられる。パスと一致しない値を送信すると拒否される。REASONING ティア専用。reasoning モデルの設定。例:
{"effort": "medium"}。変更なしで転送される。受け入れられるキーについては OpenAI の reasoning ガイドを参照。chat ティアの id はこれを無視する。送信する呼び出し元が拒否されないように宣言されているが、このサーフェスでは無効である。Router はディスパッチ前にこれを
false に確定する。これは、text/event-stream を中継するのではなくプロバイダー応答をキャプチャするためであり、それをデコードできないので、ストリーミング生成は OpenAI によって課金されるが、誰にもメータリングされない。Comfy のどのサーフェスもストリームを提供しない。v1 の POST /proxy/openai/v1/responses イングレスは stream: true を 400 で拒否し、そのリクエストをアップストリームへ決して転送しない。したがって、どちらのサーフェスでもこのフィールドを省略するか false を送信し、完了した応答を 1 つの JSON ボディとして読むこと。サンプリング温度。CHAT ティア専用:o シリーズの reasoning id(
o1、o1-pro、o3、o4-mini)は OpenAI でこのパラメータを拒否する。Router はそれらに対してこれを拒否しない。2 つのティアが 1 つのスキーマを共有する理由については、このコンポーネントの注記を参照。したがって、これを送信する reasoning 呼び出しには OpenAI 自身のエラーが返る。範囲:0 ~ 2コンテキストがモデルのウィンドウを超える場合の切り捨て戦略。ここでは enum が強制される。上記の 3 つの語彙とは異なり、これらの 2 つの値は OpenAI が文書化している完全な集合であり、増えていないためである。明示的な
null も、その上のフィールドと同じ条件で引き続き受け入れられる。可能な値:auto、disabledトークン使用量のエンベロープ。この契約に存在するのは、v1 オペレーションがリクエストボディでこれを宣言しているためである。OpenAI はこれを RESPONSE で設定するので、呼び出し元が送信する理由はない。
GET /v2/models/openai/gpt-4o/openapi.json で提供するスキーマから生成されたもので、リクエストがプロバイダーに到達する前に呼び出しを検証するのと同じドキュメントである。
出力
モデルのコンテキストの最初の項目として、システム(または開発者)メッセージを挿入します。
previous_response_id と併用する場合、前のレスポンスの instructions は次のレスポンスに引き継がれません。これにより、新しいレスポンスでシステム(または開発者)メッセージを簡単に差し替えられます。レスポンスで生成できるトークン数の上限。可視出力トークンと推論トークンを含みます。
モデルレスポンスに使用する切り捨て戦略。
-
auto: このレスポンスと以前のレスポンスのコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中の入力項目を削除してコンテキストウィンドウに収まるようにレスポンスを切り捨てます。 -
disabled(デフォルト): モデルレスポンスがモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 指定可能な値:auto,disabled
モデルへの前のレスポンスの一意の ID。これを使用して
マルチターンの会話を作成します。会話の状態について詳しく学べます。
o-series モデルのみ推論モデルの
設定オプション。
o-series モデルのみ推論モデルの
推論にかける努力を制約します。
現在サポートされている値は
low、medium、high です。推論の
努力を減らすと、レスポンスが速くなり、レスポンスで推論に使用される
トークンが少なくなる場合があります。指定可能な値: low, medium, high非推奨: 代わりに
summary を使用してください。モデルが実行した推論の要約。これは
デバッグやモデルの推論プロセスの理解に役立ちます。
auto、concise、detailed のいずれかです。指定可能な値: auto, concise, detailedモデルが実行した推論の要約。これは
デバッグやモデルの推論プロセスの理解に役立ちます。
auto、concise、detailed のいずれかです。指定可能な値: auto, concise, detailedモデルが出力する必要がある形式を指定するオブジェクト。
{ "type": "json_schema" } を設定すると Structured Outputs が有効になり、
モデルが指定した JSON schema に一致することが保証されます。詳細は
Structured Outputs ガイドを参照してください。デフォルトの形式は { "type": "text" } で、追加のオプションはありません。gpt-4o およびそれ以降のモデルには推奨されません:{ "type": "json_object" } に設定すると古い JSON モードが有効になり、
モデルが生成するメッセージが有効な JSON であることが保証されます。これを
サポートするモデルでは json_schema の使用が推奨されます。レスポンスを生成する際に、モデルがどのツール(または複数のツール)を
使用するかをどのように選択するか。モデルが呼び出せるツールを指定する方法については、
tools パラメータを参照してください。レスポンスのエラーコード。可能な値:
server_error, rate_limit_exceeded, invalid_prompt, vector_store_timeout, invalid_image, invalid_image_format, invalid_base64_image, invalid_image_url, image_too_large, image_too_small, image_parse_error, image_content_policy_violation, invalid_image_mode, image_file_too_large, unsupported_image_media_type, empty_image_file, failed_to_download_image, image_file_not_foundモデルによって生成されたコンテンツ項目の配列。
output配列内の項目の長さと順序は、モデルの応答によって異なります。output配列の最初の項目にアクセスして、それがモデルによって生成されたコンテンツを含むassistantメッセージであると仮定するのではなく、SDK でサポートされている場合はoutput_textプロパティの使用を検討してください。
output 配列内のすべての output_text 項目からの集約されたテキスト出力を含む、SDK 専用の便利なプロパティ(存在する場合)。
Python SDK と JavaScript SDK でサポートされています。レスポンス生成のステータス。
completed、failed、in_progress、cancelled、queued、または incomplete のいずれか。可能な値: completed, failed, in_progress, cancelled, queued, incompleteキャッシュから取得されたトークン数です。
プロンプトキャッシュの詳細。
例
入力
出力
出荷前の確認
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 が現在対応していないことと、代替手段。