openai/gpt-6.1-terra の API リファレンス。このモデルは Comfy Router によって提供されます。
入力: テキスト、画像 · 出力: テキスト
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk と npm install @comfyorg/sdk)を使用しています。cURL のスニペットは、生の HTTP による同じ呼び出しです。
モデル ID: openai/gpt-6.1-terra
エンドポイント: POST https://api.comfy.org/v2/models/openai/gpt-6.1-terra
- 結果を待つ
- キューに送信して後で取得する
同じボディを
POST https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests に送信します。Router は実行が受け付けられるとすぐに request_id を含む 201 を返し、結果は準備ができ次第、このプロセスからでも別のプロセスからでも取得できます。キューによる配信では、ステータス、キャンセル、取得について説明しています。スキーマ
入力
モデルへのテキスト、画像、またはファイルの入力。レスポンスの生成に使用されます。このコントラクトのうち Router が供給できない唯一のフィールドであり、以下の
required に含まれる唯一の項目でもあります。レスポンスのために生成されるトークン数の上限。表示される出力トークンと推論トークンを含みます。reasoning の id では、この上限は隠れた推論トークンと共有されるため、小さな値を指定すると表示テキストが何も出力される前にバジェット全体を消費してしまう可能性があります。そのため、reasoning のスモークテストでは 1024 を送信し、chat のテストでは 16 を送信しています。範囲:
1 から …OpenAI のモデル識別子。Comfy Router ではこのフィールドは任意(OPTIONAL)であり、Router が
{model} パスセグメントから設定します。明示的な null も同じ方法で置き換えられます。パスと矛盾する値を送信すると拒否されます。reasoning ティア専用。推論モデルの設定です(例:
{"effort": "medium"})。変更されずに転送されます。受け入れられるキーについては OpenAI の reasoning ガイドを参照してください。chat ティアの id はこれを無視します。送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは無効(INERT)です。Router はディスパッチ前にこれを
false に確定(SETTLE)します。これは、text/event-stream を中継するのではなくプロバイダーのレスポンスをキャプチャするためであり、その形式はデコードできないため、ストリーミングされた生成は OpenAI から課金されても誰もメーター計測しないことになります。Comfy のどのサーフェスもストリームを提供しません。v1 の POST /proxy/openai/v1/responses イングレスは stream: true を 400 で拒否し、リクエストを上流へ転送しません。そのため、いずれのサーフェスでもこのフィールドを省略するか false を送信し、完了したレスポンスを 1 つの JSON ボディとして読み取ってください。サンプリング温度。chat ティア専用です。o シリーズの reasoning id(
o1、o1-pro、o3、o4-mini)は OpenAI 側でこのパラメーターを拒否します。Router はそれらのためにこのパラメーターを拒否しません(2 つのティアが 1 つのスキーマを共有する理由については、このコンポーネントの注記を参照してください)。そのため、これを送信する reasoning 呼び出しは OpenAI 自身のエラーとして返答されます。範囲: 0 から 2出力フォーマットの設定です(例: Structured Outputs のための
{"format": {"type": "json_schema", ...}})。変更されずに転送されます。コンテキストがモデルのウィンドウを超えた場合の切り詰め戦略。上記の 3 つの語彙とは異なり、ここでは enum が実際に適用されます。これは、これらの 2 つの値が OpenAI のドキュメントに記載された完全なセットであり、それ以上増えていないためです。明示的な
null も、上記のフィールドと同じ条件で引き続き受け入れられます。可能な値: auto、disabledトークン使用量のエンベロープ。v1 のオペレーションがリクエストボディでこれを宣言しているため、このコントラクトに存在します。OpenAI はこれをレスポンスで設定するため、呼び出し元が送信する理由はありません。
GET /v2/models/openai/gpt-6.1-terra/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに届く前に呼び出しを検証する際に使用するのと同じドキュメントです。
出力
システム(または開発者)メッセージを、モデルのコンテキストの最初の項目として挿入します。
previous_response_id と併用する場合、前のレスポンスの instructions は次のレスポンスに引き継がれません。これにより、新しいレスポンスでシステム(または開発者)メッセージを簡単に差し替えられます。レスポンスで生成できるトークン数の上限。可視出力トークンと推論トークンを含みます。
モデルレスポンスに使用する切り詰め戦略。
-
auto: このレスポンスと以前のレスポンスのコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中にある入力項目を削除して、コンテキストウィンドウに収まるようにレスポンスを切り詰めます。 -
disabled(デフォルト): モデルレスポンスがモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 指定可能な値:auto,disabled
モデルへの前のレスポンスの一意の ID。複数ターンの会話を作成するために使用します。会話状態の詳細をご覧ください。
o シリーズモデルのみ推論モデルの設定オプション。
o シリーズモデルのみ推論モデルの推論にかける労力を制約します。現在サポートされている値は
low、medium、high です。推論の労力を減らすと、レスポンスが速くなり、レスポンス内の推論に使用されるトークン数も少なくなる場合があります。指定可能な値: low, medium, high非推奨: 代わりに
summary を使用してください。モデルが実行した推論の要約。デバッグやモデルの推論プロセスの理解に役立ちます。auto、concise、detailed のいずれかです。指定可能な値: auto, concise, detailedモデルが実行した推論の要約。デバッグやモデルの推論プロセスの理解に役立ちます。
auto、concise、detailed のいずれかです。指定可能な値: auto, concise, detailedモデルが出力しなければならない形式を指定するオブジェクト。
{ "type": "json_schema" } を設定すると Structured Outputs が有効になり、モデルが指定した JSON スキーマに一致することが保証されます。詳細は Structured Outputs ガイドをご覧ください。デフォルトの形式は { "type": "text" } で、追加のオプションはありません。gpt-4o 以降のモデルには推奨されません:{ "type": "json_object" } に設定すると古い JSON モードが有効になり、モデルが生成するメッセージが有効な JSON であることが保証されます。サポートしているモデルでは json_schema の使用が推奨されます。レスポンス生成時にモデルがどのツール(または複数のツール)を選択するか。モデルが呼び出せるツールの指定方法については
tools パラメータを参照してください。レスポンスのエラーコード。可能な値:
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モデルによって生成されたコンテンツ項目の配列。
output配列内の項目の長さと順序は、モデルのレスポンスによって異なります。output配列の最初の項目にアクセスし、それがモデルによって生成された コンテンツを含むassistantメッセージであると想定する代わりに、 SDK でサポートされている場合はoutput_textプロパティの使用を 検討してください。
SDK 専用の便利なプロパティで、
output 配列内のすべての output_text 項目に含まれるテキスト出力を集約したものです(存在する場合)。
Python SDK と JavaScript SDK でサポートされています。レスポンス生成のステータス。
completed、failed、in_progress、cancelled、queued、incomplete のいずれかです。可能な値: completed, failed, in_progress, cancelled, queued, incompleteキャッシュから取得されたトークン数。
プロンプトキャッシュの詳細。
例
入力
出力
出荷前の確認
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 が現在対応していないことと、代替手段。