Comfy Router で Chat Completions を使用する

Openrouter から Comfy Router によって提供される openrouter/chat-completions の API リファレンスです。

リクエストのセットアップ

お使いの Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python の場合は pip install comfy-sdk を実行します。TypeScript の場合は npm install @comfyorg/sdk を実行します。Swift の場合は ComfySwiftSDK パッケージを追加します。cURL は生の HTTP を使用します。 モデル ID: openrouter/chat-completions エンドポイント: POST https://api.comfy.org/v2/models/openrouter/chat-completions

このモデルには実行可能なリクエスト例がありません。以下の入力ドキュメントからボディを構築し、Router クイックスタートで使用してください。

スキーマ

入力

object

自動プロンプトキャッシュを有効にします。トップレベルで設定すると、リクエスト内の最後のキャッシュ可能なブロックにキャッシュブレークポイントが自動的に適用されます。現在は Anthropic Claude モデルでサポートされています。

string

指定可能な値: 5m、1h

string

必須

指定可能な値: ephemeral

object

リクエストの変換を検査するためのデバッグオプション（ストリーミングのみ）

boolean

true の場合、変換後の上流リクエストボディをストリーム開始時のデバッグチャンクに含めます。ストリーミングモードでのみ動作します。

number

頻度ペナルティ（-2.0 から 2.0）形式: double

object | string | number | object[]

object

トークンの logit バイアス調整

boolean

対数確率を返します

integer

補完の最大トークン数

integer

最大トークン数（非推奨。max_completion_tokens を使用してください）。注意: 一部のプロバイダーでは最小 16 が強制されます。

object[]

必須

会話のメッセージのリスト

object

追加のオブジェクト情報のためのキーと値のペア（最大 16 ペア、キーは 64 文字、値は 512 文字）

`text`, `image`, `audio`[]

レスポンスの出力モダリティ。サポートされる値は “text”、“image”、“audio” です。

string

補完に使用するモデル

string[]

補完に使用するモデル

boolean

ツール使用時に並列関数呼び出しを有効にするかどうか。true の場合、モデルは 1 回のレスポンスで複数のツール呼び出しを生成することがあります。

object[]

このリクエストで有効にするプラグインとその設定。

number

存在ペナルティ（-2.0 から 2.0）形式: double

object

複数のモデルプロバイダーが利用可能な場合に、ルーティングの優先設定を任意で指定します。

boolean

バックアッププロバイダーによるリクエスト処理を許可するかどうか

true:（デフォルト）プライマリプロバイダー（または “order” で指定したカスタムプロバイダー）が利用できない場合、次に最適なプロバイダーを使用します。
false: プライマリまたはカスタムプロバイダーのみを使用し、利用できない場合は上流のエラーを返します。

`deny`, `allow`

データ収集の設定。要件を満たす利用可能なモデルプロバイダーがない場合、リクエストはエラーを返します。

allow:（デフォルト）ユーザーデータを一時的でない形で保存し、それを学習に使用する可能性があるプロバイダーを許可します。
deny: ユーザーデータを収集しないプロバイダーのみを使用します。

boolean

テキスト蒸留を許可しているモデルのみにルーティングを制限するかどうか。true の場合、作者が蒸留を許可しているモデルのみが使用されます。

