POST /v2/models/{provider}/{model} を使用します。このページでは、モデル間で共通のヘッダーについて説明します。API リファレンスには生成済みのコントラクトが記載されています。
Comfy SDK（Python 用の comfy-sdk、TypeScript 用の @comfyorg/sdk）は認証を処理し、冪等性キーを生成します。以下で説明するように、選択済みのレスポンスメタデータを公開します。生の HTTP クライアントは、ヘッダーを自身で送信し、読み取る必要があります。
リクエストヘッダー
string
Comfy ワークスペースで作成した Comfy APIキー（
comfyui-...）です。ワークスペースのモデルアクセスとクレジット残高を使用します。Authorization: Bearer comfyui-... として送信することもできます。両方のヘッダーが存在する場合は X-API-Key が優先されます。string
Bearer <token>。comfyui- で始まる値はAPIキーです。それ以外の値は Comfy Cloud の JWT として扱われます。string
1つの論理的な生成を識別します。呼び出しの前にUUIDを生成して保存し、変更していないリクエストの再試行時にそれを再利用します。このキーは最大24時間のあいだ、結果を再生したり、受け付けた処理を収集したりできます。SDK はキーを生成しますが、独自のキーを指定することもできます（Python では
idempotency_key=、TypeScript では idempotencyKey）。競合、有効期限、再生できない結果については、再試行の結果を参照してください。string
application/json。モデル固有のJSON入力を送信します。フィールドと検証要件はモデルによって異なります。Router API の使用を参照してください。string
GET /v2/models/{provider}/{model}/openapi.json でのみ使用します。以前の 200 で受け取った ETag を送信します。それがまだ一致する場合、応答は同じ ETag を持つボディなしの 304 になります。モデルのスキーマはプロセスの存続期間中キャッシュし、呼び出しのたびに読み直すのではなく、この方法で再検証してください。レスポンスヘッダー
string
必須
この HTTP リクエストを識別します。サポートに問い合わせる際はこれを含めてください。TypeScript では
requestId として公開され、Python ではエラー時に request_id として公開されます。string
機械可読なエラーカテゴリ。
422 の場合は、検証ボディに detail[] があり error_type がないため、このヘッダーを使用します。HTTP ステータスと結合して、どう処理するかを判断してください。不明な値は制御フローでは internal_error として扱い、診断用にはそのまま保持してください。boolean
Router がモデルを再実行せずに保存済みの結果を返す場合に存在し、
true になります。新規実行時には存在しません。integer
再試行する前に待機する秒数。
409 / concurrency_limit_exceeded または 504 / deadline_exceeded の場合は、待機後に同じリクエストと同じキーで再試行してください。429 / rate_limited の場合は、レート制限がいつリセットされるかを示します。integer
まだ実行中の呼び出しに対して確定したパートナー支出の上限（USD セント）。強制する spend gate は、許可されたレスポンスとその
429 拒否の両方でこれを返すことがあります。gate が強制していない場合、または別の制御がリクエストを拒否した場合は存在しません。integer
現在実行中の呼び出しに対して確定している USD セント。許可されたレスポンスには自身の呼び出しが含まれ、
429 には拒否された呼び出しは含まれません。X-Committed-Spend-Limit とともに送信されます。integer
確定支出の上限を下回って残っている USD セント。要求された呼び出しのコストが残量を超える場合、拒否時でも正の値になることがあります。
string
GET /v2/models/{provider}/{model}/openapi.json に対して。これを保存し、キャッシュされたスキーマを再検証するために If-None-Match として送り返してください。string
スキーマルートに対しては
private, must-revalidate。レスポンスをプライベートキャッシュに保持し、古いコピーを ETag で再検証してください。2つの意味を持つステータスコード
3つのステータスが2つのバケットで共有されており、それらを見分けるのがこのヘッダーです:次のステップ
- クイックスタート: リクエストを送信して結果を読み取ります。
- Comfy Router API の使用: モデルの検出、スキーマ、エラー、リトライ、課金について。
- API リファレンス: これらのヘッダーが定義されている生成済みコントラクト。
- 制限事項: Router が現時点で行わないこと、および代わりに使用すべきもの。