> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Comfy API：サーバーレスデプロイ

> Comfy API で ComfyUI ワークフローをマネージド GPU エンドポイントとしてデプロイします。Build、リリース、リージョン、ワーカーのスケーリング、ワークスペース制限、デプロイの監視を解説。

Comfy API を使うと、アプリケーションからマネージドエンドポイント経由で ComfyUI ワークフローを実行できます。ワークフローに必要な ComfyUI のバージョン、モデル、カスタムノード、依存関係をパッケージ化すると、Comfy がマネージド GPU 上で実行します。環境を再現可能に保ち、アプリケーションから呼び出せるエンドポイントが必要な場合に使います。

## プラットフォームの概念

| 概念 | 意味 |
| - | - |
| **ワークスペース** | メンバー、Build、デプロイ、使用上限を管理するチームアカウントです。 |
| **Build** | ComfyUI の環境定義です。バージョン、モデル、カスタムノード、依存関係を含みます。 |
| **Build バージョン / リリース** | `linux/nvidia` などのデプロイターゲット向けに用意された、番号付きの Build バージョンです。 |
| **デプロイ** | リリースを使用する実行中のエンドポイントです。独自の GPU、リージョン、ワーカー設定を持ちます。 |

[Comfy Cloud](https://docs.comfy.org/ja/development/deploy/cloud.md) でサポートされるワークフローは、Build やデプロイを作成せずにそこで実行できます。

新しい Build を作成せずにモデルをデプロイへ追加するには、ワークスペースライブラリにアップロードします。詳しくは [独自の LoRA やモデルを追加する](https://docs.comfy.org/ja/development/deploy/cloud-custom-builds.md#自分の-lora-やモデルを追加する) を参照してください。

> [card] [Comfy API クイックスタート](https://docs.comfy.org/ja/development/serverless/quickstart)
>
> エージェントから始めるか、環境やワークフローを用意する別の方法を選んでください。

デスクトップのスナップショットとワークフロー JSON のインポートについては、[Build Sources](https://docs.comfy.org/ja/development/serverless/build-sources) を参照してください。

## ビルドファイル

`comfy-build.yaml` は Build 定義と最後に確認したリモートの状態を保存します。CLI はその状態を使って、リモートの Build が変更されたかどうかを検出します。このファイルはプロジェクトと一緒に管理してください。環境を記述するものであり、モデルファイルは含みません。

変更をプッシュする前に、ローカルの Build がインストール済みの内容やリモートのバージョンとどう違うかを確認します：

```bash theme={null}
comfy build status
```

## 更新とリリース

ローカルのインストールを変更した後は、Build 定義を更新します：

```bash theme={null}
comfy build update --yes
```

既存の Build から別のリリースを作成するには、サポートされているターゲットを確認して 1 つ選択します：

```bash theme={null}
comfy build refs build-targets
comfy build release create --target linux/nvidia --watch
```

1 つのリリースのビルドログを追うには：

```bash theme={null}
comfy build release logs rel_123456 --target linux/nvidia --follow
```

## リージョンと GPU の可用性

リージョンのキャパシティは変化するため、デプロイ先を選ぶ際はプラットフォームのカタログを確認してください。結果は `--region <region>` でフィルタします:

```bash theme={null}
comfy deploy refs compute --region <region>
```

デプロイ時に各リージョンでどの GPU クラスが利用可能かについては、カタログがソースオブトゥルースとなります。

## ワークスペースの制限

ワークスペースの使用量とプランの上限については、[制限](https://platform.comfy.org/profile/limits)を参照してください。`--max` はデプロイメントごとのワーカー上限内に収めてください。

## デプロイの監視と呼び出し

`--min` と `--max` オプションはワーカーの下限と上限を設定します。デプロイのヘルス、リリースの最新性、サービングのアクティビティを追跡するには、`comfy deploy status --watch` を実行します。

[Comfy SDK](https://docs.comfy.org/ja/development/api-development/sdks.md) を使用してエンドポイントを呼び出すこともできます。`COMFY_BASE_URL` にデプロイの URL を設定し、APIキーを指定します。詳細は[ベース URL の選択](https://docs.comfy.org/ja/development/api-development/sdks.md#ベースurlの選択)を参照してください。

## APIリクエストでワークスペースライブラリのモデルを使用する

デプロイでは、リリースに含まれていない場合でも、ワークスペースライブラリの `.safetensors` モデルが実行されます。Comfy Cloud エディタまたは Developer Platform でモデルをアップロードするには、[独自の LoRA またはモデルの追加](https://docs.comfy.org/ja/development/deploy/cloud-custom-builds.md#自分の-lora-やモデルを追加する)を参照してください。

ターミナルからアップロードするには、`--type` でモデルタイプを設定し、ファイルがライブラリにあることを確認します。

```bash theme={null}
comfy assets library upload my_style.safetensors --type loras
comfy assets library ls --tags models,loras
```

[API形式のワークフロー](https://docs.comfy.org/ja/development/api-development/workflow-api-format.md)では、ローダーの入力を、`.safetensors` を含むライブラリのファイル名に設定します。

```json theme={null}
"10": {
  "class_type": "LoraLoader",
  "inputs": {
    "lora_name": "my_style.safetensors",
    "strength_model": 1.0,
    "strength_clip": 1.0,
    "model": ["4", 0],
    "clip": ["4", 1]
  }
}
```

ワークフローは `comfy deploy run`、[Comfy SDK](https://docs.comfy.org/ja/development/api-development/sdks.md)、または [Comfy API v2](https://docs.comfy.org/ja/api-reference/v2/overview.md) で送信します。

```bash theme={null}
comfy deploy run --deployment <deployment-id> --workflow workflow_api.json
```

別の LoRA を使用するには、次のリクエストで `lora_name` を別のライブラリのファイル名に変更します。新しいビルド、リリース、再デプロイは必要ありません。

* ワークフローは最大 100 個のライブラリモデルを指定できます。101 個目のライブラリモデルを指定したローダーは、ファイルがライブラリに存在しない場合と同様に失敗します。
* 1 つのローダーが読み取るフォルダ間でファイル名を一意に保ってください。ライブラリ内の 2 つのフォルダに同じファイル名が存在する場合、API 経由で送信されたジョブはどちらのファイルも読み込みません。

## デプロイメントの運用

```bash theme={null}
# ワーカーの下限と上限を変更する
comfy deploy scale --deployment dep_123456 --min 2 --max 5

# デプロイメントの記録を保持したまま一時停止または再開する
comfy deploy stop --deployment dep_123456
comfy deploy start --deployment dep_123456
```

## 検査とクリーンアップ

```bash theme={null}
# ビルドの状態
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
```

> [!WARNING]
>
> デプロイメントの削除とビルドの削除は、それぞれ別個の不可逆的な操作です。`comfy deploy delete --yes` または `comfy build delete --id bld_123456 --yes` を使用する前に、対象を確認してください。

## FAQ

> [accordion] 1 つの Build を複数のワークフローから作成できますか？
>
> はい。Builder では、1 つ以上のワークフローをアップロードして、そのモデルとカスタムノードをあらかじめ選択できます。実行する予定のすべてのワークフローが必要とする依存関係を含めてから、API フォーマットの各ワークフローをデプロイ済みのエンドポイントに送信します。
>
> 各デプロイメントは 1 つの GPU タイプを使用します。異なる GPU タイプでワークフローを実行するには、同じ Build のデプロイメントを別々に作成します。

> [accordion] デプロイしていない Build の保存に料金はかかりますか？
>
> いいえ。Build とそのリリースは、アカウントに無料で保存されます。デプロイするまで、Build のストレージ使用量に対して課金されることはありません。
>
> ストレージの課金はデプロイメントから始まります：
>
> * リリースをデプロイすると、そのモデルはデプロイメントのワーカーが共有するネットワークストレージに配置されます。このストレージはデプロイ後は読み取り専用となり、そのリージョンにその Build のデプロイメントが存在する限り、`comfy deploy stop` でデプロイメントが一時停止している間も含めて、GB 月単位で課金されます。ジョブが[ワークスペースライブラリ](https://docs.comfy.org/ja/development/deploy/cloud-custom-builds.md#自分の-lora-やモデルを追加する)から利用するモデルは、そこには配置されません。ワーカーがジョブのためにそれらをダウンロードします。
> * 各ワーカーには固定 50 GB のコンテナディスクも割り当てられます。これは一時的なもので、ワーカーのコンピュートコストの一部として、ワーカーの実行中のみ課金されます。
> * デプロイメントを削除すると、そのコンピュートが解放されます。配置されたネットワークストレージは、そのリージョンでそれを使用している最後のデプロイメントが削除された後、まもなくクリーンアップされ、その課金も終了します。
>
> 現在のストレージ料金については、[Comfy 料金ページ](https://www.comfy.org/pricing)をご覧ください。コンピュートカタログ（`comfy deploy refs compute`）とデプロイダイアログにも、デプロイメントに適用される料金が表示されます。

> [accordion] アクティブワーカーはどのように課金され、時間単価はいくらですか？
>
> `--min` は**アクティブワーカー**の数を設定します。アクティブワーカーとは、リクエストがコールドスタートを待つことがないよう常時稼働するワーカーです。アクティブワーカーは、ジョブを処理しているかどうかに関係なく、実行している間ずっと秒単位で課金されます。
>
> `--min` を超えて `--max` までのワーカーは**フレックスワーカー**です。フレックスワーカーは、起動時（起動処理とモデルの読み込みを含む）から、ジョブの処理を経て、スケールダウンする前の短いアイドルウィンドウ（現在は 30 秒）まで、秒単位で課金されます。フレックスワーカーがスケールダウンすると、コストはかかりません。`--min 0` の場合、デプロイメント全体がゼロにスケールし、アイドル中はコンピュートの課金が発生しませんが、最初のリクエストでコールドスタートが発生します。
>
> 課金は、実際のワーカーの秒単位の使用量に、実行中のワーカー数を掛けて計測されます。ワークスペースのクレジットが不足すると、デプロイメントは自動的に停止されます。
>
> 現在のワーカーあたりの GPU 料金については、[Comfy 料金ページ](https://www.comfy.org/pricing)をご覧ください。料金はワーカー時間あたりで提示され、秒単位で課金されます。リージョンごとの GPU の可用性はコンピュートカタログから取得できます。現在のリストを確認するには `comfy deploy refs compute` を実行してください。

> [accordion] デプロイメントは複数のリクエストをどのように処理しますか？
>
> デプロイメントは、リクエストをワーカー間で自動的に分散し、設定された `--min` と `--max` の範囲内でスケールします。すぐに実行できないリクエストはキューに入り、ワーカーのキャパシティが空き次第処理されます。

> [accordion] プロビジョニングに時間がかかる場合はどうすればよいですか？
>
> デプロイメントの状態を追跡し、次にそのログとイベントを調べて原因を特定してください：
>
> ```bash theme={null}
> comfy deploy status --deployment <deployment-id> --watch
> comfy deploy logs --deployment <deployment-id>
> comfy deploy events --deployment <deployment-id>
> ```
>
> 選択済みの GPU またはリージョンにキャパシティがない場合は、後で再試行するか、`comfy deploy refs compute` を実行して利用可能なリージョンと GPU のペアを選択してください。サポートを依頼する際は、Build、リリース、デプロイメントの ID を添えてください。

> [accordion] デプロイメントを削除するとどうなりますか？
>
> デプロイメントを削除すると、そのエンドポイントが削除され、コンピュートが解放されます。Build やそのリリースは削除されません。あるリージョンでその Build を使用する最後のデプロイメントを削除すると、配置されたネットワークストレージはクリーンアップされ、その後まもなくストレージの課金が終了します。
>
> Build の削除は別の操作です：`comfy build delete --id <build-id> --yes`。

## 次のステップ

> [card] [Comfy SDKs](https://docs.comfy.org/ja/development/api-development/sdks.md)
>
> Python または TypeScript のアプリから使用して、ワークフローを送信し、入力、進行状況、出力を処理します。

> [card] [Comfy API v2](https://docs.comfy.org/ja/api-reference/v2/overview.md)
>
> HTTP API を直接呼び出す場合や、そのリクエストとレスポンスの形式を確認する場合に、任意の言語から使用します。

> [card] [ワークフロー API 形式](https://docs.comfy.org/ja/development/api-development/workflow-api-format.md)
>
> API リクエスト用のワークフロー JSON を準備するときや、その入力と出力をトラブルシューティングするときに使用します。

> [card] [Comfy CLI リファレンス](https://docs.comfy.org/ja/comfy-cli/reference.md)
>
> ターミナルから Build、リリース、デプロイメント、ワークフローのコマンドを自動化するために使用します。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.