openai/gpt-5.5 の APIリファレンス。Comfy Router が OpenAI から提供します。
入力: テキスト, 画像 · 出力: テキスト
クイックスタート
お使いの Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk と npm install @comfyorg/sdk)を使用しています。cURL スニペットは同じ呼び出しを生の HTTP で行います。
モデル ID: openai/gpt-5.5
エンドポイント: POST https://api.comfy.org/v2/models/openai/gpt-5.5
- 結果を待つ
- キューに送信して後で収集する
同じボディを
POST https://api.comfy.org/v2/models/openai/gpt-5.5/requests に送信します。Router は実行が受け付けられ次第 201 と request_id を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも収集できます。キュー配信では、ステータス、キャンセル、収集について説明しています。スキーマ
入力
モデルへのテキスト、画像、またはファイル入力で、応答の生成に使用されます。このコントラクトで Router が供給できない唯一のフィールドであり、以下の
required にある唯一の項目です。応答のために生成されるトークン数の上限で、可視の出力トークンと推論トークンを含みます。reasoning id ではこの上限は隠れた推論トークンと共有されるため、小さな値では可視テキストが出る前に予算全体を消費してしまうことがあります。これが、reasoning のスモークケースが 1024 を送るのに対し、chat のケースは 16 を送る理由です。範囲:
1 から …OpenAI モデル識別子。Comfy Router ではこのフィールドは任意で、Router が
{model} パスセグメントから埋めます。明示的な null も同様に置き換えられます。パスと一致しない値を送信すると拒否されます。reasoning ティア専用。reasoning モデルの設定。例:
{"effort": "medium"}。そのまま転送されます。受け入れられるキーについては OpenAI の reasoning ガイドを参照してください。chat ティアの id はこれを無視します。送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは無効です。Router はディスパッチ前にこれを
false に確定します。これは text/event-stream を中継するのではなくプロバイダー応答をキャプチャするためであり、Router はそれをデコードできないので、ストリーミングされた生成は 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コンテキストがモデルのウィンドウを超えたときの切り捨て戦略。上記の 3 つの語彙とは異なり、ここでは enum が適用されます。これは、この 2 つの値が OpenAI の文書化する完全な集合であり、増えていないためです。明示的な
null は、上記のフィールドと同じ条件で、依然として受け入れられます。指定可能な値: auto, disabledトークン使用量のエンベロープ。v1 オペレーションがリクエストボディでこれを宣言しているため、このコントラクトに存在します。OpenAI はこれを応答側で埋めるので、呼び出し元が送信する理由はありません。
GET /v2/models/openai/gpt-5.5/openapi.json で Router が提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に呼び出しを検証する対象となる同じドキュメントです。
出力
モデルのコンテキストの最初の項目として、システム(または開発者)メッセージを挿入します。
previous_response_id と併用する場合、前のレスポンスの instructions は次のレスポンスに引き継がれません。これにより、新しいレスポンスでシステム(または開発者)メッセージを簡単に差し替えられます。レスポンスで生成できるトークン数の上限。可視出力トークンと推論トークンが含まれます。
モデルのレスポンスに使用する切り詰め戦略。
-
auto: このレスポンスと以前のレスポンスのコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中の入力項目を削除してコンテキストウィンドウに収まるようにレスポンスを切り詰めます。 -
disabled(デフォルト): モデルのレスポンスがモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 指定可能な値:auto,disabled
モデルに対する前のレスポンスの一意の ID。これを使用してマルチターンの会話を作成します。詳細は会話の状態をご覧ください。
o シリーズのモデル専用reasoning モデルの設定オプション。
o シリーズのモデル専用reasoning モデルの reasoning にかける労力を制約します。現在サポートされている値は
low、medium、high です。reasoning の労力を減らすと、レスポンスが速くなり、レスポンスで 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 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 が現在対応していないことと、代替手段。