ワークフローの実行

ComfyUI をどこかにデプロイしたら、アプリケーションはそれを対象にワークフローを実行します。ワークフローを送信し、実行を待ち、出力をダウンロードします。このページでは、どのデプロイにどのクライアントを使うべきかを整理します。

まずはこちら: Comfy SDK

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

Comfy SDK

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

何が何に対応するか

デプロイメント	Comfy SDK / API v2	備考
Comfy API デプロイメント	はい	APIキーを使用して `COMFY_BASE_URL` を `https://<deployment>.run.comfy.app` に設定します
Comfy Cloud	はい	デフォルトのベースURL。APIキーと有料サブスクリプションが必要です
セルフホスト	はい、API Proxy 経由	v2ベータの間は、ComfyUIと並行して動作する小規模なサービスがv2 APIを提供します

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

どのAPIを使うべきか？

	Comfy API v2 + SDK	v1 Cloud API	ComfyUI Server API
実行場所	Comfy API デプロイメント、Comfy Cloud、または API Proxy 経由のセルフホスト	Comfy Cloud のみ	セルフホストのみ
互換性	バージョン管理されており、v2 内では追加的な変更のみ	非推奨。予告なく変更される可能性あり	リリース間での保証なし
認証	Comfy Cloud および Comfy API デプロイメントでは `Authorization: Bearer`。セルフホスト: デフォルトではなし、オプションで静的 bearer トークン	`X-API-Key` ヘッダー（Comfy Cloud アカウント）	なし（ローカル）または Partner Nodes 用の APIキー
公式クライアント	Python および 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、Comfy API デプロイメント、またはパートナーノードを扱うものには APIキーが必要です。完全にローカルで動かす ComfyUI には不要です。
API形式でエクスポートされたワークフロー。

Comfy で開発する