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
- Wait for the result
- Queue and collect later
スキーマ
入力
string[]
モデルの応答に含める追加の出力データ。
string | object[]
必須
応答を生成するためにモデルへ渡すテキスト、画像、またはファイルの入力。このコントラクトのうち Router が補えない唯一のフィールドであり、下記の
required に含まれる唯一の項目です。string
モデルのコンテキストの先頭項目として、システム(または開発者)メッセージを挿入します。
integer
応答で生成されるトークン数の上限。可視の出力トークンと推論トークンを含みます。推論系の id ではこの上限は隠された推論トークンと共有されるため、小さな値だと可視テキストが一切出る前に予算を使い切ってしまいます。そのため、推論の smoke ケースでは 1024 を送り、チャットのケースでは 16 を送っています。範囲:
1 から …string
OpenAI のモデル識別子。Comfy Router ではこのフィールドは任意(OPTIONAL)で、Router が
{model} パスセグメントから設定します。明示的な null も同じ方法で置き換えられます。パスと矛盾する値を送信すると拒否されます。boolean
モデルがツール呼び出しを並列で実行できるようにするかどうか。
string
マルチターン会話で使用する、以前の応答の ID。
object
推論ティア専用。推論モデル向けの設定。例:
{"effort": "medium"}。そのまま転送されます。受け付けられるキーについては OpenAI の推論ガイドを参照してください。チャットティアの id では無視されます。boolean
OpenAI が生成した応答を後で取得できるように保存するかどうか。
boolean
これを送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは無効(INERT)です: Router はディスパッチ前にこれを
false に確定します。Router は text/event-stream を中継するのではなくプロバイダーの応答をキャプチャするため、openAiResponsesProxy の ModifyResponse はこれをデコードできません。その結果、ストリーミング生成は OpenAI に課金されても誰にも計測されません。ストリームが必要な場合は POST /proxy/openai/v1/responses を使用してください。number
サンプリング温度。チャットティア専用: o シリーズの推論 id(
o1、o1-pro、o3、o4-mini)では、OpenAI がこのパラメータを拒否します。Router はそれらに対してこの値を拒否しません(2 つのティアが 1 つのスキーマを共有する理由については、このコンポーネントの注記を参照してください)。そのため、これを送る推論呼び出しには OpenAI 自身のエラーが返されます。範囲: 0 から 2object
出力フォーマットの設定。たとえば Structured Outputs では
{"format": {"type": "json_schema", ...}}。そのまま転送されます。string | object
モデルが使用するツールをどのように選択すべきか。文字列のモードか、ツールを指定するオブジェクトのいずれかです。
object[]
モデルが呼び出せるツール定義。Router はツールの分類を狭めません。受け付けられる形については OpenAI の Responses API リファレンスを参照してください。
number
ニュークリアスサンプリングのカットオフ。チャットティア専用で、
temperature と同じ条件です。範囲: 0 から 1string
コンテキストがモデルのウィンドウを超えたときの切り詰め戦略。上記 3 つの語彙と異なり、ここでは enum が実際に強制されます。これは、OpenAI が文書化している値がこの 2 つで全部であり、それ以降増えていないためです。明示的な
null は、上記のフィールドと同じ条件で引き続き受け付けられます。指定可能な値: auto、disabledobject
トークン使用量のエンベロープ。v1 のオペレーションがリクエストボディでこれを宣言しているため、このコントラクトにも存在します。OpenAI はこれをレスポンス側で設定するため、呼び出し元が送る理由はありません。
GET /v2/models/openai/gpt-5.5-pro/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する対象となる同じドキュメントです。
出力
string
モデルのコンテキストの最初の項目として、システム(または開発者)メッセージを挿入します。
previous_response_id と併用する場合、前のレスポンスの instructions は次のレスポンスに引き継がれません。これにより、新しいレスポンスでシステム(または開発者)メッセージを簡単に差し替えられます。string
レスポンスの生成に使用するモデル
number
デフォルト:"1"
レスポンスのランダム性を制御します範囲:
0 から 2number
デフォルト:"1"
ニュークリアスサンプリングによるレスポンスの多様性を制御します範囲:
0 から 1string
デフォルト:"\"disabled\""
モデルレスポンスに使用するトランケーション戦略。
-
auto: このレスポンスと以前のレスポンスのコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中の入力項目を削除してコンテキストウィンドウに収まるようにレスポンスをトランケートします。 -
disabled(デフォルト): モデルレスポンスがモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 設定可能な値:auto,disabled
string
後のターンでどの推論項目をモデルに返すかを制御します(例:
auto、current_turn、all_turns)。string
デフォルト:"\"medium\""
o シリーズモデル専用推論モデルの推論にかける労力を制約します。現在サポートされている値は
low、medium、high です。推論の労力を減らすと、レスポンスが速くなり、レスポンスで推論に使用されるトークン数が減る場合があります。設定可能な値: low, medium, highstring
非推奨: 代わりに
summary を使用してください。モデルが実行した推論の要約。デバッグやモデルの推論プロセスの理解に役立ちます。auto、concise、detailed のいずれかです。設定可能な値: auto, concise, detailedstring
レスポンスに使用する推論モード。
string
モデルが実行した推論の要約。デバッグやモデルの推論プロセスの理解に役立ちます。
auto、concise、detailed のいずれかです。設定可能な値: auto, concise, detailedobject
object
モデルが出力しなければならない形式を指定するオブジェクト。
{ "type": "json_schema" } を設定すると Structured Outputs が有効になり、モデルが指定した JSON スキーマに一致することが保証されます。詳細はStructured Outputs ガイドをご覧ください。デフォルトの形式は { "type": "text" } で、追加オプションはありません。gpt-4o 以降のモデルには非推奨:{ "type": "json_object" } に設定すると古い JSON モードが有効になり、モデルが生成するメッセージが有効な JSON であることが保証されます。対応しているモデルでは json_schema の使用が推奨されます。string
モデルレスポンスの冗長性を制約します。
low、medium、high のいずれかです。`none`, `auto`, `required` | object
レスポンスを生成する際に、モデルがどのツール(または複数のツール)を使用するかを選択する方法。モデルが呼び出せるツールを指定する方法については、
tools パラメータを参照してください。object[]
boolean
モデルレスポンスがバックグラウンドで実行されるかどうか。
object
レスポンスの課金情報。
string
レスポンスの支払いを担当する当事者。
number
このレスポンスが完了したときの Unix タイムスタンプ(秒)。ステータスが
completed の場合にのみ存在します。number
このレスポンスが作成されたときの Unix タイムスタンプ(秒)。
object
モデルがレスポンスの生成に失敗したときに返されるエラーオブジェクト。
string
必須
レスポンスのエラーコード。指定可能な値:
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_foundstring
必須
エラーの人間が読める形式の説明。
number
これまでにテキスト内に出現した頻度に基づいて、新しいトークンにペナルティを課します。
string
この Response の一意の識別子。
object
レスポンスが不完全である理由の詳細。
string
レスポンスが不完全である理由。指定可能な値:
max_output_tokens, content_filterinteger
1 つのレスポンスで処理できる組み込みツールへの呼び出しの合計最大数。
object
レスポンスに付加できるキーと値のペアのセット。
object
モデレーション済みの補完が要求された場合の、レスポンスの入力と出力に対するモデレーション結果。
string
このリソースのオブジェクトタイプ。常に
response に設定されます。指定可能な値: responseobject[]
モデルによって生成されたコンテンツ項目の配列。
output配列内の項目の長さと順序は、モデルのレスポンスによって異なります。output配列の最初の項目にアクセスして、それがモデルによって生成されたコンテンツを含むassistantメッセージであると仮定するのではなく、SDK でサポートされている場合はoutput_textプロパティの使用を検討してください。
string
SDK 専用の便利なプロパティで、
output 配列内のすべての output_text 項目からの集約されたテキスト出力を(存在する場合)含みます。
Python SDK と JavaScript SDK でサポートされています。boolean
デフォルト:"true"
モデルがツール呼び出しを並列で実行することを許可するかどうか。
number
これまでにテキスト内に出現したかどうかに基づいて、新しいトークンにペナルティを課します。
string
類似したリクエストのレスポンスをキャッシュしてキャッシュヒット率を最適化するために OpenAI が使用します。
user フィールドを置き換えます。string
プロンプトキャッシュの保持ポリシー(例:
in_memory または 24h)。string
OpenAI の利用ポリシーに違反している可能性のあるアプリケーションユーザーの検出を支援するために使用される安定した識別子。
string
リクエストの処理に使用される処理階層(例:
auto、default、flex、scale、priority)。string
レスポンス生成のステータス。
completed、failed、in_progress、cancelled、queued、incomplete のいずれか。指定可能な値: completed, failed, in_progress, cancelled, queued, incompleteboolean
レスポンスが後で API 経由で取得できるように保存されるかどうか。
object
組み込みツール別に分類されたトークンとリクエストの使用状況。
object
画像生成ツールのトークン使用状況。
integer
object
integer
integer
integer
object
integer
integer
integer
object
Web 検索ツールの使用状況。
integer
integer
各トークン位置で返す、最も可能性の高いトークンの最大数。それぞれに対数確率が関連付けられます。
object
入力トークン、出力トークン、出力トークンの内訳、使用された合計トークンを含むトークン使用状況の詳細を表します。
integer
必須
入力トークンの数。
object
必須
入力トークンの詳細な内訳。
integer
キャッシュに書き込まれた入力トークンの数。
integer
必須
キャッシュから取得されたトークン数です。
プロンプトキャッシュの詳細。
integer
必須
出力トークン数です。
object
必須
出力トークンの詳細な内訳です。
integer
必須
推論トークン数です。
integer
必須
使用されたトークンの合計数です。
string
エンドユーザー用の非推奨の識別子です。
safety_identifier と prompt_cache_key に置き換えられました。例
入力
出力
出荷前の確認
SDK はIdempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。
リクエストが失敗すると、Router は理由を示す X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。