Comfy Cloud API
Comfy Cloud API は、Comfy Cloud インフラストラクチャ上でワークフローを実行するためのプログラムによるアクセスを提供します。この API はローカルの ComfyUI の API と互換性があり、既存の統合を簡単に移行できます。 Python または TypeScript で作業している場合は、Comfy SDKs を使用してください。これらの SDK はこの API をラップしており、ワークフローを実行するための最短の方法です。このページでは、Comfy Cloud に固有の内容(APIキー、クレジット、同時実行制限)について説明します。その他の内容はCloud API リファレンスに記載されています。サブスクリプションが必要: API へのアクセスは Standard、Creator および Pro ティアで利用可能です。Free ティアには API アクセスは含まれません。詳細は料金ページをご覧ください。
クレジットと使用量
API リクエストは、Comfy Cloud のウェブ UI と同じ月間クレジット枠から消費されます。API 専用のクレジットプールはありません。各ティアに含まれるクレジット、追加購入オプション、ワークフロー単位のランタイム上限は、API ジョブにも UI ジョブと同じ条件で適用されます。Standard、Creator、Pro の各ティアの月間クレジット数については、料金ページを参照してください。月の途中でクレジットが不足した場合、アカウントダッシュボードから追加購入できます。ベース URL
COMFY_BASE_URL を設定してください。ベース URL の選択 を参照してください。
認証
すべての API リクエストには API キーが必須です。生の HTTP ではX-API-Key ヘッダーで渡します。SDK では、API キーをクライアントに一度渡すだけで、クライアントがすべてのリクエストを認証します。
API キーの取得
クラウド API キーの作成と管理方法については、API キーの取得を参照してください。API キーの使用
401 を返し、SDK では Unauthorized としてスローされます。アクティブでないサブスクリプションのキーは 429 を返します。
同じキーがパートナーノードでも使用されます。HTTP では、extra_data.api_key_comfy_org に再度渡します。SDK では、submit() に api_key を渡すと自動的に処理されます。
ワークフローの実行
ワークフローは API 形式(ComfyUI フロントエンドの「ワークフローをエクスポート(API)」オプションが生成する JSON)で送信されます。ワークフローを送信すると、ジョブは非同期で実行され、完了時に出力をダウンロードします。Comfy SDKs
Python または TypeScript で、SDK のインストール、ワークフローの送信、進捗状況のリアルタイム追跡、出力の保存ができます。ここから始めましょう。
並列実行(同時ジョブ)
API ユーザーは、前のジョブの完了を待たずに複数のワークフローを同時に送信できます。ジョブが受け入れられるとすぐに送信が返されるため、複数のジョブを進行中に保つことができます。ディスパッチャは、サブスクリプション階層の上限までそれらを並列に実行します。
同時実行制限を超えて送信されたジョブは、通常どおりキューに入り、スロットが空き次第自動的に実行されます。キュー自体が満杯の場合、SDK は
QueueFull を発生させる前に、限られた回数だけ再試行します。
並列実行は現在、API 経由でのみ利用可能です。サブスクリプションの詳細については、料金ページ を参照してください。
SDKがまだカバーしていない機能
SDKが行うことは1つだけです。ワークフローを実行し、結果を取得することです。クラウドのその他の機能にはHTTP経由でしかアクセスできないため、実行にSDKを使用する場合でも、これらのエンドポイントを直接呼び出してください。
ジョブのキャンセルは、両方の方法でカバーされています。SDKはハンドルを保持しているジョブをキャンセルでき、
POST /api/queue はIDでキャンセルします。
利用可能なエンドポイント
エラーハンドリング
RESTエンドポイントは、標準的なHTTPステータスコードを返します:
SDKは、代わりにこれらを型付き例外としてスローします。
Unauthorized、InvalidWorkflow、InsufficientCredits、QueueFull、JobFailedなどが含まれ、すべてComfyErrorを継承しています。
実行の失敗はHTTPエラーとは別です。実行中に返されるexception_typeの値については、エラーハンドリングを参照してください。
次のステップ
Comfy SDKs
Python または TypeScript からワークフローを実行できます。アセット、ライブイベント、型付きエラーに対応しています。
Cloud API リファレンス
curl、Python、TypeScript の例を含む、完全なエンドポイントドキュメント。
Comfy API v2 リファレンス
両方の SDK の基盤となるバージョン付き HTTP API。任意の言語から使用できます。
OpenAPI 仕様
コード生成用の機械可読 API 仕様。