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

v2 が動作する場所

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

設計原則

  • ポーリング優先。 すべての機能は、単純な GET ポーリングで利用できます。SSE ストリームはライブ拡張であり、決して真実のソースではありません。
  • すべてが再開可能。 送信は冪等であり、ジョブの状態と出力は expires_at まで ID によって取得できます。
  • コンテンツアドレス型アセット。 アセットは UUID で識別されるレコードであり、その基盤となる blob はサーバーが計算した blake3 ハッシュをキーとします。そのため、同一の入力が 2 回アップロードされることはありません。
  • リンクを辿り、URL を組み立てない。 レスポンスには、フォローアップ URL が埋め込まれています。
これらの根拠については、設計ノート を参照してください。

ベースURL

エンドポイントカテゴリ

Comfy Router

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