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

​
ベース 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

クイックスタート、クレジット、同時実行数の制限。

クラウド API リファレンス

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

Comfy API v2 リファレンス

両方の SDK の基盤となるバージョン管理された HTTP API。任意の言語から利用できます。

OpenAPI 仕様

コード生成のための機械可読な API 仕様。