openai/gpt-4.1-mini の API リファレンス。OpenAI から Comfy Router によって提供されます。
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk)を使用しています。cURL のスニペットは、同じ呼び出しを生の HTTP で実行するものです。
モデル ID: openai/gpt-4.1-mini
エンドポイント: POST https://api.comfy.org/v2/models/openai/gpt-4.1-mini
- Wait for the result
- Queue and collect later
スキーマ
入力
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 を中継するのではなくプロバイダー応答をキャプチャするためです。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/gpt-4.1-mini/openapi.json で Router が提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に呼び出しを検証するのと同じドキュメントです。
出力
string
モデルのコンテキストの最初の項目として、システム (または開発者) メッセージを挿入します。
previous_response_id と併用する場合、前のレスポンスの指示は次のレスポンスに引き継がれません。これにより、新しいレスポンスでシステム (または開発者) メッセージを簡単に差し替えられます。string
レスポンスの生成に使用されるモデル
number
デフォルト:"1"
レスポンスのランダム性を制御します範囲:
0 から 2number
デフォルト:"1"
レスポンスの多様性を nucleus サンプリングによって制御します範囲:
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 スキーマに一致することが保証されます。詳細については 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
必須
レスポンスのエラーコード。可能な値:
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
レスポンスが不完全である理由。指定可能な値:
max_output_tokens, content_filterinteger
1 つのレスポンスで処理できる、組み込みツールへの総呼び出し回数の最大値。
object
レスポンスに付加できるキーと値のペアのセット。
object
モデレーション済みの完了が要求された場合の、レスポンスの入力と出力に対するモデレーション結果。
string
このリソースのオブジェクトタイプ。常に
response に設定されます。指定可能な値: responseobject[]
モデルによって生成されたコンテンツ項目の配列。
output配列内の項目の長さと順序は、モデルのレスポンスによって異なります。output配列の最初の項目にアクセスし、それがモデルによって生成されたコンテンツを含むassistantメッセージであると想定する代わりに、SDK でサポートされている場合はoutput_textプロパティの使用を検討してください。
string
SDK 専用の便利なプロパティで、
output 配列内のすべての output_text 項目の集約されたテキスト出力が含まれます(存在する場合)。
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, incompleteboolean
レスポンスが後で API 経由で取得できるように保存されるかどうか。
object
組み込みツールごとに分類されたトークンとリクエストの使用状況。
object
画像生成ツールのトークン使用状況。
integer
object
integer
integer
integer
object
integer
integer
integer
object
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 が入力を拒否したことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。