Skip to main content
非推奨: v1 Cloud API は、Comfy API v2 を優先するため非推奨となりました。既存の統合や、v2 がまだ公開していないクラウド機能向けには引き続き利用可能ですが、エンドポイントや動作は予告なく変更される場合があります。
v1 Cloud API は、クラウドインフラストラクチャ上でワークフローを実行するための Comfy のマネージドサービスである Comfy Cloud へのプログラムによるアクセスを提供します。 Comfy Cloud はステートフルなアプリケーションです。アカウントには、ジョブをまたいで永続する状態（クレジット、サブスクリプションティア、アップロード済みのアセット、生成済みの出力、ジョブキュー、インストール済みのモデルとノードのセット）が保持されます。v1 API はそのアプリケーション全体のインターフェースであり、キュー管理、モデルブラウジング、ノード定義、アカウントエンドポイントなど、ポータブルな Comfy API v2 ではサポートされていない機能を含みます。ワークフローの送信と結果の取得には、v2（またはそれをラップする SDK）を使用してください。この方法は、サーバーレスデプロイやセルフホスト型 ComfyUI でも機能します。その周辺のクラウド固有の機能には v1 を使用してください。 ワークフローを実行するには、Comfy Cloud クイックスタート と Comfy SDKs から始めてください。クレジットと同時実行制限については Comfy Cloud ページ で説明しています。実行可能な v1 の例は Cloud API リファレンス にあります。このページでは、v1 に固有のインターフェース（認証と、v2 が公開していないエンドポイント）について説明します。
サブスクリプションが必要です: API アクセスには有料の Comfy Cloud サブスクリプションが必須です。無料ティアには含まれません。料金ページをご覧ください。

​
ベース URL

これは SDK のデフォルトのターゲットでもあるため、Comfy Cloud 用に設定する必要はありません。同じコードをサーバーレスデプロイメントやご自身の ComfyUI に向けるには、COMFY_BASE_URL を設定してください。ベース URL の選択 を参照してください。

​
認証

すべての v1 リクエストには、X-API-Key ヘッダーで渡される API キーが必要です：
キーの作成と管理方法については、API キーの取得を参照してください。無効なキーまたは不足しているキーは 401 を返します。アクティブでないサブスクリプションのキーは 429 を返します。 同じキーがパートナーノードでも使用されます。HTTP では、extra_data.api_key_comfy_org に再度渡します。例については、パートナーノードの使用を参照してください。

​
SDKがまだカバーしていない機能

SDKは、ワークフローの実行、結果の取得、およびジョブのキャンセルをカバーしています。クラウドのその他の機能にはHTTP経由でしかアクセスできないため、実行にSDKを使用する場合でも、これらのエンドポイントを直接呼び出してください。 ジョブのキャンセルは、両方の方法でカバーされています。SDKはハンドルを保持しているジョブをキャンセルでき、POST /api/queue はIDでキャンセルします。

​
利用可能なエンドポイント

​
エラーハンドリング

RESTエンドポイントは、標準的なHTTPステータスコードを返します： SDKは、代わりにこれらを型付き例外としてスローします。Unauthorized、InvalidWorkflow、InsufficientCredits、QueueFull、JobFailedなどが含まれ、すべてComfyErrorを継承しています。 実行の失敗はHTTPエラーとは別です。実行中に返されるexception_typeの値については、エラーハンドリングを参照してください。

​
次のステップ

Comfy Cloud

クイックスタート、クレジット、および同時実行制限。

Cloud API リファレンス

curl、Python、TypeScript の例を含む、完全なエンドポイントドキュメント。

Comfy API v2 リファレンス

両方の SDK の基盤となるバージョン付き HTTP API。任意の言語から使用できます。

OpenAPI 仕様

コード生成用の機械可読 API 仕様。