Skip to content
OpenClaw Docs

ComfyUI

OpenClaw 隨附一個用於驅動工作流程 ComfyUI 執行捆綁的 comfy 外掛程式。該外掛程式完全由工作流程驅動，因此 OpenClaw 不會嘗試將通用的 size、aspectRatio、resolution、durationSeconds 或 TTS 風格的控制對應到您的圖表中。

屬性詳情
提供者comfy
模型comfy/workflow
共享介面image_generate、video_generate、music_generate
驗證本地 ComfyUI 無需驗證；Comfy Cloud 則需要 COMFY_API_KEY 或 COMFY_CLOUD_API_KEY
APIComfyUI /prompt / /history / /view 和 Comfy Cloud /api/*

支援內容

Section titled “支援內容”
  • 從工作流程 JSON 生成圖像
  • 使用 1 張上傳的參考圖像進行圖像編輯
  • 從工作流程 JSON 生成影片
  • 使用 1 張上傳的參考圖像生成影片
  • 透過共享的 music_generate 工具生成音樂或音訊
  • 從設定的節點或所有符合條件的輸出節點下載輸出

快速入門

Section titled “快速入門”

選擇在您自己的機器上運行 ComfyUI 或使用 Comfy Cloud。

最適合： 在您的機器或區域網路上執行您自己的 ComfyUI 實例。

  1. 在本機啟動 ComfyUI

    請確保您的本機 ComfyUI 實例正在執行（預設為 http://127.0.0.1:8188）。

  2. 準備您的工作流程 JSON

    匯出或建立一個 ComfyUI 工作流程 JSON 檔案。請記下提示詞輸入節點以及您希望 OpenClaw 讀取的輸出節點的節點 ID。

  3. 設定提供者

    設定 mode: "local" 並指向您的工作流程檔案。以下是一個最基本的圖像範例：

    {
      plugins: {
        entries: {
          comfy: {
            config: {
              mode: "local",
              baseUrl: "http://127.0.0.1:8188",
              image: {
                workflowPath: "./workflows/flux-api.json",
                promptNodeId: "6",
                outputNodeId: "9",
              },
            },
          },
        },
      },
    }

  4. 設定預設模型

    將 OpenClaw 指向您所設定功能的 comfy/workflow 模型：

    {
      agents: {
        defaults: {
          imageGenerationModel: {
            primary: "comfy/workflow",
          },
        },
      },
    }

  5. 驗證

    Terminal window
    openclaw models list --provider comfy

設定

Section titled “設定”

Comfy 支援共用的頂層連線設定，以及各功能區段的工作流程 (image、video、music)：

{
  plugins: {
    entries: {
      comfy: {
        config: {
          mode: "local",
          baseUrl: "http://127.0.0.1:8188",
          image: {
            workflowPath: "./workflows/flux-api.json",
            promptNodeId: "6",
            outputNodeId: "9",
          },
          video: {
            workflowPath: "./workflows/video-api.json",
            promptNodeId: "12",
            outputNodeId: "21",
          },
          music: {
            workflowPath: "./workflows/music-api.json",
            promptNodeId: "3",
            outputNodeId: "18",
          },
        },
      },
    },
  },
}

共用金鑰

Section titled “共用金鑰”
金鑰類型說明
mode"local" 或 "cloud"連線模式。
baseUrl字串本機預設為 http://127.0.0.1:8188，雲端則預設為 https://cloud.comfy.org。
apiKey字串可選的內聯金鑰，是 COMFY_API_KEY / COMFY_CLOUD_API_KEY 環境變數的替代方案。
allowPrivateNetwork布林值允許在雲端模式下使用私有/LAN baseUrl。

各功能金鑰

Section titled “各功能金鑰”

這些金鑰適用於 image、video 或 music 區段內：

金鑰必填預設說明
workflow 或 workflowPath是—ComfyUI 工作流程 JSON 檔案的路徑。
promptNodeId是—接收文字提示的節點 ID。
promptInputName否"text"提示節點上的輸入名稱。
outputNodeId否—要從中讀取輸出的節點 ID。如果省略，則使用所有符合的輸出節點。
pollIntervalMs否—輪詢任務完成的間隔（毫秒）。
timeoutMs否—工作流程執行的逾時時間（毫秒）。

image 和 video 區段也支援：

金鑰必填預設說明
inputImageNodeId是（傳遞參考圖片時）—接收上傳參考圖片的節點 ID。
inputImageInputName否"image"圖片節點上的輸入名稱。

工作流程詳情

Section titled “工作流程詳情”
圖片工作流程

將預設圖片模型設定為 comfy/workflow：

{
  agents: {
    defaults: {
      imageGenerationModel: {
        primary: "comfy/workflow",
      },
    },
  },
}

參考圖片編輯範例：

若要使用上傳的參考圖片啟用圖片編輯，請將 inputImageNodeId 加入您的圖片設定：

{
  plugins: {
    entries: {
      comfy: {
        config: {
          image: {
            workflowPath: "./workflows/edit-api.json",
            promptNodeId: "6",
            inputImageNodeId: "7",
            inputImageInputName: "image",
            outputNodeId: "9",
          },
        },
      },
    },
  },
}
影片工作流程

將預設影片模型設定為 comfy/workflow：

{
  agents: {
    defaults: {
      videoGenerationModel: {
        primary: "comfy/workflow",
      },
    },
  },
}

Comfy 影片工作流程透過設定的圖表支援文字生成影片與圖片生成影片。

音樂工作流程

內建外掛為工作流程定義的音訊或音樂輸出註冊了一個音樂生成提供者，透過共享的 music_generate 工具公開：

/tool music_generate prompt="Warm ambient synth loop with soft tape texture"

使用 music 設定區段指向您的音樂工作流程 JSON 和輸出節點。

向後相容性

現有的頂層影像設定（不包含巢狀的 image 區段）仍然有效：

{
  plugins: {
    entries: {
      comfy: {
        config: {
          workflowPath: "./workflows/flux-api.json",
          promptNodeId: "6",
          outputNodeId: "9",
        },
      },
    },
  },
}

OpenClaw 將該舊版結構視為影像工作流程設定。您不需要立即遷移，但建議新設定使用巢狀的 image / video / music 區段。

即時測試

內建外掛具備可選用的即時覆蓋範圍：

Terminal window
OPENCLAW_LIVE_TEST=1 COMFY_LIVE_TEST=1 pnpm test:live -- extensions/comfy/comfy.live.test.ts

除非已設定符合的 Comfy 工作流程區段，否則即時測試會跳過個別的影像、視訊或音樂案例。

相關

Section titled “相關”
影像生成

影像生成工具的設定與用法。

視訊生成

視訊生成工具的設定與用法。

音樂生成

音樂與音訊生成工具的設定。

提供商目錄

所有提供商和模型參考的概覽。

設定參考

完整的設定參考，包括代理預設值。