> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-willie-des-1087-router-migration-block.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

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

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

<Warning>
  Comfy API のデプロイはベータ版です。[platform.comfy.org](https://platform.comfy.org) からサインアップしてアクセスをリクエストしてください。
</Warning>

Comfy API では、ComfyUI ワークフローを、オンデマンドの GPU キャパシティを備えたマネージド型のオートスケーリングエンドポイントとしてデプロイできます。**Build** は、ローカルインストールから取り込んだモデル、カスタムノード、設定で構成される、バージョン管理された ComfyUI 環境の定義です。Build and Deploy CLI は、Build 定義をプロジェクト内に保持し、その定義からリリースを作成し、トラフィックを受け付ける準備ができたらリリースをデプロイします。

<CardGroup cols={2}>
  <Card title="1. ビルド（Build）" icon="box">
    ローカルの ComfyUI インストールから Build 定義を作成します。
  </Card>

  <Card title="2. リリース（Release）" icon="tag">
    Build からイミュータブルな Linux/NVIDIA リリースを切り出します。
  </Card>

  <Card title="3. デプロイ（Deploy）" icon="cloud-arrow-up">
    リリースに URL とマネージド GPU キャパシティを割り当てます。
  </Card>

  <Card title="4. 実行（Run）" icon="code">
    アクティブなデプロイメントに API 形式のワークフローを送信します。
  </Card>
</CardGroup>

## クイックスタート

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

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

```bash theme={null}
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
```

<Steps>
  <Step title="初期化">
    ```bash theme={null}
    comfy build init --name "my-comfy-build" --models-dir ./models --custom-nodes-dir ./custom_nodes
    ```
  </Step>

  <Step title="リリースを作成">
    ```bash theme={null}
    comfy build push --release --target linux/nvidia
    ```

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

  <Step title="デプロイメントを開始">
    利用可能なリージョンと GPU クラスがまだ分からない場合は、まず確認します。

    ```bash theme={null}
    comfy deploy refs compute
    ```

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

    ```bash theme={null}
    comfy deploy up --gpu <gpu> --region <region> --min 1 --max 4 --watch
    ```

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

    ```bash theme={null}
    comfy deploy ls --status ready
    ```

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

  <Step title="ワークフローを実行">
    ```bash theme={null}
    comfy deploy run \
      --workflow workflow_api.json \
      --deployment <deployment-id> \
      --output-dir ./results
    ```

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

## ビルドファイル

`comfy-build.yaml` は Build のローカルにおける信頼できる情報源（source of truth）です。ビルド定義と最後に確認したリモートの状態を保存しているため、CLI は適切な Build を自動的に選択し、ローカルの変更がより新しいリモート定義を上書きしそうな場合に警告できます。

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

## 1. Build を初期化する

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

```bash theme={null}
comfy build init --name "my-comfy-build" --models-dir ./models --custom-nodes-dir ./custom_nodes
```

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

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

## 2. 更新とリリース

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

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

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

```bash theme={null}
comfy build push --release --target linux/nvidia
```

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

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

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

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

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

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

```bash theme={null}
comfy deploy refs compute
```

結果をフィルタするには `--region <region>` を使います。

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

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

```bash theme={null}
comfy deploy up --gpu <gpu> --region <region> --min 1 --max 4 --watch
```

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

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

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

```bash theme={null}
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 形式のワークフロー](/ja/development/api-development/workflow-api-format)を送信します。

```bash theme={null}
comfy deploy run \
  --workflow workflow_api.json \
  --deployment dep_123456 \
  --output-dir ./results
```

`COMFY_BASE_URL` にデプロイメントの URL を設定すれば、[Comfy SDK](/ja/development/api-development/sdks) からもこのエンドポイントを呼び出せます。SDK のリクエストには引き続き API キーが必要です。詳しくは[ベース URL の選択](/ja/development/api-development/sdks#ベースurlの選択)を参照してください。

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

```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}
# 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
```

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

## FAQ

<AccordionGroup>
  <Accordion title="Comfy API デプロイメントでは何が提供されますか？">
    Comfy API デプロイメントは、API 形式のワークフローを実行するためのマネージドでオートスケーリングなエンドポイントです。ワークフローは `comfy deploy run` または [Comfy SDK](/ja/development/api-development/sdks) で送信します。
  </Accordion>

  <Accordion title="1 つの Build を複数のワークフローから作成できますか？">
    はい。Builder では、1 つ以上のワークフローをアップロードして、そのモデルとカスタムノードを事前に選択できます。実行する予定のすべてのワークフローで必要となる依存関係を含めてから、各 API 形式のワークフローをデプロイ済みのエンドポイントに送信します。

    各デプロイメントは 1 つの GPU タイプを使用します。異なる GPU タイプでワークフローを実行するには、同じ Build を個別のデプロイメントとして作成します。
  </Accordion>

  <Accordion title="デプロイしていない Build の保存に料金はかかりますか？">
    いいえ。Build とそのリリースは、アカウントに無料で保存されます。デプロイするまで、Build のストレージ使用量に対して課金されることはありません。

    ストレージの課金はデプロイメントから始まります。

    * リリースをデプロイすると、そのモデルはデプロイメントのワーカーが共有するネットワークストレージにステージングされます。このストレージはデプロイ後は読み取り専用となり、そのリージョンにその Build のデプロイメントが存在する限り、GB 月単位で課金されます。`comfy deploy stop` でデプロイメントが一時停止されている間も含まれます。
    * 各ワーカーには固定の 50 GB のコンテナディスクも割り当てられます。これはエフェメラルであり、ワーカーのコンピューティングコストの一部として、ワーカーが稼働している間のみ課金されます。
    * デプロイメントを削除すると、そのコンピューティングが解放されます。ステージングされたネットワークストレージは、そのリージョンでそれを使用する最後のデプロイメントが削除された直後にクリーンアップされ、課金が終了します。

    現在のストレージ料金については、[Comfy 料金ページ](https://www.comfy.org/pricing)を参照してください。コンピューティングカタログ（`comfy deploy refs compute`）とデプロイダイアログにも、デプロイメントに適用される料金が表示されます。
  </Accordion>

  <Accordion title="アクティブワーカーはどのように課金され、時間単価はいくらですか？">
    `--min` は**アクティブワーカー**の数を設定します。アクティブワーカーとは、リクエストがコールドスタートを待つことがないように常時稼働し続けるワーカーです。アクティブワーカーは、ジョブを処理しているかどうかに関わらず、稼働しているすべての時間に対して秒単位で課金されます。

    `--min` を超え `--max` までのワーカーは**フレックスワーカー**です。フレックスワーカーは、起動した瞬間（起動とモデルの読み込みを含む）からジョブ処理を経て、スケールダウンするまでの短いアイドルウィンドウ（現在は 30 秒）まで、秒単位で課金されます。フレックスワーカーがスケールダウンすると、コストはかかりません。`--min 0` の場合、デプロイメント全体がゼロにスケールし、アイドル中はコンピューティングの課金は発生しませんが、最初のリクエストでコールドスタートが発生します。

    課金は、実際のワーカーの秒単位の使用量に、稼働しているワーカー数を掛けて計測されます。ワークスペースのクレジットが不足すると、デプロイメントは自動的に停止されます。

    ワーカーごとの現在の GPU 料金については、[Comfy 料金ページ](https://www.comfy.org/pricing)を参照してください。料金はワーカー時間あたりで示され、秒単位で課金されます。リージョンごとの GPU の利用可否はコンピューティングカタログから取得できます。現在のリストを確認するには `comfy deploy refs compute` を実行してください。
  </Accordion>

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

  <Accordion title="プロビジョニングに時間がかかる場合はどうすればよいですか？">
    デプロイメントの状態を確認し、そのログとイベントを調べて原因を特定します。

    ```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>

  <Accordion title="デプロイメントを削除するとどうなりますか？">
    デプロイメントを削除すると、そのエンドポイントが削除され、コンピューティングが解放されます。Build やそのリリースは削除されません。あるリージョンでその Build を使用する最後のデプロイメントを削除すると、ステージングされたネットワークストレージがクリーンアップされ、その後まもなくストレージの課金が終了します。

    Build の削除は別の操作です: `comfy build delete --id <build-id> --yes`。
  </Accordion>
</AccordionGroup>

## 次のステップ

* [Comfy SDK](/ja/development/api-development/sdks)
* [Comfy API v2 の概要](/ja/api-reference/v2/overview)
* [ワークフロー API フォーマット](/ja/development/api-development/workflow-api-format)
* [Comfy CLI リファレンス](/ja/comfy-cli/reference)