ワークフローの実行

ライブデプロイメントに対してComfyUIワークフローを実行する方法と、各クライアントがどのデプロイメントに対応しているか

#intro

ComfyUI をどこかにデプロイしたら、アプリケーションはその ComfyUI に対してワークフローを実行します。ワークフローを送信し、実行を待ち、出力をダウンロードします。このページでは、どのデプロイ先に対してどのクライアントを使用するかを解説します。

ここから始める：Comfy SDKs

新しい統合には、公式のComfy SDK（PythonおよびTypeScript）と、それらが呼び出すComfy API v2を使用します。同じコードがすべてのデプロイ先で動作し、変更されるのはベースURLだけです。

Comfy SDKs

SDKをインストールし、ワークフローを送信して、出力をダウンロードします。現在はベータ版です。

何が何に対応するか

デプロイメント	Comfy SDKs / API v2	備考
Serverless API デプロイメント	対応	COMFY_BASE_URL を https://<deployment>.run.comfy.app に設定し、APIキーを使用します
Comfy Cloud	対応	デフォルトのベースURLです。APIキーと有料サブスクリプションが必要です
セルフホスト	対応（API Proxy 経由）	v2 ベータ期間中は、ComfyUI と一緒に動作する小さなサービスが v2 API を提供します

セルフホストインスタンスでは、SDK を完全に使わず、生の ComfyUI Server API（REST + WebSocket）を使用することもできます。これにより、キューやノード情報を含むローカルの全機能にアクセスできますが、リリース間の互換性は保証されていません。

どのAPIを使うべきですか？

	Comfy API v2 + SDKs	v1 Cloud API	ComfyUI Server API
実行環境	サーバーレスデプロイ、Comfy Cloud、またはAPIプロキシ経由のセルフホスト	Comfy Cloudのみ	セルフホストのみ
互換性	バージョン管理されており、v2内での追加変更のみ	非推奨。予告なく変更される場合があります	リリース間での保証なし
認証	Cloudとサーバーレスでは Authorization: Bearer。セルフホスト: デフォルトではなし、オプションの静的ベアラートークン	X-API-Key ヘッダー（Comfy Cloudアカウント）	なし（ローカル）またはパートナーノード用のAPIキー
公式クライアント	Python SDKとTypeScript SDK	なし。HTTPで呼び出し	なし。HTTPで呼び出し
プロトコル	REST + SSE	REST + WebSocket	REST + WebSocket
範囲	ワークフローを実行して結果を取得	モデルやアカウントを含むCloudの全機能	キューやノード情報を含むローカルの全機能
最適な用途	今後も動作し続ける必要がある新規インテグレーション	既存のインテグレーションと、v2がまだカバーしていないCloud機能	完全な制御、自分のインスタンスに対するカスタムツール

いずれも同じワークフロー形式（API形式）を受け入れるため、ローカルでワークフローを開発・テストし、変更なしで別のデプロイに移行できます。

はじめに

Comfy SDKs

Python または TypeScript から、あらゆるデプロイ先に対してワークフローを実行します。

セルフホスト向け API プロキシ

自身の ComfyUI の前面で v2 API を提供し、SDK がアクセスできるようにします。

ワークフロー API 形式

API が受け付ける JSON 形式でワークフローをエクスポートします。

ComfyUI サーバー API

セルフホストインスタンスの生の REST および WebSocket API。

前提条件

• Comfy Cloud、サーバーレスデプロイメント、またはパートナーノードに触れるすべてのものには、APIキーが必要です。完全にローカルなComfyUIでは、APIキーは不要です。
• API形式でエクスポートされたワークフロー。