> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Comfy Router API リファレンス

> Comfy API 契約から生成済みの、Comfy Router のすべてのエンドポイント、パラメータ、レスポンスボディ、エラーバケット。

モデル ID でアドレス指定される Comfy Router の正規ルート。

ベース URL: `https://api.comfy.org`

以下のすべてのエンドポイントは認証が必要です。`X-API-Key: <api-key>` または `Authorization: Bearer <jwt>` を送信してください。

Comfy API キーは Bearer トークンとして送信することもできます。両方の認証ヘッダーが指定された場合、`X-API-Key` が優先されます。キーと JWT の違いについては[認証ヘッダー](https://docs.comfy.org/ja/development/comfy-router/headers.md#リクエストヘッダー)を、アクセス要件については[クイックスタート](https://docs.comfy.org/ja/development/comfy-router/quickstart.md)を参照してください。

## エンドポイント

### `GET /v2/models`

**Comfy Router が実行できるモデルを一覧表示します。**

利用可能なモデル ID と課金情報を一覧表示します。`has_more` が true の間は `next_cursor` を使用してください。

**パラメータ**

**cursor** `RouterPageCursor`

不透明なページネーションカーソル。

型: [`RouterPageCursor`](#routerpagecursor) -- `next_cursor` として返される不透明なカーソル、1–512 文字

**limit** `integer`

1 ページで返すモデル数。

最大 100、デフォルト: 20

**If-None-Match** `string`

呼び出し元が以前の `200` から保持している `ETag`。

**レスポンス**

**200** `RouterModelListResponse`

OK - モデルカタログの 1 ページ。

本文: [`RouterModelListResponse`](#routermodellistresponse) -- ヘッダー: `X-Comfy-Request-Id`, `ETag`, `Cache-Control`

**304** `no body`

Not Modified - `If-None-Match` で呼び出し元が送信した `ETag` 以降、ページは変更されていません。

ヘッダー: `X-Comfy-Request-Id`, `ETag`, `Cache-Control`

**400** `RouterErrorResponse`

無効なリクエストです。エラータイプとリクエスト本文を確認してください。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`

**401** `RouterErrorResponse`

認証情報が不足しているか無効です。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`

**403** `RouterErrorResponse`

この呼び出し元またはモデルでは、このリクエストは許可されていません。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`

**429** `RouterErrorResponse`

`rate_limited`: 呼び出し元ごとのリクエスト許容量を使い切りました。次のリクエストを送信する前に `Retry-After` を待ってください。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`, `Retry-After`

**503** `RouterErrorResponse`

Router は一時的に利用できません。バックオフを伴って再試行してください。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`

### `GET /v2/models/{provider}/{model}`

**正規のモデル ID を指定して、1 つのパートナーモデルのカタログエントリを取得します。**

カタログ全体を一覧せずに、1 つのモデルの詳細を取得します。

**パラメータ**

**provider** `RouterProviderSegment` *required*

正規の `{provider}/{model}` モデル ID のプロバイダー部分。

型: [`RouterProviderSegment`](#routerprovidersegment) -- 英数字スラッグ（例: `anthropic`）、最大 64 文字

**model** `RouterModelSegment` *required*

正規の `{provider}/{model}` モデル ID のモデル部分。

型: [`RouterModelSegment`](#routermodelsegment) -- 英数字スラッグ（例: `claude-opus-4-6`）、最大 128 文字

**If-None-Match** `string`

呼び出し元が以前の `200` で受け取った `ETag`。

**レスポンス**

**200** `RouterModelDetail`

OK - モデルのカタログエントリ。

ボディ: [`RouterModelDetail`](#routermodeldetail) -- ヘッダー: `X-Comfy-Request-Id`, `ETag`, `Cache-Control`

**304** `no body`

Not Modified - 呼び出し元が `If-None-Match` で送信した `ETag` 以降、エントリは変更されていません。

ヘッダー: `X-Comfy-Request-Id`, `ETag`, `Cache-Control`

**401** `RouterErrorResponse`

認証情報が不足しているか無効です。

ボディ: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`

**403** `RouterErrorResponse`

この呼び出し元またはモデルでは、このリクエストは許可されていません。

ボディ: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`

**404** `RouterErrorResponse`

モデル ID が見つかりませんでした。

ボディ: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`

**429** `RouterErrorResponse`

`rate_limited`: 呼び出し元ごとのリクエスト許容量を使い切っています。次のリクエストを送信する前に `Retry-After` を待ってください。

ボディ: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`, `Retry-After`

**503** `RouterErrorResponse`

Router は一時的に利用できません。バックオフを伴って再試行してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`

### `POST /v2/models/{provider}/{model}`

**正規のモデル ID を指定してパートナーモデルを同期的に実行します。**

モデルを実行し、同じレスポンスでその完了済みの結果を受け取ります。

**パラメータ**

**provider** `RouterProviderSegment` *required*

正規の `{provider}/{model}` モデル ID のプロバイダー部分。

型: [`RouterProviderSegment`](#routerprovidersegment) -- 英数字のスラッグ（例: `anthropic`）、最大 64 文字

**model** `RouterModelSegment` *required*

正規の `{provider}/{model}` モデル ID のモデル部分。

型: [`RouterModelSegment`](#routermodelsegment) -- 英数字のスラッグ（例: `claude-opus-4-6`）、最大 128 文字

**Idempotency-Key** `string`

呼び出し側が生成するキーで、1 つの論理的な呼び出しを安全に再試行できるようにします。

1〜255 文字

**model\_provider** `string`

このモデルを提供する代替プロバイダーを、現在のデフォルトの代わりに選択します。`fal`、`wavespeed`、`runware`、`higgsfield` が代替プロバイダーであり、`GET /v2/models/{provider}/{model}` は、あるモデルがそのうちどれをサポートしているかを報告します。拒否は固定の順序で検査され、前のものが後ろのものに該当するかどうかに関係なく応答します。認識できない値（登録済みプロバイダーではないもの）は `400` で拒否されます。次に、ボディがマルチパート操作（編集）を選択しているリクエストで代替プロバイダーを指定した場合、`detail` が "this request's `image` selects the edit operation" で始まる `409` で拒否されます。ただし、そのプロバイダーのこのモデル用トランスレーターがその操作を処理できない場合に限ります。トランスレーターがメディアを扱えるレッグは通常どおり処理されます。次に、bring-your-own-key の認証情報を解決したリクエストでは、そのプロバイダーがこのモデルを提供しているかどうかに関係なく、`detail` が `this request resolved a BYOK credential` で始まる `409` で代替プロバイダーが拒否されます（そのレスポンスを参照）。次に、指定されたプロバイダー自身のゲートがあり、そのプロバイダーがあなたに対して有効になっていない場合は `error_type: not_enabled` を伴う `403` で、ゲートを評価できない場合は `error_type: service_unavailable` を伴う `503` で拒否します。そしてこれら 4 つすべてを通過した後にのみ、このモデル用のレッグを持たない実在のプロバイダーが `error_type: invalid_input` を伴う `400` で拒否されます。これは認識できない値と同じ応答です。`fallback_provider` は、bring-your-own-key リクエスト、ボディがマルチパート操作を選択しているリクエスト、および `strict_mode=true` の下では、拒否されるのではなく無効になります。

**strict\_mode** `boolean`

`model_provider` と組み合わせた場合にのみ意味があります。

デフォルト: False

**fallback\_provider** `string`

最初の試行が Router または試行したプロバイダーに起因する理由で失敗した場合に、Router がこの呼び出しをモデルの他の登録済みプロバイダーに対して再試行するかどうかを制御します。省略した場合、または `false` 以外の値はフォールバックを有効のままにします。`false` は無効にします。フォールバックが成功したレスポンスには `X-Comfy-Router-Fallback-Provider` が付与されます。bring-your-own-key の認証情報を解決したリクエストでは、このパラメータが何を言っていてもフォールバックは利用できません。試行は単に行われず、最初の失敗がそのまま返されます。これは拒否ではなく無効です。ここから `409` が発生することはありません。同じ理由で、ボディがマルチパート操作を選択しているリクエストや `strict_mode=true` の場合も同様です。いずれも呼び出しを 1 つのプロバイダーに結びつけ、別のプロバイダーに対して忠実に再現することはできないため、フォールバックは拒否されるのではなく単にスキップされます。その `409` で拒否されるのは明示的な `model_provider` のみであり、この無条件のスキップとは異なり、そのマルチパートの `409` はトランスレーターがその操作を処理できないレッグにのみ適用されます。

**reject\_unknown\_fields** `boolean`

このモデルの入力スキーマが宣言していないトップレベルのリクエストボディフィールドを、受け入れるのではなく拒否することを選択します。ネストされたフィールドはチェックされず、宣言されていないフィールドを許可するスキーマを持つモデル、または作成済みスキーマを持たないモデルの場合は何も拒否されず、`strict_mode=true` で送信されるキュー中の送信でも何も拒否されません。

デフォルト: False

**リクエストボディ**

`application/json` -- [`RouterModelInput`](#routermodelinput)（必須）パートナーモデルのネイティブ JSON 入力。`model_provider` を指定しない場合、このボディはモデル自身のネイティブスキーマであり、モデル自身のプロバイダーが呼び出しを処理するときは呼び出し元の `strict_mode` は何も変更しません。Comfy Router 自体がそのような呼び出しを別のプロバイダーにルーティングする場合、Router はそのプロバイダー向けにボディを変換しますが、そこでの `strict_mode` の適用方法はこの契約の範囲外です。`model_provider` で代替プロバイダーを選択し、かつ `strict_mode=false`（デフォルト）の場合、ボディは送信前にそのプロバイダーの実際のスキーマへ変換されます。正確に表現できないネイティブフィールドは破棄され、レスポンスの `X-Comfy-Router-Dropped-Params` ヘッダーで開示されます。決して暗黙に処理されることはありません。`model_provider` で代替プロバイダーを選択し、かつ `strict_mode=true` の場合は変換は実行されません。ボディはこのモデルのネイティブスキーマではなく、すでにその代替プロバイダー自身の実際のスキーマである必要があり（`strict_mode` を参照）、そのまま転送されます。ボディ自体のフィールドは、複数の操作をサポートするモデルで Router が実行する操作も選択します。編集可能な画像モデルの場合、入力画像を含めるとテキストから画像への操作から画像から画像へ（編集）の操作に切り替わり、こちらは独自のレートで課金される場合があります。Seedance ビデオモデルの場合、`content[].role` が操作を選択します（最初のフレームの画像は画像から動画へ、参照画像またはクリップは参照から動画を選択します）。モデル自身のプロバイダーが呼び出しを処理する場合、Seedance の課金は役割ではなく `content` 内のメディア種別に従います。ビデオ入力が少しでもあるリクエストは動画から動画へとして課金され、そうでなければ画像が少しでもあるものは画像から動画へとして、それもなければテキストから動画へとして課金されます。ただし `draft_task` 項目からの最終レンダーは、それがレンダリングする Draft の操作として課金されます。テキストから動画と画像から動画に同じレートを課金するモデルもあります。`model_provider` で代替プロバイダーを選択している場合、または Comfy Router が別のプロバイダーで呼び出しを処理する場合、条件付きの各操作はそのプロバイダー独自のレートで課金される場合があります。

**レスポンス**

**200** `RouterModelOutput`

OK - `model_provider` を指定しない場合、または `model_provider` と `strict_mode=false`（デフォルト。可能な場合はこのモデルのネイティブ契約に変換して戻され、変換に失敗した場合は代替プロバイダー自身の生のレスポンスにフォールバックします。ログに記録され、決して暗黙には処理されません）の場合、形状はこのモデル自身のネイティブ出力です。`strict_mode=true` の場合は、代替プロバイダーのレスポンスがそのまま返されます。パートナーが生成結果を直接バイトとして返すモデルの場合、ボディは `application/json` ではなくパートナー自身の `Content-Type` を持つそれらのバイトです。レスポンスの `Content-Type` で分岐し、JSON ドキュメントを前提としないでください。

Body: [`RouterModelOutput`](#routermodeloutput) or raw bytes (`*/*`) -- Headers: `X-Comfy-Request-Id`, `X-Content-Type-Options`, `X-Comfy-Router-Fallback-Provider`, `X-Comfy-Router-Provider`, `X-Comfy-Router-Dropped-Params`, `X-Comfy-Credits-Used`, `Idempotent-Replayed`, `X-Committed-Spend-Limit`, `X-Committed-Spend-Current`, `X-Committed-Spend-Remaining`

**400** `RouterErrorResponse`

無効なリクエストです。エラータイプとリクエストボディを確認してください。

Body: [`RouterErrorResponse`](#routererrorresponse) -- Headers: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`, `X-Comfy-Upstream-Status`, `X-Comfy-Upstream-Detail`, `X-Comfy-Refusal-Subject`, `X-Comfy-Credits-Used`, `Idempotent-Replayed`

**401** `RouterErrorResponse`

認証情報が不足しているか無効です。

Body: [`RouterErrorResponse`](#routererrorresponse) -- Headers: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`

**402** `RouterErrorResponse`

Router のリクエストレベルの失敗。リクエストがモデルに到達しなかったか、モデル自体が報告しなかった理由で失敗しました。

Body: [`RouterErrorResponse`](#routererrorresponse) -- Headers: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`

**403** `RouterErrorResponse`

この呼び出し元またはモデルに対してリクエストは許可されていません。

Body: [`RouterErrorResponse`](#routererrorresponse) -- Headers: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`

**404** `RouterErrorResponse`

モデル ID が見つかりませんでした。

Body: [`RouterErrorResponse`](#routererrorresponse) -- Headers: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`

**409** `RouterErrorResponse`

`X-Comfy-Error-Type` を確認してください。`concurrency_limit_exceeded` はオリジナルの呼び出しがまだ実行中であることを意味するため、`Retry-After` を待って同じキーを再利用してください。`invalid_input` の場合は新しいキーが必要です。このルートでの 2 種類の `invalid_input` 競合はキーとは全く関係がなく、新しいキーでもどちらも解決しません。1 つは、`model_provider` が代替プロバイダーを指定していても、リクエストボディがそのプロバイダーのこのモデル用トランスレーターでは処理できないマルチパート操作（編集）を選択している場合に拒否されるもので、`detail` は "this request's `image` selects the edit operation" で始まります。もう 1 つはその後でチェックされ、リクエストがすでにパス内のプロバイダーに対する bring-your-own-key 認証情報を解決している場合で、`detail` は `this request resolved a BYOK credential` で始まります。`model_provider` を外すか、BYOK 認証情報なしで（マルチパートの場合は編集もなしで）リクエストを送信してください。

Body: [`RouterErrorResponse`](#routererrorresponse) -- Headers: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`, `Retry-After` (`concurrency_limit_exceeded` の場合)

**413** `RouterErrorResponse`

リクエストボディが大きすぎます。

Body: [`RouterErrorResponse`](#routererrorresponse) -- Headers: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`

**422** `RouterValidationErrorResponse`

リクエストの内容がモデルのスキーマに対して拒否されました。

Body: [`RouterValidationErrorResponse`](#routervalidationerrorresponse) -- Headers: `X-Comfy-Error-Type`, `X-Comfy-Request-Id`, `Idempotent-Replayed`

**429** `RouterErrorResponse`

`X-Comfy-Error-Type` を確認してください。`concurrency_limit_exceeded` は実行中の呼び出しを減らすことを意味し、`rate_limited` は `Retry-After` を待つことを意味します。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`X-Committed-Spend-Limit`、`X-Committed-Spend-Current`、`X-Committed-Spend-Remaining`、`X-Model-Concurrency-Limit`、`X-Model-Concurrency-Current`、`X-Model-Concurrency-Remaining`、`Retry-After`（`rate_limited` の場合）

**502** `RouterErrorResponse`

プロバイダー自身のレスポンスを結果に変換できませんでした（`provider_error`）。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`X-Comfy-Upstream-Status`、`Retry-After`（ポーリング側で生成が未解決のまま終了した場合）

**503** `RouterErrorResponse`

Router は一時的に利用できません。バックオフを伴って再試行してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`Retry-After`（容量不足による拒否の場合のみ）

**504** `RouterErrorResponse`

リクエストがデッドラインを超過しました。再試行する前にエラーの種類を確認してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`X-Comfy-Upstream-Status`、`Retry-After`

### `POST /v2/models/{provider}/{model}/estimate`

**実行せずに、モデル呼び出しの価格を見積もります。**

このボディをこのモデルで実行した場合にいくらかかるかを、米ドルで事前に見積もって返します。価格は Comfy の標準定価で算出されます（ベンダーが報告するコストで課金されるモデルは、代わりにベンダーの公開価格表から見積もられます）。契約や顧客固有のレートは反映されません。価格交渉を行っているワークスペースには定価が提示され、契約レートで課金されます。その場合 `source: exact` は定価に対して正確という意味であり、そのワークスペースの請求額に対して正確という意味ではありません。これは見積もりであり、最終的な請求額ではありません。実際に支払うのは、ワークスペースの使用状況および請求記録に確定した請求額です。ボディはまずモデルの入力スキーマに対して検証されます。デフォルトの実行（`strict_mode` なし、`reject_unknown_fields` なし）が検証するのと同じ方法です。そのため、モデルのスキーマに適合しないボディは、実行時と同じ `422` になります。プロバイダーには何もディスパッチされず、課金も発生しません。この応答は価格の固定ではありません。`pricing_as_of` の時点で有効なレートで見積もられ、実行はレートが適用された時点で有効なレートで課金されます。デプロイメントで見積もりが無効になっている場合、このルートは `error_type: not_enabled` を伴う `403` を返します。Router がまだ実行できないモデルは、実行ルート自身の `detail` を伴う同じ `403` を返すため、両者を区別するには `detail` を読んでください。ボディは Router がディスパッチするのと同じ形で価格が算出されます。指定された `model_provider` のレグ向けに変換され、実行されるオペレーションにリターゲットされます。その順序は、キュー中の送信の `201` に含まれる `estimate` と同じです。ただし、その `estimate` は事前の価格ではありません。実行が受け付けられてキューに入った後にのみ返され、その実行はディスパッチ前にキャンセルされない限り課金されます。

**パラメータ**

**provider** `RouterProviderSegment` *required*

正規の `{provider}/{model}` モデル ID の小文字のプロバイダーセグメント。実行されるモデルのパートナーです。

型: [`RouterProviderSegment`](#routerprovidersegment)。英数字スラッグ（例: `anthropic`）、最大 64 文字

**model** `RouterModelSegment` *required*

正規の `{provider}/{model}` モデル ID の小文字のモデルセグメント。そのプロバイダー内で実行するモデルです。

型: [`RouterModelSegment`](#routermodelsegment)。英数字スラッグ（例: `claude-opus-4-6`）、最大 128 文字

**model\_provider** `string`

現在のデフォルトの代わりに、このモデルを提供する代替プロバイダーを選択します。

**リクエストボディ**

`application/json` -- [`RouterModelInput`](#routermodelinput)（必須）

パートナーモデルのネイティブな JSON 入力で、このモデルに対して同期ルートが受け付けるボディと同一です。デフォルトの実行が検証するのと同じ方法でモデル自身の入力スキーマに対して検証され（このルートは `strict_mode` や `reject_unknown_fields` を取りません）、自身のフィールド（出力数、入力画像が選択するオペレーション）が価格算出の対象を決めます。

**レスポンス**

**200** `RouterCostEstimate`

見積もり結果。

ボディ: [`RouterCostEstimate`](#routercostestimate)。ヘッダー: `X-Comfy-Request-Id`

**400** `RouterErrorResponse`

無効なリクエストです。エラータイプとリクエストボディを確認してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**401** `RouterErrorResponse`

認証情報が不足しているか無効です。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**403** `RouterErrorResponse`

この呼び出し元またはモデルに対してリクエストは許可されていません。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**404** `RouterErrorResponse`

モデル ID が見つかりませんでした。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**413** `RouterErrorResponse`

リクエストボディが大きすぎます。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**422** `RouterValidationErrorResponse`

見積もりのボディがモデルのスキーマに対して拒否されたか、パスとは異なるモデルを指定しました。

ボディ: [`RouterValidationErrorResponse`](#routervalidationerrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**429** `RouterErrorResponse`

`rate_limited`: 呼び出し元ごとのリクエスト許容量を使い切りました。次のリクエストを送る前に `Retry-After` を待ってください。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`Retry-After`

**503** `RouterErrorResponse`

Router は一時的に利用できません。バックオフして再試行してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`Retry-After`（容量拒否時のみ）

**504** `RouterErrorResponse`

リクエストが期限を超過しました。再試行する前にエラータイプを確認してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

### `GET /v2/models/{provider}/{model}/openapi.json`

**1つのパートナーモデルの入力スキーマと出力スキーマを OpenAPI ドキュメントとして読み取ります。**

1つのモデルの入力スキーマと出力スキーマを、単体の OpenAPI ドキュメントとして読み取ります。

**パラメータ**

**provider** `RouterProviderSegment` *required*

正規の `{provider}/{model}` モデル ID のうちプロバイダー部分。

型: [`RouterProviderSegment`](#routerprovidersegment)。英数字スラッグ（例: `anthropic`）、最大64文字

**model** `RouterModelSegment` *required*

正規の `{provider}/{model}` モデル ID のうちモデル部分。

型: [`RouterModelSegment`](#routermodelsegment)。英数字スラッグ（例: `claude-opus-4-6`）、最大128文字

**If-None-Match** `string`

呼び出し元が以前の `200` から保持している `ETag`。

**レスポンス**

**200** `RouterModelInputSchemaDocument`

OK。モデルの入力スキーマと出力スキーマを、単体の OpenAPI ドキュメントとして返します。

ボディ: [`RouterModelInputSchemaDocument`](#routermodelinputschemadocument)。ヘッダー: `X-Comfy-Request-Id`、`ETag`、`Cache-Control`

**304** `no body`

Not Modified。呼び出し元が `If-None-Match` で送信した `ETag` 以降、ドキュメントは変更されていません。

ヘッダー: `X-Comfy-Request-Id`、`ETag`、`Cache-Control`

**401** `RouterErrorResponse`

認証情報が不足しているか無効です。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**403** `RouterErrorResponse`

この呼び出し元またはモデルでは、このリクエストは許可されていません。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**404** `RouterErrorResponse`

モデル ID が見つかりませんでした。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**500** `RouterErrorResponse`

Router がリクエストを完了できませんでした。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**429** `RouterErrorResponse`

`rate_limited`: 呼び出し元ごとのリクエスト許可量を使い切っています。次のリクエストを送信する前に `Retry-After` の時間だけ待機してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`Retry-After`

**503** `RouterErrorResponse`

Router は一時的に利用できません。バックオフを伴って再試行してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

### `POST /v2/models/{provider}/{model}/requests`

**パートナーモデルの実行をキューに送信し、すぐに戻ります。**

Comfy Router のキュー配信モードです。リクエストボディは、`POST /v2/models/{provider}/{model}` がこのモデルに対して受け入れるものと同じパートナーネイティブの JSON 入力です（1 つのボディ形状、モデルごとに 1 つのスキーマ、2 つの配信モード）。ただし、このルートは結果のために接続を保持しません。実行を受理し、ハンドル付きで `201` を返します。呼び出し元は後で、以下の 3 つの読み取りを通じて結果を収集します。

**パラメータ**

**provider** `RouterProviderSegment` *required*

正規の `{provider}/{model}` モデル ID の小文字のプロバイダーセグメント。実行対象のモデルを持つパートナーです。

型: [`RouterProviderSegment`](#routerprovidersegment)。英数字スラッグ（例: `anthropic`）、最大 64 文字

**model** `RouterModelSegment` *required*

正規の `{provider}/{model}` モデル ID の小文字のモデルセグメント。そのプロバイダー内で実行するモデルです。

型: [`RouterModelSegment`](#routermodelsegment)。英数字スラッグ（例: `claude-opus-4-6`）、最大 128 文字

**model\_provider** `string`

このモデルを提供する代替プロバイダーを、現在のデフォルトの代わりに選択します。

**strict\_mode** `boolean`

`model_provider` と併用した場合にのみ意味があります。

デフォルト: False

**Idempotency-Key** `string`

呼び出し元が生成するキーで、1 つの論理呼び出しの再試行を安全にします。

1〜255 文字

**reject\_unknown\_fields** `boolean`

このモデルの入力スキーマが宣言していないトップレベルのリクエストボディフィールドを、受け入れるのではなく拒否することを選択します。ネストされたフィールドはチェックされず、スキーマが未宣言のフィールドを許可しているモデル、または作成済みスキーマがないモデルでは何も拒否されません。また、`strict_mode=true` を指定してキューに送信する場合も、何も拒否されません。

デフォルト: False

**リクエストボディ**

`application/json`、[`RouterModelInput`](#routermodelinput)（必須）

パートナーモデルのネイティブ JSON 入力で、このモデルに対して同期ルートが受け入れるボディと同じです。この入力は操作を選択し、同じ方法で課金されます。ボディ自体のフィールドが、複数の操作をサポートするモデルで Router が実行する操作を選択します（入力画像は編集可能な画像モデルを画像から画像へ切り替え、これは独自のレートで課金される場合があります。Seedance の最初のフレーム画像は画像から動画への操作を選択し、参照画像またはクリップは参照から動画の操作を選択します）。モデル自身のプロバイダーが呼び出しを処理する場合、Seedance リクエストはロールではなく `content` 内のメディア種別に基づいて課金されます。ビデオ入力がある場合は動画から動画へとして課金され、そうでなければ画像がある場合は画像から動画へとして、それもなければテキストから動画へとして課金されます。ただし、`draft_task` 項目からの最終レンダーは、それがレンダリングする Draft の操作として課金されます。一部のモデルでは、テキストから動画へと画像から動画へに同じレートを課金します。`model_provider` で代替プロバイダーを選択した場合、または Comfy Router が別のプロバイダーで呼び出しを処理する場合、条件付きの各操作はそのプロバイダー独自のレートで課金される場合があります。同じプロバイダー選択の契約がディスパッチ時に適用されます。`model_provider` を指定しない場合、または `model_provider` を指定して `strict_mode=false`（デフォルト）にする場合は、ボディはモデルのネイティブドキュメントであり、実行が受理される前にモデル自身の入力スキーマに対して検証されます。そのため、モデルが拒否するボディは、数分後に失敗するキュー中のリクエストではなく、ここで `422` になります。非厳格モードの代替プロバイダーのボディは、ディスパッチ時にそのプロバイダーの実際のスキーマへ追加で変換されます。`strict_mode=true` の場合、ボディはすでに代替プロバイダー自身のスキーマである必要があり、変更されずに転送されます。ネイティブスキーマの検証は、同期ルートの場合とまったく同様にスキップされます（`model_provider` と `strict_mode` を参照）。

**レスポンス**

**201** `RouterQueueSubmitResponse`

作成済み。実行はキューに受理されました。

ボディ: [`RouterQueueSubmitResponse`](#routerqueuesubmitresponse)、ヘッダー: `X-Comfy-Request-Id`、`Idempotent-Replayed`、`X-Comfy-Router-Dropped-Params`

**401** `RouterErrorResponse`

認証情報が不足しているか無効です。

ボディ: [`RouterErrorResponse`](#routererrorresponse)、ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**400** `RouterErrorResponse`

無効なリクエストです。エラータイプとリクエストボディを確認してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse)、ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**413** `RouterErrorResponse`

リクエストボディが大きすぎます。

ボディ: [`RouterErrorResponse`](#routererrorresponse)、ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**402** `RouterErrorResponse`

Router のリクエストレベルの失敗。リクエストがモデルに到達しなかったか、モデル自体が報告しなかった理由で失敗しました。

ボディ: [`RouterErrorResponse`](#routererrorresponse)、ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**403** `RouterErrorResponse`

この呼び出し元またはモデルでは、このリクエストは許可されていません。パートナーが生成結果をバイトとして直接返すモデルはまだキューに登録できず、`not_enabled` で拒否されます。代わりに同期ルートで実行してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse)、ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**404** `RouterErrorResponse`

モデル ID が見つかりませんでした。

ボディ: [`RouterErrorResponse`](#routererrorresponse)、ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**409** `RouterErrorResponse`

`X-Comfy-Error-Type` を確認してください。`concurrency_limit_exceeded` はオリジナルの呼び出しがまだ実行中であることを意味するため、`Retry-After` の時間だけ待って同じキーを再利用します。`invalid_input` の場合は新しいキーが必要です。このルートにおける 2 つの `invalid_input` 競合はキーに関するものではなく、新しいキーを発行してもどちらも解消されません。`model_provider` で代替プロバイダーを指定している場合、リクエストボディがそのプロバイダーのこのモデル向けトランスレーターでは処理できないマルチパート操作（編集）を選択していると拒否され、その `detail` は「this request's `image` selects the edit operation」で始まります。また、その後チェックされる条件として、リクエストがパス内のプロバイダー向けの bring-your-own-key 認証情報をすでに解決済みの場合にも拒否され、その `detail` は `this request resolved a BYOK credential` で始まります。`model_provider` を削除するか、BYOK 認証情報なしで、かつ（マルチパートの場合は）編集なしでリクエストを送信してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse)、ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`Retry-After`（`concurrency_limit_exceeded` の場合）

**422** `RouterValidationErrorResponse`

リクエストの内容がモデルのスキーマに照らして拒否されました。

ボディ: [`RouterValidationErrorResponse`](#routervalidationerrorresponse)、ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`Idempotent-Replayed`

**429** `RouterErrorResponse`

`X-Comfy-Error-Type` を確認してください。`queue_backlog_full` は、許可されている数まで未完了のキュー中のリクエストをすでに保持していることを意味するため、そのうち 1 つが完了してから再度送信してください。`rate_limited` は `Retry-After` に示された秒数だけ待つことを意味します。

ボディ: [`RouterErrorResponse`](#routererrorresponse)、ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`Retry-After`（`rate_limited` の場合）

**503** `RouterErrorResponse`

Router は一時的に利用できません。バックオフを伴って再試行してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse)、ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`Retry-After`（容量拒否の場合のみ）

**504** `RouterErrorResponse`

リクエストが期限を超過しました。再試行する前にエラータイプを確認してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse)、ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

### `GET /v2/models/{provider}/{model}/requests/{request_id}`

**送信された 1 件のリクエストの結果を収集します。**

収集エンドポイントです。正常に完了したリクエストでは、パートナーモデル自身のネイティブ出力を、同じモデルと同じ入力に対して同期ルートの `200` が返す内容とバイト単位でそのまま返します。つまり、2 つの配信モードは 1 つの結果形状を生成し、呼び出し元は 2 つ目のパーサーなしでそれらの間を切り替えられます。

**パラメータ**

**provider** `RouterProviderSegment` *required*

正規の `{provider}/{model}` モデル ID の小文字のプロバイダーセグメント。実行対象のモデルを持つパートナーです。

型: [`RouterProviderSegment`](#routerprovidersegment) -- 英数字のスラッグ（例: `anthropic`）、最大 64 文字

**model** `RouterModelSegment` *required*

正規の `{provider}/{model}` モデル ID の小文字のモデルセグメント。そのプロバイダー内で実行するモデルです。

型: [`RouterModelSegment`](#routermodelsegment) -- 英数字のスラッグ（例: `claude-opus-4-6`）、最大 128 文字

**request\_id** `RouterQueueRequestId` *required*

対象とするキュー中のリクエスト。送信時にレスポンス本文で返された `request_id` です。

型: [`RouterQueueRequestId`](#routerqueuerequestid) -- `pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`、uuid、最大 36 文字

**レスポンス**

**200** `RouterModelOutput`

OK - 結果を生成したリクエスト（正常に完了したリクエスト、または記録された課金と保存された結果の両方を持つターミナル状態のリクエスト）に対して保存された結果を、パートナー自身のメディアタイプで変更せずに返します。同期ルートの `200` が返すのとまったく同じで、送信時に受け入れたものと同じプロバイダー選択契約に従います。`model_provider` がない場合、または `model_provider` があり `strict_mode=false`（デフォルト。可能な場合はこのモデルのネイティブ契約に変換され、変換に失敗した場合は代替プロバイダー自身の生のレスポンスにフォールバックします。ログに記録され、決してサイレントにはなりません）の場合は、形状はこのモデル自身のネイティブ出力です。`strict_mode=true` の場合は、代替プロバイダーのレスポンスが変更されずに返されます。パートナーが生成結果を直接バイトとして返すモデルの場合、本文は `application/json` ではなく、パートナー自身の `Content-Type` の下のそれらのバイトです。レスポンスの `Content-Type` で分岐し、JSON ドキュメントを想定しないでください。

本文: [`RouterModelOutput`](#routermodeloutput) または生のバイト (`*/*`) -- ヘッダー: `X-Comfy-Request-Id`、`X-Content-Type-Options`、`X-Comfy-Credits-Used`

**202** `RouterQueueStatusResponse`

Accepted - リクエストはまだ完了していません。

本文: [`RouterQueueStatusResponse`](#routerqueuestatusresponse) -- ヘッダー: `X-Comfy-Request-Id`、`Retry-After`

**401** `RouterErrorResponse`

認証情報が不足しているか無効です。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**403** `RouterErrorResponse`

この呼び出し元またはモデルでは、このリクエストは許可されていません。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**404** `RouterErrorResponse`

モデル ID が見つかりませんでした。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**410** `RouterErrorResponse`

Router のリクエストレベルの失敗。リクエストがモデルに到達しなかったか、モデル自体が報告しなかった理由で失敗しました。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**429** `RouterErrorResponse`

`rate_limited`: 呼び出し元ごとのリクエスト許可量を使い果たしました。次のリクエストを送信する前に `Retry-After` を待ってください。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`Retry-After`

**503** `RouterErrorResponse`

Router は一時的に利用できません。バックオフして再試行してください。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**409** `RouterErrorResponse`

リクエストは操作と競合する状態にあります。エラータイプを確認してください。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**504** `RouterErrorResponse`

リクエストが期限を超過しました。再試行する前にエラータイプを確認してください。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**default** `RouterErrorResponse`

Router のリクエストレベルの失敗。リクエストがモデルに到達しなかったか、モデル自体が報告しなかった理由で失敗しました。

本文: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

### `PUT /v2/models/{provider}/{model}/requests/{request_id}/cancel`

**送信済みのリクエスト 1 件のキャンセルを要求します。**

Comfy に、まだ完了していないリクエストを停止するよう要求します。これは要求であり保証ではありません。`202` はまさにそれを示します。`CANCELLATION_REQUESTED` は要求が受理されたことを意味し、実行が停止したことを意味しません。パートナー側ですでに実行中の処理は、そのまま完了する可能性があります。また、パートナーでの生成は完了すれば、誰が結果を取得したかに関係なく課金されます。そのため、実際に何が起きたかを知る必要がある呼び出し元は、後からステータスエンドポイントを参照します。そこでは、キャンセルが反映された場合、他のすべてのターミナル結果と同様に、`error_type` を持つ `COMPLETED` になります。

**パラメータ**

**provider** `RouterProviderSegment` *required*

正規の `{provider}/{model}` モデル ID の小文字プロバイダーセグメント。モデルを実行するパートナーです。

型: [`RouterProviderSegment`](#routerprovidersegment)。英数字スラッグ、例: `anthropic`、最大 64 文字

**model** `RouterModelSegment` *required*

正規の `{provider}/{model}` モデル ID の小文字モデルセグメント。そのプロバイダー内で実行するモデルです。

型: [`RouterModelSegment`](#routermodelsegment)。英数字スラッグ、例: `claude-opus-4-6`、最大 128 文字

**request\_id** `RouterQueueRequestId` *required*

対象となるキュー中のリクエスト。送信時に本文で返された `request_id` です。

型: [`RouterQueueRequestId`](#routerqueuerequestid)。`pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`、uuid、最大 36 文字

**レスポンス**

**202** `RouterQueueCancelResponse`

受理: `CANCELLATION_REQUESTED`。

本文: [`RouterQueueCancelResponse`](#routerqueuecancelresponse)。ヘッダー: `X-Comfy-Request-Id`

**409** `RouterQueueCancelResponse`

競合: `ALREADY_COMPLETED`。

本文: [`RouterQueueCancelResponse`](#routerqueuecancelresponse)。ヘッダー: `X-Comfy-Request-Id`

**400** `RouterErrorResponse`

無効なリクエストです。エラータイプとリクエスト本文を確認してください。

本文: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**401** `RouterErrorResponse`

認証情報が不足しているか、無効です。

本文: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**403** `RouterErrorResponse`

この呼び出し元またはモデルでは、リクエストは許可されていません。

本文: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**404** `RouterErrorResponse`

モデル ID が見つかりませんでした。

本文: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**429** `RouterErrorResponse`

`rate_limited`: 呼び出し元ごとのリクエスト許可量を使い切りました。次のリクエストを送信する前に `Retry-After` を待ってください。

本文: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`Retry-After`

**503** `RouterErrorResponse`

Router は一時的に利用できません。バックオフしながら再試行してください。

本文: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**default** `RouterErrorResponse`

Router のリクエストレベルの失敗。リクエストがモデルに到達しなかったか、モデル自体が報告しなかった理由で失敗しました。

本文: [`RouterErrorResponse`](#routererrorresponse)。ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

### `GET /v2/models/{provider}/{model}/requests/{request_id}/status`

**送信済みリクエスト1件のキューの状態を読み取ります。**

ポーリング用エンドポイントです。リクエストの現在の状態を返し、結果は返しません。そのためクライアントは、ポーリングのたびに出力を転送することなく、長時間の生成を監視できます。結果は、この応答が `COMPLETED` になったときに、下記の読み取りから一度だけ取得します。

**パラメータ**

**provider** `RouterProviderSegment` *required*

正規の `{provider}/{model}` モデル ID の小文字プロバイダーセグメント。実行対象のモデルを提供するパートナーです。

型: [`RouterProviderSegment`](#routerprovidersegment) -- 英数字スラッグ（例: `anthropic`）、最大 64 文字

**model** `RouterModelSegment` *required*

正規の `{provider}/{model}` モデル ID の小文字モデルセグメント。そのプロバイダー内で実行するモデルです。

型: [`RouterModelSegment`](#routermodelsegment) -- 英数字スラッグ（例: `claude-opus-4-6`）、最大 128 文字

**request\_id** `RouterQueueRequestId` *required*

対象とするキュー中のリクエスト。送信時にボディで返された `request_id` です。

型: [`RouterQueueRequestId`](#routerqueuerequestid) -- `pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`、uuid、最大 36 文字

**レスポンス**

**200** `RouterQueueStatusResponse`

OK - リクエストの現在のキューの状態です。

ボディ: [`RouterQueueStatusResponse`](#routerqueuestatusresponse) -- ヘッダー: `X-Comfy-Request-Id`、`Retry-After`、`X-Comfy-Credits-Used`、`X-Comfy-Estimated-Duration-Seconds`、`X-Comfy-Estimated-Duration-P90-Seconds`、`X-Comfy-Estimate-Source`

**401** `RouterErrorResponse`

認証情報が不足しているか無効です。

ボディ: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**403** `RouterErrorResponse`

この呼び出し元またはモデルに対して、このリクエストは許可されていません。

ボディ: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**404** `RouterErrorResponse`

モデル ID が見つかりませんでした。

ボディ: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**410** `RouterErrorResponse`

Router のリクエストレベルの失敗。リクエストがモデルに到達しなかったか、モデル自体が報告しなかった理由で失敗しました。

ボディ: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**429** `RouterErrorResponse`

`rate_limited`: 呼び出し元ごとのリクエスト許容量を使い切りました。次のリクエストを送信する前に `Retry-After` だけ待ってください。

ボディ: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`、`Retry-After`

**503** `RouterErrorResponse`

Router は一時的に利用できません。バックオフを伴って再試行してください。

ボディ: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

**default** `RouterErrorResponse`

Router のリクエストレベルの失敗。リクエストがモデルに到達しなかったか、モデル自体が報告しなかった理由で失敗しました。

ボディ: [`RouterErrorResponse`](#routererrorresponse) -- ヘッダー: `X-Comfy-Error-Type`、`X-Comfy-Request-Id`

ここでの説明は簡潔です。モデルの選択、検証、再試行、課金については [Using the Comfy Router API](https://docs.comfy.org/ja/development/comfy-router/api.md) を、ヘッダーの動作については [Headers](https://docs.comfy.org/ja/development/comfy-router/headers.md) を参照してください。

## エラーバケット

Router の機械可読なエラーカテゴリで、`X-Comfy-Error-Type` ヘッダーでも送信されます。

### リクエストレベルバケット

Router が受け付けたものの、完了できなかったリクエストに対して発生します。

| `error_type` | 意味 |
| - | - |
| `invalid_input` | リクエストがモデルに到達する前に拒否されました。ボディの形式が不正、ページネーションカーソルが不正または期限切れ、モデル自身のスキーマが受け付けない入力、またはこのリクエストに使用できない `Idempotency-Key`（別のリクエストで既に使用済み。方法、パスとクエリ、またはボディが異なる。もしくは、レスポンスを再生できない呼び出しによって既に消費済み）です。 |
| `content_policy_violation` | プロバイダーがコンテンツポリシーを理由にリクエストを拒否しました。 |
| `provider_error` | パートナープロバイダーが自身の障害を報告したか、Router が結果として解釈できないレスポンスを返しました。 |
| `provider_timeout` | パートナープロバイダーが期限までに応答しませんでした。 |
| `insufficient_credits` | 呼び出し元のワークスペースに、モデルを実行するための十分なクレジットがありません。 |
| `model_not_found` | `{provider}/{model}` という ID が、Router で実行できるモデルを指していません。不明なプロバイダー、未登録の ID、カタログが提供終了日を過ぎて廃止したモデル、またはプロバイダーが現在 Comfy 向けに提供していないカタログ登録済みの ID です。 |
| `byok_credential_rejected` | この呼び出しで指定されたキーがプロバイダーに拒否されました。 |

### トランスポートレベルバケット

モデルへの呼び出しの前またはその周辺で、Router 自身によって発生します。

| `error_type` | 意味 |
| - | - |
| `unauthorized` | リクエストに利用可能な認証情報が含まれていませんでした。 |
| `forbidden` | 認証情報は有効ですが、このモデルまたはこの操作に対する権限がありません。 |
| `concurrency_limit_exceeded` | ワークスペースはすでに許可された数の呼び出しを実行中です。いずれかが完了したら再試行してください。 |
| `client_disconnected` | 呼び出し側が、Router が結果を返す前に接続を閉じました。 |
| `internal_error` | Router 自体が失敗しました。 |
| `deadline_exceeded` | 回答が到着する前に、Comfy が自身の設定済みの上限で接続の維持を停止しました。 |
| `not_enabled` | この呼び出し側に対して Comfy Router がまだ有効になっていません。 |
| `service_unavailable` | Comfy Router が依存するサービスが一時的に利用できず、呼び出し側に問題はありません。 |
| `rate_limited` | 呼び出し側がウィンドウ単位で測定される割り当てを消費し、そのウィンドウが経過するのを待つ必要があります。 |
| `cancelled` | キューに入っていたリクエストが、結果を生成する前に、キャンセルルートまたはオペレーターによって取り消されました。これは終端状態であり、それ自体は課金に関する表明ではありません。 |
| `queue_timeout` | キュー中のリクエストが、一度も受け入れられることなくキュータイムアウトを超えて待機し続けました。 |
| `request_not_found` | `request_id` が、このモデルにおける呼び出し元のどのリクエストも指していません。 |
| `queue_backlog_full` | 呼び出し元が既に実行待ちのキュー中リクエストを抱えすぎているため、この送信は拒否されました。 |
| `result_expired` | リクエストは存在し、完了していましたが、その結果はもう保存されていないため、collect に返すものがありません。 |

## レスポンスヘッダー

**Cache-Control** `string`

カタログのページまたはエントリに対する鮮度の指示。

送信時: `200`, `304`

**Cache-Control** `string`

配信されるスキーマドキュメントに対する鮮度の指示。

送信時: `200`, `304`

**ETag** `string`

配信されるボディのバイト列に対する強力なエンティティタグ（`GET /v2/models` と `GET /v2/models/{provider}/{model}` 用）。

送信時: `200`, `304`

**ETag** `string`

配信されるドキュメントのバイト列に対する強力なエンティティタグ（`GET /v2/models/{provider}/{model}/openapi.json` 用）。

送信時: `200`, `304`

**Idempotent-Replayed** `boolean`

このレスポンスがモデルを再度実行したのではなく `Idempotency-Key` の記録から返された場合に存在し、`true` になります。

**Retry-After** `integer`

同じリクエストを変更せずに再送するまでの待機秒数。

送信時: `503`

**Retry-After** `integer`

このキュー中のリクエストを再度ポーリングするまでの待機秒数。

送信時: `200`, `202`

**Retry-After** `integer`

`error_type: rate_limited` を含む `429` の後に別のリクエストを送信するまでの待機秒数。呼び出し元の 1 分あたりのリクエスト許容量が、もう 1 件のリクエストを受け入れられるまで回復するまでの時間です。

送信時: `429`

**Retry-After** `integer`

同じ `Idempotency-Key` を使って同じリクエストを再試行するまでの待機秒数。

送信時: `409`, `502`, `504`

**X-Comfy-Credits-Used** `string`

この実行にかかったコストを Comfy クレジットで示したもの。課金自体が請求されるのと同じ料金表で算出されるため、呼び出し元は独自の価格表を持つ必要がありません。また、複数の課金対象呼び出しを経てプロバイダーに到達した実行では、最後の 1 回ではなくそれらの合計になります。

**X-Comfy-Error-Type** `RouterErrorType`

失敗を表す粗い機械可読な分類で、Router がすべてのエラーレスポンスに設定します。

型: [`RouterErrorType`](#routererrortype)

**X-Comfy-Estimate-Source** `string`

`status` が `IN_PROGRESS` の間のステータス読み取り時に限り、`X-Comfy-Estimated-Duration-Seconds` と併せて送信されます。この生成時間の見積もりの出所（コスト見積もりの `source` ではありません）を示し、`historical`（最新の実行で計測された値）または `default`（メディア種別ごとのフォールバックで、最新の実行の記録が少なすぎる間はこれが使われます）のいずれかです。

**X-Comfy-Estimated-Duration-P90-Seconds** `integer`

`status` が `IN_PROGRESS` の間のステータス読み取り時に限り、`X-Comfy-Estimated-Duration-Seconds` と併せて送信されます。この生成時間の見積もりの 90 パーセンタイルを整数の秒数で示します。

**X-Comfy-Estimated-Duration-Seconds** `integer`

`status` が `IN_PROGRESS` の間のステータス読み取り時に限り送信されます。プロバイダーが受け入れた後の生成全体の実行についての Router の見積もりを整数の秒数で示します（残り時間ではなく、`IN_QUEUE` で費やした時間も含みません）。

**X-Comfy-Refusal-Subject** `string`

コンテンツポリシーによる拒否がどの入力または出力に関するものかを、Router レベルの閉じた語彙で示します: `input`, `output`, `input_text`, `input_image`, `input_video`, `input_audio`, `output_text`, `output_image`, `output_video`, `output_audio`。

**X-Comfy-Request-Id** `string`

この呼び出しに対するサーバー生成の識別子で、Router のすべてのレスポンス（成功、4xx、5xx のいずれも）に含まれます。エラーレスポンスこそ、ユーザーがサポート依頼で引用する ID を必要とするまさにその場面だからです。

**X-Comfy-Router-Dropped-Params** `string`

文字列の配列を保持する 1 つの JSON エンコード済み文字列です。カンマで分割せず JSON パーサーでデコードしてください。これはワイヤー上では単一の文字列であり、カンマ区切りの OpenAPI 配列ではないうえ、各エントリが独自にカンマを含む文だからです。翻訳がこの呼び出しのリクエストボディを生成し、1 つ以上のネイティブフィールドを、それを処理したプロバイダー上で正確に表現できなかった場合に含まれ、削除された各フィールドとその理由を示します。呼び出し元が `model_provider` でその翻訳を要求した場合（`strict_mode=false`、これがデフォルト）でも、自動の `fallback_provider` リトライが実行した場合でも同様です。

**X-Comfy-Router-Fallback-Provider** `string`

`fallback_provider` が実際にこの呼び出しを 2 つ目のプロバイダーに対してリトライし、そのリトライが成功した場合に限り、プロバイダー名とともに含まれます。最終的にこの呼び出しを処理したプロバイダーであり、試行されて失敗したプロバイダーが入ることはありません。

**X-Comfy-Router-Provider** `string`

この呼び出しを処理した Router レッグのプロバイダーで、成功した実行レスポンスすべてに含まれます。`model_provider` を指定しなかった呼び出しを処理するために Comfy Router が選んだプロバイダー（モデル自身のプロバイダー、または Comfy がルーティングした別のプロバイダー）、`model_provider` で指定された代替プロバイダー、あるいは `fallback_provider` によるリトライが到達したプロバイダー（この場合に限り `X-Comfy-Router-Fallback-Provider` にも名前が入ります）のいずれかです。これは Router がディスパッチしたレッグであり、出力を生成したベンダーとは限りません。ネイティブレッグ内のプロキシレベルのカスケード（例えば `vertexai` の Gemini 画像チェーン）が、どのヘッダーにも現れない別のベンダーに呼び出しを渡すことがあるためです。

**X-Comfy-Upstream-Detail** `string`

モデルプロバイダーがリクエストを拒否した理由を、範囲を限定してサニタイズしたもの。

**X-Comfy-Upstream-Status** `integer`

この呼び出しに対するモデルプロバイダー自身の HTTP ステータス。

**X-Committed-Spend-Current** `integer`

呼び出し元が現在、まだ実行中の呼び出しに対してコミットしている金額（USD セント）。

**X-Committed-Spend-Limit** `integer`

呼び出し元がまだ実行中の呼び出しにコミットできるパートナー支出の上限（USD セント）。この金額は、呼び出しが受け付けられた時点で確保され、その呼び出しが終了すると解放されます。

**X-Committed-Spend-Remaining** `integer`

上限まで残っている余裕（USD セント）。最小値は 0 です。

**X-Content-Type-Options** `string`

Router モデルの成功したすべての実行で、常に `nosniff` です。

**X-Model-Concurrency-Current** `integer`

この呼び出しを拒否したゲートがカウントした、呼び出し元による高コストに分類されたモデルへの同時呼び出し数。

**X-Model-Concurrency-Limit** `integer`

呼び出し元が同時に保持できる、高コストに分類されたモデルへの同時呼び出しの最大数。同時呼び出し上限の 4 分の 1 で、パートナーノードへの呼び出しと共有されます。

**X-Model-Concurrency-Remaining** `integer`

呼び出し元がまだ開始できる、高コストモデルへの呼び出し数。`429` のときは `0` です。

## 事前のコスト見積もり

`POST /v2/models/{provider}/{model}/estimate` は、実行せずにボディの料金を見積もります。また、キューに投入される送信（`POST /v2/models/{provider}/{model}/requests`）は、その `201` で `estimate` と同じ [`RouterCostEstimate`](#routercostestimate) を返します。どちらも Comfy の標準リスト価格で価格設定されます。ただし、ベンダーが報告するコストで請求されるモデルは例外で、そのコストはベンダーの公開価格表から `estimated` として算出されます。どちらも契約料金や顧客固有の料金を反映しません。交渉価格のあるワークスペースにはリスト価格が提示され、契約料金が請求されます。その場合、`source: exact` はリスト価格に対して正確という意味であり、そのワークスペースの請求額に対して正確という意味ではありません。どちらが返す数値も見積もりであり、最終請求額ではありません。ワークスペースの使用量および請求記録にある確定請求額が最終です。自分のプロバイダーキーでの実行は Comfy から請求されません（以下を参照）。デプロイで見積もりが無効になっている場合、ルートは `403` と `error_type: not_enabled` を返し、送信レスポンスは `estimate` を省略します。どちらも、Router がディスパッチする形でボディの料金を見積もります（`model_provider` レッグ用に変換され、実行されるオペレーションにリターゲットされます）が、送信時の `estimate` は実行前の価格ではありません。これは実行が受け入れられ、キューに入った後にのみ返され、その実行はディスパッチ前にキャンセルされない限り請求されます。カタログには依然として価格が掲載されていません。

金額より先に `source` を読んでください。数値の欠落は無料を意味しません。

| `source` | 含まれるもの | 読み方 |
| - | - | - |
| `exact` | `amount`、`amount_cents`、`credits` | `pricing_as_of` の料率でこのボディに対して請求される額と等しい見積もりです。ワークスペースの使用量および請求記録にある確定した請求額が最終的な金額です。 |
| `estimated` | `min_amount`、`max_amount` とその `_cents` 形式、`amount` は含まれない | プロバイダーが報告する数量に請求額が依存し、その数量の上下限がボディで決まる見積もりです。請求額は上下限の範囲内になると見込まれ、ワークスペースの使用量および請求記録にある確定した請求額が最終的な金額です。 |
| `free` | `amount` は "0"、`amount_cents` と `credits` は `0` | 料率表がこのリクエストをゼロで価格付けするため、見積もりは `0` です。ワークスペースの使用量および請求記録にある確定した請求額が最終的な金額です。`0` と表示されるのは `free` の見積もりだけです。 |
| `unknown` | `reason`、数値なし | 実行前に価格を提示できませんでした。その他の `source` 値は `unknown` として扱ってください。 |

`unknown` の見積もりの `reason` は次のいずれかです:

* `not_quotable`: Router はこの呼び出しを実行前に価格付けできません。プロバイダーが報告する数量で請求され、その数量の上下限がボディで決まらないか、送信されたままのボディを価格付けできないためです。認識できない `reason` は `not_quotable` として扱ってください。
* `unpriced_model`: 料率表がこのリクエストを価格付けしていません。
* `byok`(キュー中の送信のみ): 実行は自分のプロバイダーキーを使用するため、Comfy は何も請求しません。
* `pricing_unavailable`(キュー中の送信のみ): リクエストの受け付け時に料率表を読み取れませんでした。送信はそのまま受け付けられ、実行は通常どおり請求されます。

Router がまだ実行前に価格付けできないモデルは、[事前見積もりのないモデル](https://docs.comfy.org/ja/development/comfy-router/limitations.md#事前見積もりのないモデル)に一覧されています。そこに載っていないモデルでも、特定のボディでは `unknown` を返すことがあるため、すべての見積もりで `source` を読んでください。

見積もりがフェイルクローズするのは次の場合です:

* 数値に料率表が必要で、カードが読み込まれていないか古い場合、`/estimate` は推測ではなく `503` を返します。キュー中の送信は見積もりを理由に拒否されることはなく、代わりに `source: unknown` と `reason: pricing_unavailable` を含みます。実行前にまったく価格付けできない呼び出し(`not_quotable`)、または自分のプロバイダーキーでのキュー中の送信(`byok`)は、カードを読まずに応答されるため、その `200` はカードが新しいかどうかについては何も示しません。
* `/estimate` はデフォルトの実行と同様に、モデル自身の入力スキーマに対してボディを検証します。そのため、モデルのスキーマに適合しないボディは、実行が返すのと同じ `422` を、同じ `detail[]` 形状で受け取ります。何も価格付けもディスパッチもされません。
* キュー中の送信の冪等なリプレイ(`Idempotent-Replayed: true`)は `estimate` を含みません。元の見積もりが保存されていないためです。

見積もりの限界。`200` の数値は、実行が受け付けられること、または正確にその金額が請求されることを約束するものではありません:

* `/estimate` は `strict_mode` や `reject_unknown_fields` を受け取らないため、モデルのネイティブな契約のみを検証します。`strict_mode=true` の実行が代替プロバイダー自身のスキーマで受け付けるボディが、ここでは `422` になることがあります。また、`reject_unknown_fields=true` の実行なら拒否する未宣言のトップレベルフィールドが、ここでは価格付けされます。Anthropic Messages モデルは例外です。そのスキーマは未宣言のフィールドを許容するため、`reject_unknown_fields=true` の実行でも何も拒否せず、見積もりは未宣言のトップレベルフィールド `tools`、`tool_choice`、`temperature`、`top_p`、`top_k`、`stop_sequences`、`metadata`、`thinking` および空の `mcp_servers` のみを価格付けします。その他の未宣言のトップレベルフィールドがあると、`reason: not_quotable` とともに `unknown` を返します。
* `pricing_as_of` は料率表を取得した時刻です。ベンダーの公開価格表から取得した `estimated` の見積もりは、その価格表を読んだ日付を持ちます。請求数量をベンダーの公開スケジュールから予測し、その後レートカードで価格設定する `exact` または `estimated` の見積もりは、そのスケジュールの読み取り日がカードより古い場合、スケジュールの読み取り日を持ちます。カードもスケジュールも読まれていない場合は、見積もりを返した時刻です。これは価格の固定ではありません。実行は、レーティング時点で有効な料率で請求されます。
* `/estimate` は `model_provider` が示すレグ、またはネイティブのプロバイダーを価格付けします。`fallback_provider` や `strict_mode` パラメータは受け取りません。フォールバックのリトライが別のプロバイダーで行われる同期実行は、そのプロバイダーの料率で請求され、見積もりはそのレグを価格付けしていません。実行のレスポンスの `X-Comfy-Router-Fallback-Provider` が、それが発生したことを示します。キュー中の送信にはフォールバックがないため、その `estimate` は実行されるレグを価格付けします。
* `/estimate` は常にプラットフォームの請求額を算出します。自分のプロバイダーキーでの実行は Comfy から請求されませんが、`/estimate` はそれを検出せずに数値を返します。`reason: byok` を返すのはキュー中の送信だけです。
* ドルは丸めていないセントから最大8桁の小数で表示され、課金対象の1セント未満の `amount` が `0` と表示されることはありません。`credits` は `round(amount × 211, 2)` であり、これは `X-Comfy-Credits-Used` が課金に適用するのと同じ変換です。そのため、ごく小さい非ゼロの価格では `credits` が `0` にラウンドされることがあります。これが重要となる場合は、`credits` ではなく `amount` または `amount_cents` で予算を立ててください。このヘッダーは引き続き、1回の実行に対する事後的な数値です。残高は Comfy プラットフォーム上にあります。

## 結果アセット

モデルは、アセット URL、インラインバイト、またはその両方を返すことができます。以下のプロバイダーは、選択済みのアセットを Comfy ストレージにコピーし、その URL を置き換えます。この動作はモデルによって異なります。これを選択するリクエストヘッダーはありません。

| モデル | Comfy ストレージにコピーされるもの | Comfy ホスト URL の最大有効期間 |
| - | - | - |
| `bfl/*` | 完了したアセット、および結果に含まれている場合はドラフトキャッシュのアセット | 24 時間 |
| `byteplus/*` ビデオモデル (`seedance`、`dreamina-seedance`) | 完了したビデオ、および結果に含まれている場合はラストフレーム画像 | 24 時間 |
| `minimax/*` | 完了したビデオ | 12 時間 |
| `xai/*` | 生成されたすべての画像、および完了したビデオ | 24 時間 |

これらの有効期間は、URL を開いたときではなく、URL が署名されたときに開始されます。キャッシュされた URL や再利用された URL は残り時間が短い場合があります。再利用しても有効期間は更新されません。`Idempotency-Key` の記録は、保持する URL より長く残ることがあるため、そうした URL の有効期限が切れる 1 時間前から、同じキーでの再試行は記録済みのレスポンスではなく `409 invalid_input` で応答されます。応答が返された時点ですでにそれだけ期限に近かった場合は、5 分間は再再生できます。アセットは速やかにダウンロードしてください。コピーされるのは各行に記載されたアセットのみです。`byteplus/seedream-*` と `byteplus/seededit-*` の画像は BytePlus ビデオの行には含まれません。

コピーを実行するのは、モデルのネイティブプロバイダーのみです。代替プロバイダーによって処理された実行、すなわち `model_provider` が代替プロバイダーを指定している場合、`model_provider` を指定しておらず Comfy Router が別のプロバイダーで処理した実行（同期実行ルートの `X-Comfy-Router-Provider` で報告されます）、またはネイティブ実行のフォールバック再試行が代替プロバイダーに到達した場合（`X-Comfy-Router-Fallback-Provider` で開示されます）は、そのプロバイダー自身の URL を返します。これらの URL はプロバイダーの有効期限に従い、コピーされません。`model_provider` の値 `default`、`comfy`、`comfyui` は代替プロバイダーを指定しないため、それらの実行はネイティブであり、上記と同様にコピーされます。フォールバック再試行がネイティブプロバイダーに戻った `model_provider` の実行も同様です。

**Veo (`veo/*`) には別のストレージパスがあります。** `response.videos[]` では、存在する方のメンバーを読み取ってください。`bytesBase64Encoded` はクリップをインラインで含み、`gcsUri` は、プロバイダーから Comfy ストレージへの直接書き込みが環境で構成されている場合に、Comfy が署名した HTTPS リンクを含みます。そのリンクはレスポンスから 24 時間有効です。後者の場合はアセットをコピーするのではなく直接書き込むため、Veo は再ホスティングの表には含まれていません。

その他のモデルは、プロバイダーのアセット参照またはインラインバイトを返します。プロバイダーの URL はプロバイダーの有効期限に従います。これは上記の有効期間よりはるかに短い場合があり、Router の契約では規定されていません。

**オリジナルの BytePlus URL（Seedance 2.x、オプトイン）。** Comfy がサーバー側でオプトインしたワークスペースでは、Seedance 2.x の結果に、コピーされた URL の隣に BytePlus 自身の URL が `content.upstream_video_url` と `content.upstream_last_frame_url` として含まれ、さらに `content.upstream_expires_at` も含まれます。リクエストパラメーターはなく、デフォルトでオプトインされるワークスペースはありません。これらの URL は生成から 24 時間後に期限切れとなり、BytePlus がクリアすると存在しなくなります。Seedance 2.5 では BytePlus がそれぞれ 100 ダウンロードに制限しており、Router 自身のコピーがそのうち 1 回を使用します。各 URL はそのオブジェクトのベアラークレデンシャルです。保持している誰でも、期限が切れるまでアセットをダウンロードできます。

**ゼロデータ保持のワークスペース。** Comfy がゼロデータ保持を設定したワークスペースでは、BytePlus の結果は Comfy ストレージにコピーされません。上記の `byteplus/*` ビデオの行は適用されず、`content.video_url` と `content.last_frame_url` は BytePlus 自身のプロバイダー URL となり、BytePlus が送信したそのままの形で返されます。これらは 24 時間有効で、Seedance 2.5 では BytePlus がそれぞれ 100 回のダウンロードに制限しているため、アセットは速やかにダウンロードしてください。このような結果は `Idempotency-Key` レコードから再生されません。

コピーはアセットごとのベストエフォートです。1 つのコピーが失敗した場合、そのエントリはプロバイダーの参照を保持します。レスポンスには Comfy とプロバイダーの両方の URL が含まれる可能性があり、アセットごとの明示的なコピーステータスフィールドはありません。生成は引き続き成功し、課金されます。1 つの正常に再ホストされたアセットから、すべての URL の有効期間を推測しないでください。

結果が Comfy ホストかどうかは、完了した呼び出しが後でその `Idempotency-Key` レコードから再生できるかどうかも決定します。上記の `Idempotency-Key` パラメーターは、再生できない場合に再試行が何で応答されるかを説明しています。

## モデルごとの入力および出力スキーマ

各モデルのフィールドは `GET /v2/models/{provider}/{model}/openapi.json` から読み取ります。この呼び出しには APIキーが必要です。スキーマが作成されているすべてのモデルについて、同じドキュメントが APIキーなしでこのサイトの `/router-schemas/{provider}/{model}.json` にも公開されています。このコピーは最後のドキュメント更新時に取得されたスナップショットであるため、両者が異なる場合はエンドポイントの内容が正式です。オペレーションの `requestBody` は入力の検証を記述しており、その `200` レスポンスは、スキーマが作成されている場合に出力の形状とメディアタイプを記述しています。`x-comfy-input-schema-authored` が false の場合、Router はモデル固有の事前検証なしで任意の JSON オブジェクトを受け入れます。プロバイダーの要件は引き続き適用されます。出力スキーマは結果を記述するものであり、Router は返されたプロバイダーのペイロードをそれらに対して検証しません。スキーマが作成されていない出力では、`application/json` ではなく `*/*` が使用される場合があります。デコードする前にレスポンスのコンテンツタイプを確認してください。

## スキーマ

### RouterBilledWorkspace

拒否された呼び出しが課金対象としていたウォレット。`RouterErrorResponse.billed_workspace` に含まれます。「どのウォレットが空なのか」に答えるものであり、呼び出し元の UI で現在選択されているワークスペースとは限りません。また、チームメンバーが個人の認証情報を使っている場合、資金のあるチームを開いていても、ここにはそのメンバーの個人ウォレットが示されます。`denied_reason` と同時にのみ存在します。

**フィールド**

**id** `string`

クラウドのワークスペース id。レガシーレールでは存在しません。

**type** `string` *required*

`personal` または `team`。オープンな文字列であり、それ以外の値は個人として扱ってください。

**rail** `string`

呼び出しがクラウドのワークスペースではなく、呼び出し元のワークスペース以前の Metronome 顧客に課金される場合は `legacy`。その顧客にはワークスペース id がありません。クラウドのワークスペースの場合は存在しません。

### RouterChargesOnPolicyRejection

コンテンツポリシーによる拒否がこのモデルで課金されるかどうか。不明な値は課金される可能性があるものとして扱ってください。

型: `string`

### RouterCostEstimate

この呼び出しにかかるコストを米ドルで事前に見積もったものです。価格はディスパッチ前に、Comfy のスタンダードなリスト価格で算出されます。ベンダーが報告するコストで課金されるモデルの場合は、ベンダーの公開価格表に基づいて算出されます。このベンダー報告のケースでは、`source: exact` が返されるのは、オプトインした少数のモデルに限られ、かつ公開価格表が金額を完全に決定できる場合のみです（価格を左右するすべてのフィールドが明示されているか、金額を変えようのないデフォルトのままである場合）。それ以外のベンダー報告の見積もりはすべて `estimated` となり、価格表で完全に決定できるはずのものも含まれます。いずれの場合も、実行の完了後にはベンダーが報告する金額で課金され、見積もりの数値がそのまま請求されることはありません。契約や顧客固有のレートは反映されません。個別価格を交渉したワークスペースにはリスト価格が見積もられ、契約レートで課金されます。その場合の `source: exact` はリスト価格に対して正確という意味であり、そのワークスペースの請求額が正確という意味ではありません。これは最終的な請求額ではありません。支払うのは、ワークスペースの使用量および請求記録に確定した請求額です。実行後に報告される `X-Comfy-Credits-Used` は事後に丸められた数値であり、領収書ではありません。`source` はその数値をどこまで信頼できるかを示します。`exact` は `amount` を持ちます。`free` は `amount` が "0" です（レートカードがこのリクエストをゼロで価格設定しています）。`estimated` は `min_amount` と `max_amount` を持ち、`amount` は持ちません。`unknown` はどちらも持たず、`reason` を持ちます。`amount` が存在しないことを無料と読み取らないでください。価格のロックではありません。`pricing_as_of` を参照してください。

**フィールド**

**source** `string` *required*

`exact` | `estimated` | `free` | `unknown`。これ以外の値は `unknown` として扱ってください。`exact` と `estimated` はいずれも見積もりを示すものであり、どちらも最終的な請求額ではありません。`free` は、レートカードがこのリクエストをゼロで価格設定していることを意味するため、`amount` は "0" です。`unknown` には金額が含まれません。

**currency** `string` *required*

常に `USD` です。

**amount** `string`

推定コストをドル建ての10進文字列で表したもの（例: "0.04"）。最大8桁の小数部を持ち、指数表記は使用しません。課金対象の1セント未満の価格が "0" として出力されることはなく、"0" になるのは `free` の見積もりのみです。`source` が `exact` または `free` の場合にのみ存在します。最終的な請求額ではありません。最終的な請求額は、ワークスペースの使用量および請求記録に確定した金額です。

**min\_amount** `string`

見積もりの下限をドル建ての10進文字列で表したもの。見積もりであり、保証された下限ではありません。たとえば、プロバイダーがリクエストした量より少ない結果を返した場合（画像が返されない場合など）、見積もりが過去の呼び出しから学習した典型的な価格である場合、価格がリクエストした量に応じて単調に上昇しない場合には、請求額がこれより少なくなることがあります。`source` が `estimated` の場合にのみ存在します。

**max\_amount** `string`

見積もりの上限をドル建ての10進文字列で表したもの。見積もりであり、保証された上限ではありません。たとえば、プロバイダーが要求より多い結果を返した場合（要求したより多くの画像が返された場合など）、見積もりが過去の呼び出しから学習されたものである場合、価格がリクエストした量に応じて単調に上昇しない場合には、請求額がこれより多くなることがあります。`source` が `estimated` の場合にのみ存在します。

**amount\_cents** `number`

同じ金額を米セント単位で表したもの（未丸め）。計算用です。`amount` と共に存在します。

double

**min\_amount\_cents** `number`

`min_amount` を米セント単位で表したもの（未丸め）。`min_amount` と共に存在します。

double

**max\_amount\_cents** `number`

`max_amount` を米セント単位で表したもの。`max_amount` と共に存在します。

double

**credits** `number`

プラットフォームの換算（\$1 = 211 クレジット）を用いて `amount` を Comfy クレジットで表し、小数第2位に丸めたもの。`exact` の見積もりに対して `X-Comfy-Credits-Used` が持つと想定される値です。このヘッダーは事後に丸められた数値であり、領収書ではありません。最終的なのは、ワークスペースの使用量および請求記録に確定した請求額です。

double

**provider** `string` *required*

この見積もりが対象とするプロバイダーのレッグ。キュー中の送信では、実行されるレッグになります。

**model** `RouterModelId` *required*

正規の Comfy Router モデル ID である `{provider}/{model}`。`POST /v2/models/{provider}/{model}` でモデルを指定する値とまったく同じであるため、呼び出し元は何かから再導出することなくこのパスに埋め込むことができます。その `pattern` は `RouterProviderSegment` と `RouterModelSegment` を単一の `/` で連結したもので、`maxLength` はそれらの長さの合計に区切り文字を加えたものです。

型: [`RouterModelId`](#routermodelid) -- モデル ID（例: `anthropic/claude-opus-4-6`）、最大 193 文字

**pricing\_as\_of** `string` *required*

この見積もりの価格算出に使用したレートカードを取得した日時。見積もりは価格のロックではありません。実行は、評価時点で有効なレートで課金され、この時点のレートではありません。ベンダーの公開価格表から取得した `estimated` の見積もり（ベンダーが報告するコストで課金されるモデル）では、代わりにその価格表を読み取った日付が入ります。課金対象の数量が公開されたベンダーのスケジュールから予測され、その後レートカードで価格設定される見積もりの場合は、そのスケジュールの読み取り日とカードの取得時刻のうち古い方が入ります（`exact` の回答でも `estimated` の回答でも同様です。ベンダーが報告するクレジットで課金されるモデルは `estimated` のケースです）。レートカードが一切読み取られなかった場合（`reason: pricing_unavailable`、`byok`、またはどのカードからも価格を算出できない `not_quotable` の呼び出し）は、見積もりに回答した日時になります。

date-time

**reason** `string`

`source` が `unknown` の場合にのみ表示されます：`not_quotable`（Router はこの呼び出しを実行する前に価格を算出できません。価格はプロバイダーが返す内容に依存するか、本文が課金対象の数量を制限していないためです）、`unpriced_model`（レートカードがこのリクエストの価格を設定していません）、`byok`（キュー中の送信のみ：実行ではユーザー自身のプロバイダーキーを使用するため、Comfy はその実行に対して何も請求しません）、または `pricing_unavailable`（キュー中の送信のみ：リクエストの受け付け時にレートカードを読み取れませんでした。これは一時的なもので、実行には通常どおり料金が発生します）。その他の値は `not_quotable` として扱います。

### RouterErrorResponse

認証、アクセス、モデル検索、クォータ、プロバイダーのトランスポート失敗に対するエラーボディです。

**フィールド**

**detail** `string` *required*

失敗の人間が読める説明で、エンドユーザーに提示しても安全です。機械解析はされません。代わりに `error_type` で分岐してください。退役したモデルに対する `model_not_found` では、後継モデルが記録されていて呼び出し元から参照できる場合、`detail` は `<id> was retired on <YYYY-MM-DD>; use <successor>` となり、そうでない場合は通常の候補リストの代わりに `<id> was retired on <YYYY-MM-DD>` だけになります。ここで示される後継モデルは常に、呼び出しの向き先を変更できる有効なカタログ ID です。提供終了日がまだ将来であるモデルは退役していません。`GET /v2/models` に引き続き表示され、その日付までは実行可能なままです。`detail` の他の部分と同様、この退役に関する文言は表示用であり、互換性の保証はありません。機械解析されないというルールには、文書化された 2 つの例外があります。`POST /v2/models/{provider}/{model}` では、`409` が `invalid_input` バケットを共有する 3 つの無関係な条件に対して返され、それらを区別するのは `detail` だけです。`detail` が「this request's `image` selects the edit operation」で始まる場合はマルチパートの `model_provider` 拒否であり、`detail` が `this request resolved a BYOK credential` で始まる場合は BYOK の `model_provider` 拒否です。どちらも新しい `Idempotency-Key` では解消されません。そのルート上の他の `invalid_input` `409` はキーの競合です。どちらの接頭辞も安定した契約用語であり、マッチングしてもかまいません。他のどこでも、`detail` に基づく分岐に互換性の保証はありません。

**error\_type** `RouterErrorType` *required*

Router の失敗を表す粗い機械可読なバケットで、`X-Comfy-Error-Type` レスポンスヘッダーにも反映されるため、呼び出し元はボディを解析せずに分岐できます。この集合は 21 個の値で閉じています。6 つのリクエストレベルのバケット `invalid_input`、`content_policy_violation`、`provider_error`、`provider_timeout`、`insufficient_credits`、`model_not_found` に加え、トランスポートレベルの `unauthorized`、`forbidden`、`concurrency_limit_exceeded`、`client_disconnected`、`internal_error`、`deadline_exceeded`、`not_enabled`、`service_unavailable`、`rate_limited`、`cancelled`、`queue_timeout`、`request_not_found`、`queue_backlog_full`、`result_expired`、そしてリクエストレベルの `byok_credential_rejected` です。「閉じている」とは、今日文書化されている時点での集合を説明するものであり、永久に成立する上限ではありません。集合は増えることが想定されているため、これは意図的にプレーンな文字列であり `enum` ではありません。そのためクライアントは、認識できない値を `internal_error` として扱う必要があり、上記のリストを網羅的に switch して次の追加で壊れてはいけません。

型: [`RouterErrorType`](#routererrortype)

**upstream\_detail** `string`

`invalid_input` 拒否に対する、長さが制限されサニタイズされた理由です。同期ルートでは、モデルプロバイダーが示した理由であり、`error_type` が `invalid_input` で、`X-Comfy-Upstream-Status` がプロバイダーの `4xx` または `2xx` の場合にのみ存在します。つまり、プロバイダーがリクエストを不正な形式として拒否し、その理由を述べた場合です。通常、そのステータスは `4xx` です。成功エンベロープ内で拒否された生成を報告するプロバイダーでは `2xx` になります（BytePlus の失敗タスクポーリングは HTTP `200` で、理由がボディに含まれます）。プロバイダーの `5xx`、トランスポート失敗、コンテンツポリシー拒否、Router 自身に関する拒否を含む他のすべての失敗では存在せず、`X-Comfy-Upstream-Detail` ヘッダーを反映します。`invalid_input` で終了した実行のキュー中のコレクト（`GET /v2/models/{provider}/{model}/requests/{request_id}`）は、最初のコレクトでこのフィールドに同じ理由を含み、その後リクエストから削除されます。後で行うコレクトは通常、それを含まない同じ `error_type` と `detail` を返すため、最初のコレクトから読み取ってください。その読み取りではどちらのヘッダーも送信されません。キュー中のコレクトはまた、Router がリクエストをプロバイダーに送信する前に拒否し、理由を 1 文で述べられる場合、Router 自身の理由にもこのフィールドを使用します。同期ルートではそれを `detail` で返します。個々のフィールドを名指しする拒否には何も含まれません。

**refusal\_subject** `string`

コンテンツポリシー拒否がどの入力または出力に関するものかを示す、Router レベルの閉じた語彙です。`input`、`output`、`input_text`、`input_image`、`input_video`、`input_audio`、`output_text`、`output_image`、`output_video`、`output_audio`。プロバイダーがモダリティを名指ししなかった場合、裸の `input` / `output` 値がどちら側かを示します。`error_type` が `content_policy_violation` で、プロバイダーが拒否された対象を機械可読コードで名指しした場合にのみ存在し、それ以外では存在しません。プロバイダーのテキストは決して含みません。現在、BytePlus、Runway、BFL、Gemini、Veo、Vertex、xAI、Wan の拒否、および MiniMax Router の Nano Banana レッグの Gemini 拒否について名指しされます。拒否がどちら側に関するものかを示さないプロバイダーでは存在しません。`X-Comfy-Refusal-Subject` ヘッダーを反映します。

**denied\_reason** `string`

パートナーノードの支出拒否に対する Billing のポリシー分岐です。請求対象のウォレットが空の場合は `no_funds`、資金の読み取りがそう示さずに呼び出しが拒否された場合は `unspecified` です。`error_type` が `insufficient_credits` で、デプロイメントがウォレットの事実を報告する場合にのみ存在し、それ以外では存在しません。表示テキストではなく機械可読コードです。`detail` を表示し、これで分岐してください。

**billed\_workspace** `RouterBilledWorkspace`

`RouterErrorResponse.billed_workspace` は、拒否された呼び出しが請求していたはずのウォレットです。「どのウォレットが空か」に答えるものであり、呼び出し元の UI で現在選択されているワークスペースとは限りません。また、資金のあるチームが開かれている間でも、チームメンバーの個人クレデンシャルはここでその個人ウォレットを示します。`denied_reason` と同時にのみ存在します。

型: [`RouterBilledWorkspace`](#routerbilledworkspace)

**credential\_kind** `string`

拒否されたリクエストがどのように認証されたかを示します: `personal_api_key`、`team_api_key`、`personal_session`、`team_session` のいずれかです。「もう一方のウォレットに請求するには、どの認証情報に切り替えればよいか」に答えます。これは権限ではなく、何も付与しません。`denied_reason` と同時にのみ提示されます。

### RouterErrorType

機械可読な Router エラーカテゴリ。`X-Comfy-Error-Type` ヘッダーでも送信されます。

型: `string`

### RouterModelBilling

モデルを呼び出す前に確認すべき課金動作。価格や使用量は含まれない。

**フィールド**

**charges\_on\_policy\_rejection** `RouterChargesOnPolicyRejection` *required*

このモデルがコンテンツポリシーを理由に拒否した呼び出しでも、それでも呼び出し元に課金されるかどうか。プロバイダーによって異なり、その違いは呼び出し時には見えず、同じ呼び出しに対してエラーと課金の両方を目にしたユーザーには知りようがなかった - そのため、プロバイダーごとの俗説に委ねるのではなく、呼び出し前にモデルごとに明記されている。`yes` の場合、同期ルート上の `content_policy_violation` エラーは `X-Comfy-Credits-Used` を伴うことがある。プロバイダーがモデルの生成済み出力を拒否し、Comfy がその拒否された生成の使用量を記録した場合に伴い、その量が示される。入力側の拒否、同一キーのリプレイ（`Idempotent-Replayed: true`）、およびヘッダーの小数点以下2桁に表示されないほど少額の課金は、それを伴わない。ヘッダーなしの拒否は報告されないが、無料だった証拠ではない。

型: [`RouterChargesOnPolicyRejection`](#routerchargesonpolicyrejection)

### RouterModelDetail

1つの Comfy Router モデルごとの詳細: カタログ一覧がそのモデルについて報告するすべての内容に加え、単一モデルルートだけが持つモデルごとのフィールド。

構成: [`RouterModelListEntry`](#routermodellistentry)、[`RouterModelDetailFields`](#routermodeldetailfields)。

型: `object`

### RouterModelDetailFields

モデル詳細エンドポイントから返される任意のフィールド。

**フィールド**

**input\_schema\_url** `string`

このモデルのOpenAPIドキュメントのURL。入力スキーマと出力スキーマを含みます。

HTTPS URL（例: `https://api.comfy.org/v2/models/bfl/flux-2-pro/openapi.json`）。最大2048文字

### RouterModelId

`POST /v2/models/{provider}/{model}` で使用するモデルID。

型: `string` -- モデルID（例: `anthropic/claude-opus-4-6`）、最大193文字

### RouterModelInput

モデル入力オブジェクト。フィールドと検証については、選択済みモデルの OpenAPI ドキュメントを参照してください。

型: `object`

### RouterModelInputSchemaDocument

1つのモデルの入力と出力をまとめたスタンドアロンの OpenAPI ドキュメントです。

型: `object`

### RouterModelListEntry

モデルのIDと課金情報。

**フィールド**

**id** `RouterModelId` *required*

正規の Comfy Router モデルID。`{provider}/{model}` 形式で、`POST /v2/models/{provider}/{model}` 上でそのモデルを指定する値とまったく同じです。したがって呼び出し側は、何かから再導出することなくこの値をそのパスに埋め込めます。`pattern` は `RouterProviderSegment` と `RouterModelSegment` を単一の `/` で連結したもので、`maxLength` は両者の長さの合計にその区切り文字を加えたものです。

型: [`RouterModelId`](#routermodelid) -- モデルID、例: `anthropic/claude-opus-4-6`、最大193文字

**provider** `RouterProviderSegment` *required*

正規の `{provider}/{model}` モデルIDのうち、小文字の `provider` セグメント。対象のモデルを提供するパートナーを表します。呼び出しルートの `provider` パスパラメータとカタログエントリの `provider` フィールドはどちらもこの同一のスキーマを参照しており、これによって一覧に載るIDと受け付けるIDが食い違わないようになっています。

型: [`RouterProviderSegment`](#routerprovidersegment) -- 英数字スラッグ、例: `anthropic`、最大64文字

**model** `RouterModelSegment` *required*

正規の `{provider}/{model}` モデルIDのうち、小文字の `model` セグメント。そのプロバイダー内で実行するモデルを表します。`RouterProviderSegment` と同じく食い違いを防ぐ理由から、呼び出しルートの `model` パスパラメータとカタログエントリの `model` フィールドで共有されています。

型: [`RouterModelSegment`](#routermodelsegment) -- 英数字スラッグ、例: `claude-opus-4-6`、最大128文字

**billing** `RouterModelBilling` *required*

呼び出し前に呼び出し側が必要とするモデルごとの課金情報であり、価格ではありません。使用量やコストの数値がここに現れることはありません。

型: [`RouterModelBilling`](#routermodelbilling)

**schema\_etag** `string`

このモデルの `GET /v2/models/{provider}/{model}/openapi.json` ドキュメントの現在の強い `ETag`。スキーマが変更されていない間に `304` を得るには、その読み取りで `If-None-Match` として送信します。または前回確認した値と比較すれば、すべてのドキュメントを取得することなく、どのモデルのスキーマが変更されたかを知ることができます。この呼び出し元に対してその読み取りが現時点で `200` を返さない場合は存在しません。スキーマサービスが利用不可の場合、モデルのドキュメントをレンダリングできない場合、あるいはレスポンスの構築中にそのモデルがこの呼び出し元にとって利用不可になった場合です。タグが存在しないことはスキーマの変更ではありません。現在のタグを知るには、モデルのドキュメントを再読み取りしてください。

### RouterModelListResponse

Router モデルカタログの 1 ページ分です。

**フィールド**

**data** `array of RouterModelListEntry` *required*

このページのモデルで、最大 `limit` 件です。

型: [`RouterModelListEntry`](#routermodellistentry) の配列

**has\_more** `boolean` *required*

このページの先に別のページが存在するかどうか。この値が true の間はページを辿り続けてください。`data` が短い、または空であることからカタログの終端を推測しないでください。

**next\_cursor** `RouterPageCursor`

Router リストへの不透明なカーソルです。サーバーが生成し、往復させることだけを目的としています。オフセットでもモデル ID でもなく、順序付けもされておらず、カタログの再構築をまたいで安定もしないため、パースすること、インクリメントすること、取得元の走査を超えて永続化することは、いずれも契約の範囲外です。オフセットではなくカーソルを使うのは、カタログが変化し続けるリストだからです。オフセットによる走査では、走査の途中でエントリが追加または削除されると、気付かないうちにエントリがスキップされたり重複したりし、呼び出し元はそれが起きたことを判別できません。

型: [`RouterPageCursor`](#routerpagecursor) -- `next_cursor` として返される不透明なカーソル、1〜512 文字

**limit** `integer` *required*

実際に提供されたページサイズ。最大値を超える `limit` を要求した場合は、拒否されるのではなく最大値に丸められるため、要求した値より小さくなることがあります。送信した数値ではなく、この数値でページネーションしてください。そうしないと、受け取っていない行を前提にしてしまいます。

1〜100

### RouterModelOutput

モデル結果オブジェクトです。正確な形状については、選択済みモデルの出力スキーマを参照してください。

型: `object`

### RouterModelSegment

`{provider}/{model}` モデル ID のうちモデル部分。

型: `string`。英数字のスラッグ（例: `claude-opus-4-6`）、最大 128 文字

### RouterPageCursor

不透明なカタログカーソルです。`cursor` として変更せずにそのまま返してください。

型: `string` -- `next_cursor` として返される不透明なカーソル、1–512文字

### RouterProviderSegment

`{provider}/{model}` モデル ID のプロバイダー部分。

型: `string`。英数字のスラッグ（例: `anthropic`）、最大 64 文字

### RouterQueueCancelResponse

このルートが解決したリクエストを表す2つのステータス、`202` と `409` に対するキャンセル要求への応答です。成功エンベロープとエラーエンベロープに分けず、両方で1つのボディ形状を共有します。どちらも「キャンセルによって何が見つかったか」という同じ内容を表しており、ステータスコードごとに異なる型をパースしなければならないクライアントに分ける利点はないためです。

**フィールド**

**request\_id** `RouterQueueRequestId` *required*

キュー中の Router リクエスト1件の識別子。呼び出し元がポーリング、キャンセル、結果取得に使用するハンドルです。

型: [`RouterQueueRequestId`](#routerqueuerequestid) -- `pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`, uuid, 最大36文字

**status** `RouterQueueCancelStatus` *required*

このルートが実際に解決したリクエストを表す2つの結果について、キャンセル要求が何を見つけたかを示します。どちらも HTTP ステータスに反映されるため、クライアントはどちらで分岐してもかまいません。

型: [`RouterQueueCancelStatus`](#routerqueuecancelstatus)

### RouterQueueCancelStatus

このルートが実際に解決したリクエストを表す2つの結果について、キャンセル要求で判明した内容を示します。どちらも HTTP ステータスに反映されるため、クライアントはどちらを基準に分岐してもかまいません。

Type: `string`

### RouterQueuePosition

レスポンスが生成された時点で、このリクエストよりキュー内で先行しているリクエストの数。0 はこのリクエストが先頭であることを意味します。

型: `integer` -- 最小値 0

### RouterQueueRequestId

キュー中の Router リクエスト1件の識別子。呼び出し元がポーリング、キャンセル、結果の収集に使用するハンドルです。

型: `string`、`pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`、uuid、最大36文字

### RouterQueueStatus

キュー中の Router リクエストの状態。正確に3つの値を持ち、`RouterErrorType` とは異なり、これは閉じた `enum` です。なぜなら、2つのスキーマは意図的に逆方向に閉じられているからです。`RouterErrorType` は失敗を分類し、その集合は増えることが想定されています。そのため、認識されないバケットを厳密に拒否する生成済みクライアントは、何かがすでにうまくいかなかったときに最も失敗しやすくなります。これはライフサイクルであり、後で4番目の状態が追加されたライフサイクルは、`enum` として宣言されているかどうかにかかわらず、それに対して書かれたすべてのポーリングループにとって破壊的変更です。そのため、`enum` として宣言され、制約はクライアントが見える場所に記述されています。

型: `string`

### RouterQueueStatusFields

`RouterQueueStatusResponse` のうち URL ブロックではない半分です。キュー中の 1 リクエストの識別子、その現在の状態、そしてその状態がターミナルで実行が成功しなかった場合には、理由を示す大まかな分類を表します。

**フィールド**

**request\_id** `RouterQueueRequestId` *required*

キュー中の Router リクエスト 1 件の識別子。呼び出し側がポーリング、キャンセル、結果取得に使うハンドルです。

型: [`RouterQueueRequestId`](#routerqueuerequestid) -- `pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`, uuid, 最大 36 文字

**status** `RouterQueueStatus` *required*

キュー中の Router リクエストの状態です。値はちょうど 3 つしかなく、`RouterErrorType` とは異なりこれは閉じた `enum` です。2 つのスキーマは意図的に逆方向へ閉じられているためです。`RouterErrorType` は失敗を分類するもので、その集合は増えることが想定されているため、未知の分類を厳格に拒否する生成済みクライアントは、すでに何かが失敗したまさにそのときに最も激しく失敗することになります。一方こちらはライフサイクルであり、後から 4 つ目の状態を追加するライフサイクルは、enum として宣言されているかどうかに関わらず、それに対応して書かれたすべてのポーリングループにとって破壊的変更になります。だからこそ enum として宣言し、その制約はクライアントから見える場所で明示しています。

型: [`RouterQueueStatus`](#routerqueuestatus)

**queue\_position** `RouterQueuePosition`

レスポンスが構成された瞬間に、このリクエストより前にキュー内にあるリクエストの数です。0 はこのリクエストが先頭であることを意味します。

型: [`RouterQueuePosition`](#routerqueueposition) -- 0 以上

**error\_type** `RouterErrorType`

成功しなかった `COMPLETED` リクエストにのみ存在し、その失敗を返すときに結果読み取りが `X-Comfy-Error-Type` に設定するのと同じ大まかな分類を保持します。これにより、成功したターミナルリクエストと、失敗またはキャンセル済みのリクエストを区別できます。どちらにも別個のターミナルステータスは存在しません。また、成功時には null ではなく存在しないため、その有無で分岐してください。

型: [`RouterErrorType`](#routererrortype)

### RouterQueueStatusResponse

キュー中のリクエスト1件の現在の状態を、送信時に返されたものと同じ3つのURLと組み合わせたものです。

[`RouterQueueUrls`](#routerqueueurls)、[`RouterQueueStatusFields`](#routerqueuestatusfields)を組み合わせています。

Type: `object`

### RouterQueueSubmitFields

`RouterQueueSubmitResponse` のうち URL ブロックではない半分、つまり新しいリクエストの識別情報と、受け付けられた瞬間のその状態です。

**フィールド**

**request\_id** `RouterQueueRequestId` *required*

キュー中の Router リクエスト 1 件の識別子。呼び出し側がポーリング、キャンセル、結果取得に使うハンドルです。

型: [`RouterQueueRequestId`](#routerqueuerequestid) -- `pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`, uuid, 最大 36 文字

**status** `RouterQueueStatus` *required*

キュー中の Router リクエストの状態です。値はちょうど 3 つで、`RouterErrorType` と異なりこちらは閉じた `enum` です。これは 2 つのスキーマが意図的に逆方向へ閉じられているためです。`RouterErrorType` は失敗を分類するもので、その集合は増えることが想定されています。そのため、未知のバケットを厳格に拒否する生成済みクライアントは、まさに何かがすでに失敗したときに最も困ることになります。こちらはライフサイクルであり、後で 4 つ目の状態が追加されるようなライフサイクルは、enum として宣言されているかどうかに関わらず、それに合わせて書かれたすべてのポーリングループにとって破壊的変更になります。そのため enum として宣言し、制約はクライアントから見える場所に明示しています。

型: [`RouterQueueStatus`](#routerqueuestatus)

**queue\_position** `RouterQueuePosition`

レスポンスが構成された時点で、このリクエストよりキューの先頭側に何件のリクエストがあるかを示します。0 はこのリクエストが先頭であることを意味します。

型: [`RouterQueuePosition`](#routerqueueposition) -- 0 以上

**estimate** `RouterCostEstimate`

このリクエストの事前コスト見積もりです。呼び出し元に対してコスト見積もりが有効な場合、新規受け付け時に含まれます。これは、このリクエストがピン留めされたプロバイダーのレッグを見積もります（キューにはフォールバックループがないため、`fallback_provider` が実際に実行されるレッグを変えることはありません）。数値を示せない場合でも `source: unknown` として存在します。見積もりが原因で送信が失敗することはありません。冪等なリプレイ（`Idempotent-Replayed: true`）では省略されます。オリジナルの見積もりは保存されないためです。これは見積もりであり、最終的な請求額でも価格の固定でもありません。実行はレーティング時点で有効な料金で課金され、ワークスペースの使用量および請求記録における確定した請求額が最終となります。

型: [`RouterCostEstimate`](#routercostestimate)

### RouterQueueSubmitResponse

実行がキューに受け入れられたときに返されるハンドル。リクエストの識別情報と状態を、そのライフタイムの残りを扱う3つのURLと組み合わせたものです。

[`RouterQueueUrls`](#routerqueueurls)と[`RouterQueueSubmitFields`](#routerqueuesubmitfields)を合成します。

型: `object`

### RouterQueueUrls

キュー中の1つのリクエストの残りのライフタイムを扱う3つのURLです。有効なハンドルを含むすべてのレスポンスで返されるため、クライアントがキューURLを自分で組み立てることはありません。

**フィールド**

**status\_url** `string` *required*

このリクエストのステータス読み取りの絶対URL。

URI

**response\_url** `string` *required*

このリクエストの結果を取得する絶対URL。

URI

**cancel\_url** `string` *required*

キャンセルを要求する絶対URL。

URI

### RouterValidationErrorContext

検証ルールが失敗した理由について、プロバイダーから提供される詳細。

型: `object`

### RouterValidationErrorDetail

フィールド単位の検証失敗を 1 件表します。

**フィールド**

**loc** `array of any` *required*

問題のあるフィールドへのパス。最も外側のセグメントが先頭になります。たとえば `["body", "image_url"]`、または `["body", "images", 0]` のように、整数は配列のインデックスを指します。

**msg** `string` *required*

この 1 件の失敗について、人間が読める形で説明したもの。

**type** `string` *required*

この失敗の具体的で機械可読な理由。プロバイダーからそのまま変更されずに渡されます。型付き SDK の例外階層が分岐に使う値はこれであり、レスポンスヘッダーの `error_type` はその大まかな分類にすぎません。

**ctx** `RouterValidationErrorContext`

1 つの `RouterValidationErrorDetail` に対して違反した境界値で、プロバイダーからそのまま渡されます。たとえば `greater_than` と一緒に `{"limit_value": 8}`、`image_too_small` と一緒に `{"min_width": 512}`、`file_too_large` と一緒に `{"max_size_bytes": 10485760}` といった形です。キーの集合はプロバイダーとエラータイプに固有であるため、これは意図的にオープンなオブジェクトとしています。固定のフィールドリストに絞り込んだり、`msg` 文字列に折り畳んだりすることこそが、移植したインテグレーションがコンパイルは通るのに、境界値を読んでいた分岐を黙って失う原因そのものです。エラータイプに境界値が伴わない場合、このフィールドは存在しません。

型: [`RouterValidationErrorContext`](#routervalidationerrorcontext)

**input** `RouterValidationErrorInput`

問題のある入力値。呼び出し元が `loc` から再導出しなくても何が拒否されたかを確認できるよう、そのまま返されます。文字列、数値、ブール、配列、オブジェクト、null のいずれの JSON 型でもよいため、このスキーマはオブジェクトに絞り込まず、意図的に型なしのままにしています。プロバイダーが入力をそのまま返さない場合、このフィールドは存在しません。

型: [`RouterValidationErrorInput`](#routervalidationerrorinput)

### RouterValidationErrorInput

プロバイダーが含めている場合の、拒否された入力値です。

### RouterValidationErrorResponse

`422` 検証エラーのレスポンスボディです。カテゴリについては `X-Comfy-Error-Type` を参照してください。

**フィールド**

**detail** `array of RouterValidationErrorDetail` *required*

リクエストで見つかったすべての検証失敗。問題のあるフィールドごとに1つのエントリです。

型: [`RouterValidationErrorDetail`](#routervalidationerrordetail) の配列


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.