初めてのワークフローを実行する

Comfy Cloud でサンプルワークフローを実行し、Python または TypeScript でその出力をダウンロードします。

コードから完全なワークフローを実行し、その出力を first-result.png として保存します。このサンプルでは、2 つの組み込みノードを使って 512 × 512 の単色の青い画像を作成します。モデル、入力画像、カスタムノードを必要とせずに、認証、ワークフローの実行、出力のダウンロードを検証します。

ホストされたモデルを直接呼び出して画像を生成する場合は、Comfy Router クイックスタートから始めてください。

​

始める前に

• Comfy APIキーを用意します。
• 有料のComfy Cloudサブスクリプションが必要です。CloudのワークフローAPIアクセスは無料プランには含まれていません。
• Python 3.10以降、またはTypeScriptの例を実行する場合はNode.js 22.18以降が必要です。

このガイドでは、SDKのデフォルトの接続先であるComfy Cloudを使用します。以前に COMFY_BASE_URL を設定している場合は、Cloudを使用するために設定を解除してください。既存のComfy APIデプロイメントやセルフホストインスタンスを使用する場合は、ベースURLの選択を参照してください。

​

1. サンプルをダウンロードする

例用のフォルダーを作成します。そのフォルダーに workflow_api.json と、使用する言語のスクリプトをダウンロードしてください:

• Python: first_workflow.py
• TypeScript: first_workflow.mts

ワークフローはすでに API 形式になっています。ノード "1" が青い画像を作成し、ノード "2" がそれを保存します。スクリプトはその SaveImage ノードから正確に出力を読み取るため、ノード ID を探したり編集したりする必要はありません。

​

2. SDKをインストールしてキーを設定する

ファイルを保存したフォルダーでターミナルを開きます。

Python

python -m venv .venv
source .venv/bin/activate
python -m pip install comfy-sdk

Windowsでは、PowerShellで .venv\Scripts\Activate.ps1 を使ってPython環境を有効化します。

同じターミナルでキーを設定します:

macOS / Linux

export COMFY_API_KEY="comfyui-your-key"

APIキーはサーバー環境に保管してください。ブラウザーコードに含めたり、ソース管理にコミットしたりしないでください。

​

3. 実行して結果を確認する

Python

python first_workflow.py

スクリプトはワークフローを送信し、完了を待って、画像をダウンロードします。Saved に続いてパスが出力されたら、その場所にある first-result.png を開いてください。青一色の正方形が表示されるはずです。サンプルをもう一度実行すると、そのローカルファイルは置き換えられます。

これはワークフローの接続確認です。生成モデルは使用しません。同じ送信、待機、ダウンロードの手順は、独自の生成ワークフローでもそのまま使えます。

​

リクエストが失敗した場合

• キーが不足している、または認証エラー: スクリプトを実行しているターミナルで COMFY_API_KEY が設定されており、有効なキーが含まれていることを確認してください。
• アクセスまたはクレジットのエラー: 再試行する前に、Cloud サブスクリプションと利用可能なクレジットを確認してください。
• ワークフローファイルが見つからない: workflow_api.json をダウンロードしたスクリプトの隣に置いてください。
• 予期しないエンドポイント: COMFY_BASE_URL を確認してください。この Cloud の例では設定を解除してください。

エラーの処理とジョブの進捗については、SDK ガイドを参照してください。

​

4. 独自の生成ワークフローを実行する

ComfyUI エディタでワークフローを構築または選択し、そこで正常に実行してから、API フォーマットでエクスポートします。workflow_api.json をエクスポートしたファイルに置き換え、Python では get_outputs("2")、TypeScript では getOutputs("2") を、ワークフローの SaveImage ノード ID を使用するように更新します。対象の環境に、ワークフローが使用するモデルとカスタムノードが揃っていることを確認してください。

独自のモデルとカスタムノードでワークフローをホストするには、Comfy API デプロイメントを作成します。ワークフローの入力を変更する、ファイルをアップロードする、または進行状況を監視するには、Comfy SDKs に続けてください。