ComfyUI API スキル

ComfyUI の REST API に接続してワークフローを実行し、進捗を監視し、出力を取得します。

設定

• デフォルト URL: http://127.0.0.1:8188
• カスタム URL: プロジェクトマニフェストで設定するか、パラメータとして渡します
• タイムアウト: API 呼び出しは 30 秒、生成ポーリングはタイムアウトなし

2 つのモード

オンラインモード (ComfyUI 実行中)

完全な API アクセス。インタラクティブな作業に推奨されるモード。

1. 接続テスト: GET /system_stats
2. 機能の確認: comfyui-inventory スキルを使用
3. ワークフローをキューに追加: POST /prompt
4. 結果をポーリング: 5 秒ごとに GET /history/{prompt_id}
5. 出力を取得: GET /view?filename=...

オフラインモード (サーバーなし)

ComfyUI に手動で読み込むためのワークフロー JSON をエクスポート。

1. ComfyUI 形式に従ってワークフロー JSON を生成
2. projects/{project}/workflows/{name}.json に保存
3. ユーザーに ComfyUI にドラッグ&ドロップするよう指示

API 操作

サーバーステータスを確認

curl http://127.0.0.1:8188/system_stats

レスポンスフィールド:

• system.os: オペレーティングシステム
• system.comfyui_version: バージョン文字列
• devices[0].name: GPU 名
• devices[0].vram_total: 合計 VRAM バイト数
• devices[0].vram_free: 空き VRAM バイト数

ワークフローをキューに追加

curl -X POST http://127.0.0.1:8188/prompt \
  -H "Content-Type: application/json" \
  -d '{"prompt": WORKFLOW_JSON, "client_id": "video-agent"}'

WORKFLOW_JSON 形式:

{
  "1": {
    "class_type": "LoadCheckpoint",
    "inputs": {
      "ckpt_name": "flux1-dev.safetensors"
    }
  },
  "2": {
    "class_type": "CLIPTextEncode",
    "inputs": {
      "text": "photorealistic portrait...",
      "clip": ["1", 1]
    }
  }
}

各ノードは文字列 ID でキー化されます。入力は他のノードを ["{node_id}", {output_index}] として参照します。

レスポンス:

{"prompt_id": "abc-123-def", "number": 1}

完了をポーリング

curl http://127.0.0.1:8188/history/abc-123-def

未完了: {} (空のオブジェクト) を返す 完了: 出力を含む実行データを返す:

{
  "abc-123-def": {
    "outputs": {
      "9": {
        "images": [{"filename": "ComfyUI_00001.png", "subfolder": "", "type": "output"}]
      }
    },
    "status": {"completed": true}
  }
}

出力画像を取得

curl "http://127.0.0.1:8188/view?filename=ComfyUI_00001.png&subfolder=&type=output" -o output.png

参照画像をアップロード

curl -X POST http://127.0.0.1:8188/upload/image \
  -F "image=@reference.png" \
  -F "subfolder=input" \
  -F "type=input"

現在の生成をキャンセル

curl -X POST http://127.0.0.1:8188/interrupt

VRAM を解放

curl -X POST http://127.0.0.1:8188/free \
  -H "Content-Type: application/json" \
  -d '{"unload_models": true}'

ポーリング戦略

ComfyUI は CLI コンテキストで WebSocket をサポートしていません。REST ポーリングを使用してください:

1. POST /prompt でワークフローをキューに追加 → prompt_id を取得
2. 5 秒ごとに GET /history/{prompt_id} をポーリング
3. 空のレスポンス時: 生成が進行中、ポーリングを継続
4. 入力されたレスポンス時: status.completed を確認
5. completed: true の場合、出力を抽出
6. ステータスにエラーがある場合、comfyui-troubleshooter にルーティング

タイムアウト: 10 分間のポーリング後にユーザーに警告。ビデオ生成 (Wan 14B) は 15～30 分かかる可能性があります。

ワークフロー検証

ワークフローをキューに追加する前に:

1. state/inventory.json を読む (comfyui-inventory 経由)
2. ワークフロー内の各ノード: インストール済みノードに class_type が存在することを確認
3. 各モデル参照: インストール済みモデルにファイルが存在することを確認
4. 不足している項目にフラグを付ける:
   • ノード: ComfyUI-Manager インストールコマンドを提案
   • モデル: references/models.md からダウンロードリンクを提供
   • バージョン不一致: アップデートを提案

エラーハンドリング

エラー	原因	アクション
接続が拒否された	ComfyUI が実行されていない	オフラインモードに切り替え、JSON を保存
400 Bad Request	ワークフロー JSON が無効	ノード接続を検証
500 Internal Error	ComfyUI がクラッシュ	再起動を提案、ログを確認
タイムアウト (応答なし)	サーバーが過負荷	待機して 1 回再試行

リファレンス

完全な API ドキュメント: foundation/api-quick-ref.md