openai/o1 の API リファレンスです。Comfy Router によって配信されます。
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk)を使用しています。cURL のスニペットは、同じ呼び出しを生の HTTP で行うものです。
モデル ID: openai/o1
エンドポイント: POST https://api.comfy.org/v2/models/openai/o1
- Wait for the result
- Queue and collect later
Schema
入力
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 ガイドを参照してください。chat ティアの id では無視されます。boolean
OpenAI が生成された応答を後で取得できるように保存するかどうか。
boolean
送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは無効です。Router はディスパッチ前にこれを
false に確定します。Router は text/event-stream を中継するのではなくプロバイダーの応答をキャプチャするためです。openAiResponsesProxy の ModifyResponse はこれをデコードできないので、ストリーミング生成は OpenAI に課金されても誰にも計量されません。ストリームが必要な場合は POST /proxy/openai/v1/responses を使用してください。number
サンプリング温度。CHAT ティア専用です。o シリーズの reasoning id(
o1、o1-pro、o3、o4-mini)は、OpenAI 側でこのパラメーターを拒否します。Router はそれらに対してこれを拒否しません(2 つのティアが 1 つのスキーマを共有する理由については、このコンポーネントの注記を参照してください)。そのため、これを送信した reasoning 呼び出しは OpenAI 自身のエラーで応答されます。範囲: 0 ~ 2object
出力フォーマットの設定。例: Structured Outputs 用の
{"format": {"type": "json_schema", ...}}。そのまま転送されます。string | object
モデルがどのツールを使用するかを選択する方法。文字列のモード、またはツールを指定するオブジェクトのいずれかです。
object[]
モデルが呼び出せるツール定義。Router はツールの分類を狭めません。受け入れられる形については OpenAI の Responses API リファレンスを参照してください。
number
ニュークリアスサンプリングのカットオフ。CHAT ティア専用で、
temperature と同じ条件です。範囲: 0 ~ 1string
コンテキストがモデルのウィンドウを超えた場合の切り捨て戦略。上記の 3 つの語彙とは異なり、ここでは列挙型が適用されます。これらの 2 つの値が OpenAI の文書化する完全な集合であり、それが増えていないためです。明示的な
null は、上記のフィールドと同じ条件で引き続き受け入れられます。指定可能な値: auto、disabledobject
トークン使用量のエンベロープ。v1 オペレーションがリクエストボディでこれを宣言しているため、この契約に存在します。OpenAI はこれを応答で設定するので、呼び出し元が送信する理由はありません。
GET /v2/models/openai/o1/openapi.json で Router が提供するスキーマから生成されたもので、リクエストがプロバイダーに到達する前に 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 schema に一致することが保証されます。詳細は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
必須
レスポンスのエラーコード。Possible values:
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
応答が不完全である理由。Possible values:
max_output_tokens, content_filterinteger
1 回の応答で処理できる、組み込みツールへの総呼び出し回数の最大値。
object
応答に付加できるキーと値のペアのセット。
object
モデレーション付きの完了が要求された場合の、応答の入力と出力に対するモデレーション結果。
string
このリソースのオブジェクトタイプ。常に
response に設定されます。Possible values: responseobject[]
モデルによって生成されたコンテンツ項目の配列。
output配列内の項目の長さと順序は、モデルの応答によって異なります。output配列の最初の項目にアクセスし、それがモデルによって生成された コンテンツを含むassistantメッセージであると仮定するのではなく、 SDK でサポートされている場合はoutput_textプロパティの使用を 検討してください。
string
output 配列内のすべての output_text 項目からの集約されたテキスト出力を
含む SDK 専用の便利なプロパティ(存在する場合)。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 のいずれか。Possible values: completed, failed, in_progress, cancelled, queued, incompleteboolean
応答が後で API 経由で取得するために保存されるかどうか。
object
組み込みツールごとに分類されたトークンとリクエストの使用状況。
object
画像生成ツールのトークン使用状況。
integer
object
integer
integer
integer
object
integer
integer
integer
object
Google/検索ツールの使用状況。
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 が現在対応していないことと、代替手段。