openai/gpt-5.5-pro の 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-5.5-pro
エンドポイント: POST https://api.comfy.org/v2/models/openai/gpt-5.5-pro
- 結果を待つ
- キューに送信して後で取得する
同じボディを
POST https://api.comfy.org/v2/models/openai/gpt-5.5-pro/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 に確定します。Router は text/event-stream を中継するのではなくプロバイダーの応答を取り込むためであり、その 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 はそれらの id に対してこれを拒否しません(2 つのティアが 1 つのスキーマを共有する理由については、このコンポーネントの注記を参照してください)。そのため、これを送信する reasoning 呼び出しには OpenAI 自身のエラーが返されます。範囲: 0 ~ 2コンテキストがモデルのウィンドウを超えたときの切り捨て戦略。上記の 3 つの語彙とは異なり、ここでは enum が適用されます。これらの 2 つの値が OpenAI の文書化する完全な集合であり、それが増えていないためです。明示的な
null は、上記のフィールドと同じ条件で引き続き受け付けられます。使用可能な値: auto, disabledトークン使用量のエンベロープ。この契約に存在するのは、v1 オペレーションがリクエストボディでそれを宣言しているためです。OpenAI はこれを RESPONSE に設定するため、呼び出し元が送信する理由はありません。
GET /v2/models/openai/gpt-5.5-pro/openapi.json で提供するスキーマから生成されたもので、リクエストがプロバイダーに到達する前に Router が呼び出しを検証するのと同じドキュメントです。
出力
モデルのコンテキストの最初の項目として、system(または developer)メッセージを挿入します。
previous_response_id と併用する場合、前のレスポンスの instructions は次のレスポンスに引き継がれません。これにより、新しいレスポンスで system(または developer)メッセージを簡単に差し替えられます。1 つのレスポンスで生成できるトークン数の上限。可視出力トークンと reasoning トークンを含みます。
モデルレスポンスに使用する切り詰め戦略。
-
auto: このレスポンスと以前のレスポンスのコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中にある入力項目を削除してコンテキストウィンドウに収まるようにレスポンスを切り詰めます。 -
disabled(デフォルト): モデルレスポンスがモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 指定可能な値:auto,disabled
モデルへの前のレスポンスの一意の ID。これを使用して、マルチターンの会話を作成します。会話状態の詳細を学ぶ。
o シリーズモデルのみreasoning モデルの設定オプション。
o シリーズモデルのみreasoning モデルの reasoning にかける労力を制約します。現在サポートされている値は
low、medium、high です。reasoning の労力を減らすと、レスポンスが速くなり、1 つのレスポンスで reasoning に使用されるトークンが少なくなる場合があります。指定可能な値: low, medium, high非推奨: 代わりに
summary を使用してください。モデルが実行した reasoning の要約。これは、デバッグやモデルの reasoning プロセスの理解に役立ちます。auto、concise、detailed のいずれかです。指定可能な値: auto, concise, detailedモデルが実行した reasoning の要約。これは、デバッグやモデルの reasoning プロセスの理解に役立ちます。
auto、concise、detailed のいずれかです。指定可能な値: auto, concise, detailedモデルが出力しなければならない形式を指定するオブジェクト。
{ "type": "json_schema" } を設定すると Structured Outputs が有効になり、モデルが指定した JSON スキーマに一致することが保証されます。詳細は 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 および 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 が現在対応していないことと、代替手段。