Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

OpenClaw 内置了一个 comfy 插件，用于执行由工作流驱动的 ComfyUI 运行。该插件完全由工作流驱动，因此 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/*

​
它支持的功能

  • 从工作流 JSON 生成图像
  • 使用 1 张上传的参考图像进行图像编辑
  • 从工作流 JSON 生成视频
  • 使用 1 张上传的参考图像生成视频
  • 通过共享的 music_generate 工具生成音乐或音频
  • 从已配置的节点下载输出，或下载所有匹配的输出节点

​
入门指南

你可以选择在自己的机器上运行 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

验证

openclaw models list --provider comfy

​
配置

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",
          },
        },
      },
    },
  },
}

​
共享键名

键名类型描述
mode"local" 或 "cloud"连接模式。
baseUrlstring本地模式默认为 http://127.0.0.1:8188，云模式默认为 https://cloud.comfy.org。
apiKeystring可选的内联密钥，可替代环境变量 COMFY_API_KEY / COMFY_CLOUD_API_KEY。
allowPrivateNetworkboolean在云模式下允许使用私有网络 / 局域网 baseUrl。

​
按能力划分的键名

这些键适用于 image、video 或 music 部分内部：
键名必需默认值描述
workflow 或 workflowPath是—ComfyUI 工作流 JSON 文件的路径。
promptNodeId是—接收文本提示词的节点 ID。
promptInputName否"text"提示词节点上的输入名称。
outputNodeId否—读取输出的节点 ID。如果省略，则使用所有匹配的输出节点。
pollIntervalMs否—轮询作业完成状态的间隔时间（毫秒）。
timeoutMs否—工作流运行的超时时间（毫秒）。
image 和 video 部分还支持：
键名必需默认值描述
inputImageNodeId传入参考图像时必需—接收上传参考图像的节点 ID。
inputImageInputName否"image"图像节点上的输入名称。

​
工作流详情

将默认图像模型设置为 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 视频工作流通过已配置的图支持文生视频和图生视频。
OpenClaw 不会将输入视频传入 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 部分。
如果你只使用图像生成，旧版扁平配置和新的嵌套 image 部分在功能上是等价的。
内置插件提供可选启用的实时覆盖测试：
OPENCLAW_LIVE_TEST=1 COMFY_LIVE_TEST=1 pnpm test:live -- extensions/comfy/comfy.live.test.ts
除非配置了对应的 Comfy 工作流部分，否则实时测试会跳过各个图像、视频或音乐用例。

​
相关内容

图像生成

图像生成工具配置和用法。

视频生成

视频生成工具配置和用法。

音乐生成

音乐和音频生成工具设置。

Provider Directory

所有提供商和模型引用的概览。

配置参考

包含智能体默认设置在内的完整配置参考。