Skip to main content
openai/gpt-5-nano の API リファレンスです。Comfy Router が OpenAI から提供しています。

クイックスタート

Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdknpm install @comfyorg/sdk)を使用しています。cURL のスニペットは、同じ呼び出しを生の HTTP で実行するものです。 モデル ID: openai/gpt-5-nano エンドポイント: POST https://api.comfy.org/v2/models/openai/gpt-5-nano

スキーマ

入力

string[]
モデルのレスポンスに含める追加の出力データ。
string | object[]
必須
モデルへのテキスト、画像、またはファイル入力で、レスポンスの生成に使用されます。このコントラクトのうち Router が補うことのできない唯一のフィールドであり、以下の required に含まれる唯一の項目です。
string
モデルのコンテキストの最初の項目として、system(または developer)メッセージを挿入します。
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 に確定します。これは text/event-stream を中継するのではなくプロバイダーのレスポンスをキャプチャするためであり、openAiResponsesProxy の ModifyResponse はこれをデコードできません。そのため、ストリームで生成すると OpenAI からは課金されつつ、誰にも計量されません。ストリームが必要な場合は POST /proxy/openai/v1/responses を使用してください。
number
サンプリング温度。chat ティア専用です。o シリーズの reasoning id(o1o1-proo3o4-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 は、上記のフィールドと同じ条件で引き続き受け付けられます。可能な値: autodisabled
object
トークン使用量のエンベロープ。v1 オペレーションがリクエスト本文でこれを宣言しているため、このコントラクトに存在します。OpenAI はこれをレスポンス側で設定するため、呼び出し元がこれを送信する理由はありません。
Router が GET /v2/models/openai/gpt-5-nano/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に呼び出しを検証するのと同じドキュメントです。

出力

string
モデルのコンテキストの最初の項目として、システム(または開発者)メッセージを挿入します。previous_response_id と併用する場合、前のレスポンスの instructions は次のレスポンスに引き継がれません。これにより、新しいレスポンスでシステム(または開発者)メッセージを簡単に差し替えられます。
integer
レスポンスで生成できるトークン数の上限。可視出力トークンとreasoning tokensが含まれます。
string
レスポンスの生成に使用するモデル
number
デフォルト:"1"
レスポンスのランダム性を制御します範囲: 0 から 2
number
デフォルト:"1"
ニュークリアスサンプリングによるレスポンスの多様性を制御します範囲: 0 から 1
string
デフォルト:"\"disabled\""
モデルレスポンスに使用する切り捨て戦略。
  • auto: このレスポンスと以前のレスポンスのコンテキストがモデルのコンテキストウィンドウサイズを超える場合、会話の途中の入力項目を削除してコンテキストウィンドウに収まるようにレスポンスを切り捨てます。
  • disabled(デフォルト): モデルレスポンスがモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 指定可能な値: autodisabled
string
モデルに対する前のレスポンスの一意の ID。これを使ってマルチターンの会話を作成します。conversation state の詳細をご覧ください。
object
o シリーズモデルのみreasoning モデルの設定オプション。
string
以降のターンでどの reasoning 項目をモデルに返すかを制御します。例: autocurrent_turnall_turns
string
デフォルト:"\"medium\""
o シリーズモデルのみreasoning モデルの reasoning にかける労力を制約します。現在サポートされている値は lowmediumhigh です。reasoning の労力を減らすと、レスポンスが速くなり、レスポンスで reasoning に使用されるトークンが少なくなる場合があります。指定可能な値: lowmediumhigh
string
非推奨: 代わりに summary を使用してください。モデルが実行した reasoning の要約。デバッグやモデルの reasoning プロセスの理解に役立ちます。autoconcisedetailed のいずれかです。指定可能な値: autoconcisedetailed
string
レスポンスに使用する reasoning モード。
string
モデルが実行した reasoning の要約。デバッグやモデルの reasoning プロセスの理解に役立ちます。autoconcisedetailed のいずれかです。指定可能な値: autoconcisedetailed
object
object
モデルが出力しなければならないフォーマットを指定するオブジェクト。{ "type": "json_schema" } を設定すると Structured Outputs が有効になり、モデルが指定した JSON schema に一致することが保証されます。詳細は Structured Outputs ガイドをご覧ください。デフォルトのフォーマットは追加オプションなしの { "type": "text" } です。gpt-4o 以降のモデルには推奨されません:{ "type": "json_object" } に設定すると、旧来の JSON モードが有効になり、モデルが生成するメッセージが有効な JSON であることが保証されます。対応しているモデルでは json_schema の使用が推奨されます。
string
モデルのレスポンスの冗長性を制約します。lowmediumhigh のいずれかです。
`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 SDK と JavaScript SDK でサポートされています。
boolean
デフォルト:"true"
モデルがツール呼び出しを並列で実行することを許可するかどうか。
number
これまでのテキストに出現するかどうかに基づいて、新しいトークンにペナルティを与えます。
string
類似したリクエストのレスポンスをキャッシュしてキャッシュヒット率を最適化するために OpenAI が使用します。user フィールドを置き換えます。
string
プロンプトキャッシュの保持ポリシー(例: in_memory または 24h)。
string
OpenAI の利用ポリシーに違反している可能性のある、アプリケーションのユーザーの検出に役立てるために使用される安定した識別子。
string
リクエストの処理に使用される処理ティア(例: autodefaultflexscalepriority)。
string
レスポンス生成のステータス。completedfailedin_progresscancelledqueuedincomplete のいずれかです。指定可能な値: 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 が入力を拒否したことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。

ヘッダー

認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

Router API の利用

モデルの検出、バリデーションエラー、リトライ、課金。

制限事項

Router が現在対応していないことと、代替手段。