Skip to main content
OpenAI が提供する 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
同じボディを POST https://api.comfy.org/v2/models/openai/o1/requests に送信します。Router は実行が受け付けられ次第 201 と request_id を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得については キュー配信 で順を追って説明しています。

スキーマ

入力

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

出力

string
システム(または developer)メッセージを、モデルのコンテキストの最初の項目として挿入します。previous_response_id と併用する場合、以前のレスポンスの instructions は次のレスポンスに引き継がれません。そのため、新しいレスポンスでシステム(または developer)メッセージを簡単に差し替えられます。
integer
レスポンスで生成できるトークン数の上限。表示される出力トークンと reasoning tokens が含まれます。
string
レスポンスの生成に使用されたモデル
number
デフォルト:"1"
レスポンスのランダム性を制御します範囲: 0 から 2
number
デフォルト:"1"
ニュークリアスサンプリングによるレスポンスの多様性を制御します範囲: 0 から 1
string
デフォルト:"\"disabled\""
モデルのレスポンスに使用する切り捨て戦略。
  • auto: このレスポンスと以前のレスポンスのコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中の入力項目を削除してコンテキストウィンドウにフィットするようにレスポンスを切り捨てます。
  • disabled(デフォルト): モデルのレスポンスがモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 指定可能な値: auto、disabled
string
モデルへの以前のレスポンスの一意な ID。これを使用してマルチターンの会話を作成します。会話の状態 の詳細を学ぶ。
object
o シリーズのモデルのみreasoning models の設定オプション。
string
後のターンでどの reasoning 項目をモデルに返すかを制御します。例: auto、current_turn、all_turns。
string
デフォルト:"\"medium\""
o シリーズのモデルのみreasoning models の 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 タイムスタンプ(秒)。ステータスが completed の場合にのみ存在します。
number
この Response が作成されたときの Unix タイムスタンプ(秒)。
object
モデルが Response の生成に失敗したときに返されるエラーオブジェクト。
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_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 および 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 が現在対応していないことと、代替手段。