Skip to main content
ベータ: Comfy API v2 は 0.1.x であり、API サーフェスはまだ変更される可能性があります。v2 内の変更は追加的なものになります。破壊的な変更がある場合は v3 としてリリースされます。
外部アプリケーションから ComfyUI ワークフローを実行するための、公式のバージョン管理された HTTP API です。入力のアップロード、ワークフローの送信、実行の監視、結果の取得を行うことができます。 ほとんどのユーザーは、この API を Python と TypeScript でラップした Comfy SDK から始めることをお勧めします。別の言語で開発している場合は、これらのエンドポイントを直接呼び出してください。 このセクションの API Reference ページに、OpenAPI 仕様から生成された完全なエンドポイントドキュメントがあります。

v2 が動作する場所

同じ API は 3 つのサーフェスで提供されているため、ベース URL を変更するだけで 1 つの統合をそれらの間で移行できます。 Comfy Cloud。 https://cloud.comfy.org で提供されるマネージド型のマルチテナントサービスです。API キー を作成すれば、任意のワークフローを送信できます。クレジット、モデルの閲覧、キューの管理といった Cloud 固有の機能は v2 ではなく v1 Cloud API にあります。 Comfy API デプロイメント。 Developer Platform を通じてデプロイした環境には、https://{deployment}.run.comfy.app という専用のエンドポイントが割り当てられ、同じ API キーで同じ v2 API を提供します。Comfy API デプロイメントは 1 つの固定された環境に対してワークフローを実行するため独立してスケールし、GET /workflow は実行されたグラフを返します。構築とデプロイの手順については、Comfy API デプロイメントガイド を参照してください。 オープンソースの ComfyUI(プロキシ経由)。 ベータ期間中、セルフホストの ComfyUI は comfy-api-proxy を通じて v2 を利用できます。これは ComfyUI と並行して動作する小規模なオープンソースサービスです:
デフォルトでは 127.0.0.1:8188 の ComfyUI をプロキシし、127.0.0.1:8189 で v2 API を提供して、ループバックにのみバインドします。認証はデフォルトで無効であり、オプションで静的なベアラートークンを使用できます。このプロキシは暫定的な手段です。v2 が安定すれば ComfyUI のコアに統合され、プロキシは不要になります。設定の詳細については、SDK ガイドの 独自の ComfyUI を参照してください。

設計原則

  • ポーリング優先。 すべての機能は、単純な GET ポーリングで利用できます。SSE ストリームはライブ拡張機能であり、正本(source of truth)にはなりません。
  • すべて再開可能。 送信は冪等であり、ジョブの状態と出力は expires_at まで ID で取得できます。
  • コンテンツアドレス型アセット。 アセットは、サーバーが計算した blake3 ハッシュをキーとする blob 上の UUID 識別レコードです。そのため、同一の入力が 2 回アップロードされることはありません。
  • URL を組み立てず、リンクに従う。 レスポンスには後続の URL が埋め込まれています。
これらの背景にある設計上の理由については、設計メモ を参照してください。

ベース URL

エンドポイントのカテゴリ

Comfy Router

Comfy API v2 は、送信してポーリングする永続的なジョブとしてワークフローを実行します。モデルを直接呼び出す場合(パートナーモデル 1 つ、リクエスト 1 つ、モデル固有のネイティブな入出力)は、Comfy Router をご覧ください。先に Router の制限事項 をご確認ください。Router はまだ一般提供されていません。