`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[]

無視するプロバイダーのスラッグのリスト。指定した場合、このリストはこのリクエストに対してアカウント全体で無視するプロバイダー設定とマージされます。

object

このリクエストに対して支払う最大価格を指定するオブジェクト。プロンプトと補完の 100 万トークンあたりの USD 価格です。

string

100 万プロンプトトークンあたりの価格

string

100 万プロンプトトークンあたりの価格

string

100 万プロンプトトークンあたりの価格

string

100 万プロンプトトークンあたりの価格

string

100 万プロンプトトークンあたりの価格

許可するプロバイダーのスラッグのリスト。指定した場合、このリストはこのリクエストに対するアカウント全体の許可プロバイダー設定とマージされます。

プロバイダーのスラッグの順序付きリスト。ルーターは、このリストのうちリクエストされたモデルをサポートするサブセットの最初のプロバイダーを使用しようとし、利用できない場合は次のプロバイダーにフォールバックします。利用可能なプロバイダーがない場合、リクエストはエラーメッセージとともに失敗します。

number | object

希望する最大レイテンシ (秒単位)。数値 (p50 に適用) またはパーセンタイル別のしきい値を持つオブジェクトを指定できます。しきい値を超えるエンドポイントも引き続き使用される可能性がありますが、ルーティングでは優先度が下がります。フォールバックモデルを使用する場合、しきい値を満たしていればプライマリモデルの代わりにフォールバックモデルが使用されることがあります。

number | object

希望する最小スループット (1 秒あたりのトークン数)。数値 (p50 に適用) またはパーセンタイル別のしきい値を持つオブジェクトを指定できます。しきい値を下回るエンドポイントも引き続き使用される可能性がありますが、ルーティングでは優先度が下がります。フォールバックモデルを使用する場合、しきい値を満たしていればプライマリモデルの代わりにフォールバックモデルが使用されることがあります。

`int4`, `int8`, `fp4`, `fp6`, `fp8`, `fp16`, `bf16`, `fp32`, `unknown`[]

プロバイダーをフィルタする量子化レベルのリスト。

boolean

指定したパラメータをサポートするプロバイダーのみにフィルタするかどうか。この設定を省略するか false に設定した場合、プロバイダーはサポートするパラメータのみを受け取り、それ以外は無視します。

`price`, `throughput`, `latency`, `exacto` | object

このリクエストで使用する並び替え戦略 (“order” が指定されていない場合)。設定すると、負荷分散は行われません。

boolean

ルーティングを ZDR (Zero Data Retention、データ保持ゼロ) エンドポイントのみに制限するかどうか。true の場合、プロンプトを保持しないエンドポイントのみが使用されます。

object

推論モデルの構成オプション

`xhigh`, `high`, `medium`, `low`, `minimal`, `none`

推論モデルの推論にかける労力を制約します

string

指定可能な値: auto、concise、detailed

object

レスポンスフォーマットの構成

object

任意の型

integer

決定論的な出力のためのランダムシード

`auto`, `default`, `flex`, `priority`, `scale`

このリクエストの処理に使用するサービスティア。

string

可観測性のために関連するリクエスト (会話やエージェントワークフローなど) をグループ化するための一意の識別子。リクエストボディと x-session-id ヘッダーの両方で指定された場合、ボディの値が優先されます。最大 256 文字。

string | string[] | object

停止シーケンス (最大 4 個)

object[]

server-tool エージェントループの停止条件。いずれかの条件が発火するとループが停止します (OR ロジック)。設定すると、max_tool_calls を上書きします。

boolean

デフォルト:"false"

ストリーミングレスポンスを有効にする

object

ストリーミングの構成オプション

boolean

Deprecated: このフィールドは効果がありません。完全な使用状況の詳細は常に含まれます。

number

サンプリング温度 (0-2)Format: double

`none` | `auto` | `required` | object

ツール選択の設定

object[]

関数呼び出しで利用可能なツール

integer

返す上位ログ確率の数 (0-20)

number

ニュークリアスサンプリングパラメータ (0-1)Format: double

object

可観測性とトレーシングのためのメタデータ。既知のキー (trace_id、trace_name、span_name、generation_name、parent_span_id) は特別に処理されます。追加のキーはカスタムメタデータとして、設定されたブロードキャスト先にそのまま渡されます。

string

一意のユーザー識別子

Router が GET /v2/models/openrouter/chat-completions/openapi.json で提供するスキーマ、つまりリクエストがプロバイダーに到達する前に呼び出しを検証するのと同じドキュメントから生成済みです。

出力

object[]

必須

補完候補のリスト

string

必須

指定可能な値: tool_calls、stop、length、content_filter、error

integer

必須

候補のインデックス

object

補完の対数確率

object[]

必須

コンテンツトークンの対数確率

integer[]

必須

トークンの UTF-8 バイト列

number

必須

トークンの対数確率形式: double

string

必須

トークン

object[]

必須

確率付きの上位代替トークン

integer[]

必須

number

必須

形式: double

string

必須

object[]

拒否トークンの対数確率

integer[]

必須

トークンの UTF-8 バイト列

number

必須

トークンの対数確率形式: double

string

必須

トークン

object[]

必須

確率付きの上位代替トークン

integer[]

必須

number

必須

形式: double

string

必須

object

必須

リクエストとレスポンスのアシスタントメッセージ

object

オーディオ出力データまたは参照

string

Base64 エンコードされたオーディオデータ

integer

オーディオの有効期限タイムスタンプ

string

オーディオ出力の識別子

string

オーディオの文字起こし

string | object[] | object

アシスタントメッセージのコンテンツ

object[]

画像生成モデルによって生成された画像

object

必須

string

必須

生成された画像の URL または base64 エンコードされたデータ

string

アシスタントのオプション名

string

推論の出力

object[]

拡張思考モデルの推論の詳細

string

コンテンツが拒否された場合の拒否メッセージ

object[]

アシスタントが実行したツール呼び出し

object

必須

string

必須

JSON 文字列としての関数の引数

string

必須

呼び出す関数名

string

必須

ツール呼び出しの識別子

string

必須

指定可能な値: function

integer

必須

作成時の Unix タイムスタンプ

string

必須

一意の補完識別子

string

必須

補完に使用されたモデル

string

必須

指定可能な値: chat.completion

object

integer

必須

object[]

string

必須

string

必須

integer

必須

object

必須

object[]

必須

string

必須

string

必須

boolean

必須

integer

必須

boolean

必須

object

number

フォーマット: double

number

フォーマット: double

string

object[]

number

フォーマット: double

object

string

必須

string

必須

パイプラインステージのカテゴリ種別。複数のプラグインが同じ type を共有できます（例: guardrail レベルのプラグインはすべて guardrail を出力します）。どのプラグインが出力したかは name フィールドで区別します。指定可能な値: guardrail、plugin、server_tools、response_healing、context_compression

string

必須

string

必須

string

必須

指定可能な値: direct、auto、free、latest、alias、fallback、pareto、bodybuilder、fusion

string

必須

string

このリクエストに対して上流のプロバイダーが使用したサービス階層

string

必須

システムフィンガープリント

object

トークン使用量の統計

integer

必須

補完（completion）のトークン数

object

補完のトークン使用量の詳細

number

補完のコストフォーマット: double

object

上流の推論コストの内訳

number

必須

フォーマット: double

number

フォーマット: double

number

必須

フォーマット: double

boolean

リクエストが Bring Your Own Key 構成を使用して行われたかどうか

integer

必須

プロンプトのトークン数

object

プロンプトのトークン使用量の詳細

integer

必須

トークンの合計数

例

出力

{
  "choices": [
    {
      "finish_reason": "stop",
      "index": 0,
      "message": {}
    }
  ],
  "created": 1750000000,
  "id": "gen-0000000000-examplecompletion",
  "model": "anthropic/claude-sonnet-4.5",
  "object": "chat.completion",
  "system_fingerprint": null,
  "usage": {
    "completion_tokens": 128,
    "cost": 0.00123,
    "prompt_tokens": 42,
    "total_tokens": 170
  }
}

出荷前の確認

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 が現在対応していないことと、代替手段。

Comfy で開発する

ワークフローの実行

Comfy Router

Comfy CLI

仕様

Demo Apps

Comfy Router で Chat Completions を使用する

リクエストのセットアップ

スキーマ

入力

出力

例

出力

出荷前の確認

ヘッダー

Router API の利用

制限事項

​リクエストのセットアップ

​スキーマ

​入力

​出力

​例

​出力

​出荷前の確認

ヘッダー

Router API の利用

制限事項

リクエストのセットアップ

スキーマ

入力

出力

例

出力

出荷前の確認