Serverless API

バージョン管理された ComfyUI 環境を構築し、マネージドエンドポイントとしてデプロイして、API 経由でワークフローを実行します。

Serverless API はベータ版です。platform.comfy.org からサインアップしてアクセスをリクエストしてください。

Serverless API は、ComfyUI ワークフローにマネージド URL とオンデマンドの GPU キャパシティを提供します。Build は、ComfyUI 環境のバージョン管理された定義です。ローカルインストールから取得したモデル、カスタムノード、設定が含まれます。Build and Deploy CLI は、ビルド定義をプロジェクト内に保持し、その定義からリリースを作成し、トラフィックを受け付ける準備ができたらリリースをデプロイします。

1. ビルド（Build）

ComfyUI インストールからローカルのビルド定義を作成します。

2. リリース（Release）

Build からイミュータブルな Linux/NVIDIA リリースを切り出します。

3. デプロイ（Deploy）

リリースに URL とマネージド GPU キャパシティを割り当てます。

4. 実行（Run）

アクティブなデプロイメントに API 形式のワークフローを送信します。

​

クイックスタート

ローカルインストールと API 形式のワークフローが準備できたら、次のコマンドを使用します。

compute の出力を使って、有効なリージョンと GPU を選択してください。必要に応じて <region> と l4 を置き換えます。deploy up が表示するデプロイメント ID を最後のコマンドにコピーしてください。

comfy build init --name "my-comfy-build" --models-dir ./models --custom-nodes-dir ./custom_nodes

comfy build push --release --target linux/nvidia
comfy deploy refs compute # get available regions and GPU classes
comfy deploy up --gpu l4 --region <region> --min 1 --max 4 --watch # prints the deployment ID
comfy deploy run --workflow workflow_api.json --deployment <deployment-id> --output-dir ./results

1. 初期化

   comfy build init --name "my-comfy-build" --models-dir ./models --custom-nodes-dir ./custom_nodes
   
2. リリースを作成

   comfy build push --release --target linux/nvidia
   

   このコマンドは Build を同期し、指定したターゲット向けのリリースを作成します。

3. デプロイメントを開始

   利用可能なリージョンと GPU クラスがまだ分からない場合は、まず確認してください。

   comfy deploy refs compute
   

   次に、デプロイメントを作成または調整（reconcile）します。

   comfy deploy up --gpu <gpu> --region <region> --min 1 --max 4 --watch
   

   deploy up は新しいデプロイメント ID を表示します。後から取得する必要がある場合は、この Build の準備完了状態のデプロイメントを一覧表示します。

   comfy deploy ls --status ready
   

   返された dep_... の値を --deployment に指定してください。

4. ワークフローを実行

   comfy deploy run \
     --workflow workflow_api.json \
     --deployment <deployment-id> \
     --output-dir ./results
   

   CLI は API 形式のワークフローを送信し、その出力を ./results にダウンロードします。

​

Buildファイル

comfy-build.yaml は、Buildのローカルにおける唯一の情報ソースです。Buildの定義と最後に確認されたリモート状態を保存するため、CLIは適切なBuildを自動的に選択でき、ローカルの変更が新しいリモート定義を上書きする前に警告を表示できます。

このファイルはプロジェクトと一緒に保管してください。このファイルはBuildを記述するものであり、モデルのバイトデータそのものは含みません。

​

1. Build を初期化する

ローカルの ComfyUI インストールから始めます。このコマンドはモデルとカスタムノードをスキャンし、comfy-build.yaml を書き出します。

comfy build init --name "my-comfy-build" --models-dir ./models --custom-nodes-dir ./custom_nodes

プッシュする前に、ローカル仕様がインストールおよびリモートの Build とどう異なるかを確認します。

comfy build status

​

2. 更新とリリース

ローカルの ComfyUI インストールを変更した後、ローカルのビルド定義を更新します。

comfy build update --yes

最短の手順として、1 つのコマンドで定義をプッシュし、ターゲット向けにリリースできます。

comfy build push --release --target linux/nvidia

既存の Build から別のリリースを作成する必要がある場合は、サポートされているターゲットを確認し、明示的にリリースを切り出します。

comfy build refs build-targets
comfy build release create --target linux/nvidia --watch

特定のリリースのビルドログを追跡するには次を使います。

comfy build release logs rel_123456 --target linux/nvidia --follow

​

リージョンと GPU の可用性

リージョンのキャパシティは変動するため、静的なリストをスクリプトにコピーしないでください。デプロイ先を選ぶ際は、プラットフォームカタログを照会します。

comfy deploy refs compute

結果を絞り込むには --region <region> を使います。

comfy deploy refs compute --region <region>

返された region と gpu のペアを comfy deploy up にコピーしてください。

comfy deploy up --gpu <gpu> --region <region> --min 1 --max 4 --watch

デプロイ時に各リージョンでどの GPU クラスが利用可能かについては、このカタログが信頼できる情報源です。

​

3. リリースをデプロイする

リージョンで利用可能なコンピュートを確認し、選択したリリース向けのデプロイメントを作成または調整します。

comfy deploy refs compute --region US-MO-2

comfy deploy up \
  --gpu l4 \
  --region US-MO-2 \
  --min 1 \
  --max 4 \
  --watch

--min と --max はワーカー数の上下限を設定します。デプロイメントの健全性、リリースの新しさ、サービングの状況を追跡するには comfy deploy status --watch を使います。

​

4. ワークフローを実行する

準備完了状態のデプロイメントに API 形式のワークフローを送信します。

comfy deploy run \
  --workflow workflow_api.json \
  --deployment dep_123456 \
  --output-dir ./results

COMFY_BASE_URL をデプロイメント URL に設定すれば、Comfy SDK からもこのエンドポイントを呼び出せます。SDK リクエストには API キーが必要です。ベース URL の選択を参照してください。

​

デプロイメントの運用

# ワーカー数の上下限を変更
comfy deploy scale --deployment dep_123456 --min 2 --max 5

# デプロイメントのレコードを保持したまま一時停止・再開
comfy deploy stop --deployment dep_123456
comfy deploy start --deployment dep_123456

​

確認とクリーンアップ

# Build の状態
comfy build ls
comfy build show --id bld_123456
comfy build release ls
comfy build release show rel_123456

# デプロイメントの状態
comfy deploy ls --workspace --status ready
comfy deploy logs --deployment dep_123456
comfy deploy events --deployment dep_123456

デプロイメントの削除と Build の削除は、それぞれ独立した取り消し不可能な操作です。comfy deploy delete --yes や comfy build delete --id bld_123456 --yes を実行する前に、対象を確認してください。

​

次のステップ

• Comfy SDK
• Comfy API v2 概要
• ワークフロー API 形式
• Comfy CLI リファレンス