Skip to main content
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 を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも収集できます。キュー配信では、ステータス、キャンセル、収集について説明しています。

スキーマ

入力

string[]
モデル応答に含める追加の出力データ。
string | object[]
必須
モデルへのテキスト、画像、またはファイル入力で、応答の生成に使用されます。このコントラクトで Router が供給できない唯一のフィールドであり、以下の required にある唯一の項目です。
string
モデルのコンテキストの最初の項目として、システム(または開発者)メッセージを挿入します。
integer
応答のために生成されるトークン数の上限で、可視の出力トークンと推論トークンを含みます。reasoning id ではこの上限は隠れた推論トークンと共有されるため、小さな値では可視テキストが出る前に予算全体を消費してしまうことがあります。これが、reasoning のスモークケースが 1024 を送るのに対し、chat のケースは 16 を送る理由です。範囲: 1 から …
string
OpenAI モデル識別子。Comfy Router ではこのフィールドは任意で、Router が {model} パスセグメントから埋めます。明示的な null も同様に置き換えられます。パスと一致しない値を送信すると拒否されます。
boolean
モデルがツール呼び出しを並列で実行することを許可するかどうか。
string
マルチターン会話のための、前の応答の ID。
object
reasoning ティア専用。reasoning モデルの設定。例: {"effort": "medium"}。そのまま転送されます。受け入れられるキーについては OpenAI の reasoning ガイドを参照してください。chat ティアの id はこれを無視します。
boolean
OpenAI が生成済みの応答を後で取得できるよう保存するかどうか。
boolean
送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは無効です。Router はディスパッチ前にこれを false に確定します。これは text/event-stream を中継するのではなくプロバイダー応答をキャプチャするためであり、Router はそれをデコードできないので、ストリーミングされた生成は OpenAI によって課金され、誰もメータリングしません。Comfy のどのサーフェスもストリームを提供しません。v1 の POST /proxy/openai/v1/responses イングレスは stream: true を 400 で拒否し、リクエストを上流へ転送することはありません。したがって、どちらのサーフェスでもこのフィールドを省略するか false を送信し、完了した応答を 1 つの JSON ボディとして読み取ってください。
number
サンプリング温度。chat ティア専用です。o シリーズの reasoning id(o1、o1-pro、o3、o4-mini)は OpenAI 側でこのパラメータを拒否します。Router はそれらのために拒否しません(2 つのティアが 1 つのスキーマを共有する理由についてはこのコンポーネントの注記を参照)。そのため、これを送信する reasoning 呼び出しには OpenAI 自身のエラーが返されます。範囲: 0 から 2
object
出力フォーマットの設定。例: Structured Outputs 用の {"format": {"type": "json_schema", ...}}。そのまま転送されます。
string | object
モデルが使用するツールをどのように選択すべきか。文字列のモードか、ツールを指定するオブジェクトのいずれかです。
object[]
モデルが呼び出せるツール定義。Router はツールの分類を絞り込みません。受け入れられる形については OpenAI の Responses API リファレンスを参照してください。
number
ニュークラスサンプリングのカットオフ。temperature と同じ条件で、chat ティア専用です。範囲: 0 から 1
string
コンテキストがモデルのウィンドウを超えたときの切り捨て戦略。上記の 3 つの語彙とは異なり、ここでは enum が適用されます。これは、この 2 つの値が OpenAI の文書化する完全な集合であり、増えていないためです。明示的な null は、上記のフィールドと同じ条件で、依然として受け入れられます。指定可能な値: auto, disabled
object
トークン使用量のエンベロープ。v1 オペレーションがリクエストボディでこれを宣言しているため、このコントラクトに存在します。OpenAI はこれを応答側で埋めるので、呼び出し元が送信する理由はありません。
GET /v2/models/openai/gpt-5.5/openapi.json で Router が提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に呼び出しを検証する対象となる同じドキュメントです。

出力

