openrouter/chat-completions の API リファレンスです。
入力: テキスト, 画像 · 出力: テキスト
リクエストのセットアップ
お使いの Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python の場合は pip install comfy-sdk を実行します。TypeScript の場合は npm install @comfyorg/sdk を実行します。cURL は生の HTTP を使用します。
モデル ID: openrouter/chat-completions
エンドポイント: POST https://api.comfy.org/v2/models/openrouter/chat-completions
このモデルには実行可能なリクエスト例がありません。以下の入力ドキュメントからボディを構築し、Router クイックスタートで使用してください。
スキーマ
入力
自動プロンプトキャッシュを有効にします。トップレベルで設定すると、リクエスト内の最後のキャッシュ可能なブロックにキャッシュブレークポイントが自動的に適用されます。現在は Anthropic Claude モデルでサポートされています。
バックアッププロバイダーによるリクエスト処理を許可するかどうか
- true:(デフォルト)プライマリプロバイダー(または “order” で指定したカスタムプロバイダー)が利用できない場合、次に最適なプロバイダーを使用します。
- false: プライマリまたはカスタムプロバイダーのみを使用し、利用できない場合は上流のエラーを返します。
データ収集の設定。要件を満たす利用可能なモデルプロバイダーがない場合、リクエストはエラーを返します。
- allow:(デフォルト)ユーザーデータを一時的でない形で保存し、それを学習に使用する可能性があるプロバイダーを許可します。
- deny: ユーザーデータを収集しないプロバイダーのみを使用します。
`AkashML`, `AI21`, `AionLabs`, `Alibaba`, `Ambient`, `Baidu`, `Amazon Bedrock`, `Amazon Nova`, `Anthropic`, `Arcee AI`, `AtlasCloud`, `Avian`, `Azure`, `BaseTen`, `BytePlus`, `Black Forest Labs`, `Cerebras`, `Chutes`, `Cirrascale`, `Clarifai`, `Cloudflare`, `Cohere`, `Crucible`, `Crusoe`, `DeepInfra`, `DeepSeek`, `DekaLLM`, `Featherless`, `Fireworks`, `Friendli`, `GMICloud`, `Google`, `Google AI Studio`, `Groq`, `Hyperbolic`, `Inception`, `Inceptron`, `InferenceNet`, `Ionstream`, `Infermatic`, `Io Net`, `Inflection`, `Liquid`, `Mara`, `Mancer 2`, `Minimax`, `ModelRun`, `Mistral`, `Modular`, `Moonshot AI`, `Morph`, `NCompass`, `Nebius`, `Nex AGI`, `NextBit`, `Novita`, `Nvidia`, `OpenAI`, `OpenInference`, `Parasail`, `Poolside`, `Perceptron`, `Perplexity`, `Phala`, `Recraft`, `Reka`, `Relace`, `SambaNova`, `Seed`, `SiliconFlow`, `Sourceful`, `StepFun`, `Stealth`, `StreamLake`, `Switchpoint`, `Together`, `Upstage`, `Venice`, `WandB`, `Xiaomi`, `xAI`, `Z.AI`, `FakeProvider` | string[]
無視するプロバイダーのスラッグのリスト。指定した場合、このリストはこのリクエストに対してアカウント全体で無視するプロバイダー設定とマージされます。
`AkashML`, `AI21`, `AionLabs`, `Alibaba`, `Ambient`, `Baidu`, `Amazon Bedrock`, `Amazon Nova`, `Anthropic`, `Arcee AI`, `AtlasCloud`, `Avian`, `Azure`, `BaseTen`, `BytePlus`, `Black Forest Labs`, `Cerebras`, `Chutes`, `Cirrascale`, `Clarifai`, `Cloudflare`, `Cohere`, `Crucible`, `Crusoe`, `DeepInfra`, `DeepSeek`, `DekaLLM`, `Featherless`, `Fireworks`, `Friendli`, `GMICloud`, `Google`, `Google AI Studio`, `Groq`, `Hyperbolic`, `Inception`, `Inceptron`, `InferenceNet`, `Ionstream`, `Infermatic`, `Io Net`, `Inflection`, `Liquid`, `Mara`, `Mancer 2`, `Minimax`, `ModelRun`, `Mistral`, `Modular`, `Moonshot AI`, `Morph`, `NCompass`, `Nebius`, `Nex AGI`, `NextBit`, `Novita`, `Nvidia`, `OpenAI`, `OpenInference`, `Parasail`, `Poolside`, `Perceptron`, `Perplexity`, `Phala`, `Recraft`, `Reka`, `Relace`, `SambaNova`, `Seed`, `SiliconFlow`, `Sourceful`, `StepFun`, `Stealth`, `StreamLake`, `Switchpoint`, `Together`, `Upstage`, `Venice`, `WandB`, `Xiaomi`, `xAI`, `Z.AI`, `FakeProvider` | string[]
許可するプロバイダーのスラッグのリスト。指定した場合、このリストはこのリクエストに対するアカウント全体の許可プロバイダー設定とマージされます。
`AkashML`, `AI21`, `AionLabs`, `Alibaba`, `Ambient`, `Baidu`, `Amazon Bedrock`, `Amazon Nova`, `Anthropic`, `Arcee AI`, `AtlasCloud`, `Avian`, `Azure`, `BaseTen`, `BytePlus`, `Black Forest Labs`, `Cerebras`, `Chutes`, `Cirrascale`, `Clarifai`, `Cloudflare`, `Cohere`, `Crucible`, `Crusoe`, `DeepInfra`, `DeepSeek`, `DekaLLM`, `Featherless`, `Fireworks`, `Friendli`, `GMICloud`, `Google`, `Google AI Studio`, `Groq`, `Hyperbolic`, `Inception`, `Inceptron`, `InferenceNet`, `Ionstream`, `Infermatic`, `Io Net`, `Inflection`, `Liquid`, `Mara`, `Mancer 2`, `Minimax`, `ModelRun`, `Mistral`, `Modular`, `Moonshot AI`, `Morph`, `NCompass`, `Nebius`, `Nex AGI`, `NextBit`, `Novita`, `Nvidia`, `OpenAI`, `OpenInference`, `Parasail`, `Poolside`, `Perceptron`, `Perplexity`, `Phala`, `Recraft`, `Reka`, `Relace`, `SambaNova`, `Seed`, `SiliconFlow`, `Sourceful`, `StepFun`, `Stealth`, `StreamLake`, `Switchpoint`, `Together`, `Upstage`, `Venice`, `WandB`, `Xiaomi`, `xAI`, `Z.AI`, `FakeProvider` | string[]
プロバイダーのスラッグの順序付きリスト。ルーターは、このリストのうちリクエストされたモデルをサポートするサブセットの最初のプロバイダーを使用しようとし、利用できない場合は次のプロバイダーにフォールバックします。利用可能なプロバイダーがない場合、リクエストはエラーメッセージとともに失敗します。
希望する最大レイテンシ (秒単位)。数値 (p50 に適用) またはパーセンタイル別のしきい値を持つオブジェクトを指定できます。しきい値を超えるエンドポイントも引き続き使用される可能性がありますが、ルーティングでは優先度が下がります。フォールバックモデルを使用する場合、しきい値を満たしていればプライマリモデルの代わりにフォールバックモデルが使用されることがあります。
希望する最小スループット (1 秒あたりのトークン数)。数値 (p50 に適用) またはパーセンタイル別のしきい値を持つオブジェクトを指定できます。しきい値を下回るエンドポイントも引き続き使用される可能性がありますが、ルーティングでは優先度が下がります。フォールバックモデルを使用する場合、しきい値を満たしていればプライマリモデルの代わりにフォールバックモデルが使用されることがあります。
指定したパラメータをサポートするプロバイダーのみにフィルタするかどうか。この設定を省略するか false に設定した場合、プロバイダーはサポートするパラメータのみを受け取り、それ以外は無視します。
このリクエストで使用する並び替え戦略 (“order” が指定されていない場合)。設定すると、負荷分散は行われません。
ルーティングを ZDR (Zero Data Retention、データ保持ゼロ) エンドポイントのみに制限するかどうか。true の場合、プロンプトを保持しないエンドポイントのみが使用されます。
可観測性のために関連するリクエスト (会話やエージェントワークフローなど) をグループ化するための一意の識別子。リクエストボディと x-session-id ヘッダーの両方で指定された場合、ボディの値が優先されます。最大 256 文字。
可観測性とトレーシングのためのメタデータ。既知のキー (trace_id、trace_name、span_name、generation_name、parent_span_id) は特別に処理されます。追加のキーはカスタムメタデータとして、設定されたブロードキャスト先にそのまま渡されます。
GET /v2/models/openrouter/chat-completions/openapi.json で提供するスキーマ、つまりリクエストがプロバイダーに到達する前に呼び出しを検証するのと同じドキュメントから生成済みです。
出力
パイプラインステージのカテゴリ種別。複数のプラグインが同じ type を共有できます(例: guardrail レベルのプラグインはすべて
guardrail を出力します)。どのプラグインが出力したかは name フィールドで区別します。指定可能な値: guardrail、plugin、server_tools、response_healing、context_compression例
出力
出荷前の確認
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 が現在対応していないことと、代替手段。