メインコンテンツへスキップ
OpenAI が提供し、Comfy Router が配信する openai/gpt-6.1-sol の API リファレンスです。 入力: テキスト、画像 · 出力: テキスト

クイックスタート

Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk と npm install @comfyorg/sdk)を使用しています。cURL のスニペットは、同じ呼び出しを生の HTTP で行うものです。 モデル ID: openai/gpt-6.1-sol エンドポイント: POST https://api.comfy.org/v2/models/openai/gpt-6.1-sol
同じボディを POST https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests に送信します。Router は実行が受け付けられるとすぐに 201 と request_id を返し、結果は準備ができ次第、このプロセスからでも別のプロセスからでも取得できます。キュー配信では、ステータス、キャンセル、取得の流れを説明します。

スキーマ

入力

string[]
モデル応答に含める追加の出力データ。
string | object[]
必須
モデルへのテキスト、画像、ファイル入力で、応答の生成に使用されます。このコントラクトのうち Router が補えない唯一のフィールドであり、下記の required に含まれる唯一の項目でもあります。
string
システム(または開発者)メッセージを、モデルのコンテキストの最初の項目として挿入します。
integer
応答のために生成されるトークン数の上限。可視出力トークンと reasoning トークンを含みます。reasoning 系の id では、この上限は隠れた reasoning トークンと共有されるため、小さな値を指定すると可視テキストが現れる前にバジェット全体を消費してしまいます。そのため reasoning のスモークケースでは 1024 を、チャットのケースでは 16 を送信しています。範囲: 1 から …
string
OpenAI のモデル識別子。Comfy Router ではこのフィールドは任意で、Router が {model} パスセグメントから補います。明示的な null も同じように置き換えられます。パスと一致しない値を送信すると拒否されます。
boolean
モデルがツール呼び出しを並列に実行することを許可するかどうか。
string
前の応答の ID で、マルチターンの会話に使用します。
object
reasoning ティア専用。reasoning モデルの設定で、たとえば {"effort": "medium"} です。そのまま転送されます。受け付けられるキーについては OpenAI の reasoning ガイドを参照してください。チャットティアの id では無視されます。
boolean
OpenAI が生成済みの応答を後で取得できるよう保存するかどうか。
boolean
送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは無効です。Router はディスパッチ前にこれを false に確定します。Router は text/event-stream を中継するのではなくプロバイダーの応答を取得するためです。text/event-stream をデコードできないため、ストリーミング生成は OpenAI に課金されつつ、どこにもメータリングされないことになります。Comfy のどのサーフェスもストリームを提供しません。v1 の POST /proxy/openai/v1/responses イングレスは stream: true を 400 で拒否し、リクエストを上流へ転送することは一切ありません。したがって、どちらのサーフェスでもこのフィールドを省略するか false を送信し、完了した応答を 1 つの JSON ボディとして読み取ってください。
number
サンプリングの temperature。チャットティア専用です。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 と同じ条件です。範囲: 0 から 1
string
コンテキストがモデルのウィンドウを超えた場合の切り詰め戦略。上記の 3 つの語彙とは異なり、ここでは enum が実際に適用されます。これらの 2 つの値が OpenAI のドキュメントに記載された完全な集合であり、それ以上増えていないためです。明示的な null は、上記のフィールドと同じ条件で引き続き受け付けられます。可能な値: auto, disabled
object
トークン使用量のエンベロープ。v1 オペレーションがリクエストボディでこれを宣言しているため、このコントラクトに含まれています。OpenAI はこれをレスポンスで設定するため、呼び出し元が送信する理由はありません。
GET /v2/models/openai/gpt-6.1-sol/openapi.json で Router が提供するスキーマから生成されており、リクエストがプロバイダーに届く前に呼び出しを検証するのと同じドキュメントです。

出力

string
システム(または開発者)メッセージをモデルのコンテキストの最初の項目として挿入します。previous_response_id と併用する場合、前の応答の instructions は次の応答に引き継がれません。これにより、新しい応答でシステム(または開発者)メッセージを簡単に差し替えられます。
integer
応答で生成できるトークン数の上限。表示される出力トークンと推論トークンを含みます。
string
応答の生成に使用されるモデル
number
デフォルト:"1"
応答のランダム性を制御します範囲: 0 から 2
number
デフォルト:"1"
nucleus サンプリングによる応答の多様性を制御します範囲: 0 から 1
string
デフォルト:"\"disabled\""
モデル応答に使用するトランケーション戦略。
  • auto: この応答および以前の応答のコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中にある入力項目を削除してコンテキストウィンドウに収まるように応答をトランケーションします。
  • disabled(デフォルト): モデル応答がモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 可能な値: auto、disabled
string
モデルへの前の応答の一意の ID。これを使用してマルチターンの会話を作成します。詳細は会話状態をご覧ください。
object
o シリーズモデル専用推論モデルの設定オプション。
string
以降のターンでどの推論項目をモデルに返すかを制御します(例: auto、current_turn、all_turns)。
string
デフォルト:"\"medium\""
o シリーズモデル専用推論モデルの推論にかかる労力を制約します。現在サポートされている値は low、medium、high です。推論の労力を減らすと、応答が速くなり、応答で推論に使用されるトークン数が少なくなる場合があります。可能な値: low、medium、high
string
非推奨: 代わりに summary を使用してください。モデルによって実行された推論の要約。デバッグやモデルの推論プロセスの理解に役立ちます。auto、concise、detailed のいずれかです。可能な値: auto、concise、detailed
string
応答に使用される推論モード。
string
モデルによって実行された推論の要約。デバッグやモデルの推論プロセスの理解に役立ちます。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
このレスポンスの一意な識別子。
object
レスポンスが不完全である理由の詳細。
string
レスポンスが不完全である理由。可能な値: max_output_tokens, content_filter
integer
1つのレスポンスで処理できる、組み込みツールへの総呼び出し回数の上限。
object
レスポンスに添付できるキーと値のペアのセット。
object
モデレーション済みの補完が要求された場合の、レスポンスの入力と出力に対するモデレーション結果。
string
このリソースのオブジェクト型。常に response に設定されます。可能な値: response
object[]
モデルによって生成されたコンテンツ項目の配列。
  • output 配列内の項目の長さと順序は、モデルのレスポンスによって異なります。
  • output 配列の最初の項目にアクセスして、それがモデルによって生成された コンテンツを含む assistant メッセージであると仮定するのではなく、 SDK でサポートされている場合は output_text プロパティの使用を検討してください。
string
SDK 専用の便利なプロパティで、output 配列内のすべての output_text 項目に含まれる 集約されたテキスト出力を保持します(存在する場合)。 Python と 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
キャッシュに書き込まれた入力トークン数。
object
キャッシュ書き込みをキャッシュの有効期間ごとに分割したものです。2つのカウントの合計は cache_write_tokens になります。
integer
12時間の有効期間でキャッシュに書き込まれた入力トークンの数。
integer
30分の有効期間でキャッシュに書き込まれた入力トークンの数。
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 が現在対応していないことと、代替手段。