string
モデルのコンテキストの最初の項目として、システム(または開発者)メッセージを挿入します。previous_response_id と併用する場合、前のレスポンスの instructions は次のレスポンスに引き継がれません。これにより、新しいレスポンスでシステム(または開発者)メッセージを簡単に差し替えられます。
integer
レスポンスで生成できるトークン数の上限。可視出力トークンとreasoning tokensが含まれます。
string
レスポンスの生成に使用されたモデル
number
デフォルト:"1"
レスポンスのランダム性を制御します範囲: 0 から 2
number
デフォルト:"1"
ニュークリアスサンプリングによるレスポンスの多様性を制御します範囲: 0 から 1
string
デフォルト:"\"disabled\""
モデルのレスポンスに使用する切り詰め戦略。
  • auto: このレスポンスと以前のレスポンスのコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中の入力項目を削除してコンテキストウィンドウに収まるようにレスポンスを切り詰めます。
  • disabled(デフォルト): モデルのレスポンスがモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 指定可能な値: auto, disabled
string
モデルに対する前のレスポンスの一意の ID。これを使用してマルチターンの会話を作成します。詳細は会話の状態をご覧ください。
object
o シリーズのモデル専用reasoning モデルの設定オプション。
string
以降のターンでどの reasoning 項目をモデルに返すかを制御します(例: auto、current_turn、all_turns)。
string
デフォルト:"\"medium\""
o シリーズのモデル専用reasoning モデルの reasoning にかける労力を制約します。現在サポートされている値は low、medium、high です。reasoning の労力を減らすと、レスポンスが速くなり、レスポンスで reasoning に使用されるトークン数も少なくなる場合があります。指定可能な値: low, medium, high
string
非推奨: 代わりに summary を使用してください。モデルが実行した reasoning の要約。デバッグやモデルの reasoning プロセスの理解に役立ちます。auto、concise、detailed のいずれかです。指定可能な値: auto, concise, detailed
string
レスポンスに使用される reasoning モード。
string
モデルが実行した reasoning の要約。デバッグやモデルの reasoning プロセスの理解に役立ちます。auto、concise、detailed のいずれかです。指定可能な値: auto, concise, detailed
object
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
この Response が完了したときの Unix タイムスタンプ(秒)。status が completed の場合にのみ存在します。
number
この Response が作成されたときの Unix タイムスタンプ(秒)。
object
モデルが Response の生成に失敗したときに返されるエラーオブジェクト。
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_found
string
必須
エラーの内容を人間が読める形式で説明したもの。
number
これまでのテキスト内での出現頻度に基づいて、新しいトークンにペナルティを与えます。
string
この Response の一意の識別子。
object
レスポンスが不完全である理由の詳細。
string
レスポンスが不完全である理由。指定可能な値: max_output_tokens, content_filter
integer
1 つのレスポンスで処理できる、組み込みツールへの総呼び出し回数の最大値。
object
レスポンスに付加できるキーと値のペアのセット。
object
モデレーション済みの補完が要求された場合の、レスポンスの入力と出力に対するモデレーション結果。
string
このリソースのオブジェクトタイプ。常に response に設定されます。指定可能な値: response
object[]
モデルによって生成されたコンテンツ項目の配列。
  • output 配列内の項目の長さと順序は、モデルのレスポンスによって異なります。
  • output 配列の先頭の項目にアクセスし、それがモデルによって生成された コンテンツを含む assistant メッセージであると決め打ちするのではなく、 SDK でサポートされている場合は output_text プロパティの使用を検討してください。
string
output 配列内のすべての output_text 項目からのテキスト出力を集約したものを含む SDK 専用の便利なプロパティです(存在する場合)。 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, incomplete
boolean
後で API 経由で取得できるようにレスポンスを保存するかどうか。
object
組み込みツールごとに分類されたトークンとリクエストの使用量。
object
画像生成ツールのトークン使用量。
integer
object
integer
integer
integer
object
integer
integer
integer
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 が入力を拒否したことを意味し、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 が現在対応していないことと、代替手段。