快速开始
音乐生成
music_generate 工具让智能体可以通过共享音乐生成能力和已配置的提供商创建音乐或音频,目前支持 Google、MiniMax,以及通过工作流配置的 ComfyUI。
对于有会话支持的智能体运行,OpenClaw 会把音乐生成作为后台任务启动,在任务账本中跟踪它,然后在曲目准备好后再次唤醒智能体,让智能体告知用户并附上完成的音频。在使用仅消息工具可见投递的群组/渠道聊天中,智能体会通过消息工具转发结果。如果完成智能体只写入私有最终回复,OpenClaw 会回退为通过渠道直接发送生成的媒体。完成唤醒会明确警告智能体,在这些路由中普通最终回复是私有的。
快速开始
共享提供商支持
配置身份验证
为至少一个提供商设置 API key,例如
GEMINI_API_KEY 或 MINIMAX_API_KEY。
选择默认模型(可选)
{
agents: {
defaults: {
musicGenerationModel: {
primary: "google/lyria-3-clip-preview",
},
},
},
}
询问智能体
“生成一首关于夜间开车穿过霓虹城市的轻快合成器流行曲目。”
智能体会自动调用 music_generate。无需将工具加入允许列表。
对于没有会话支持的智能体运行的直接同步上下文,内置工具仍会回退为内联生成,并在工具结果中返回最终媒体路径。
ComfyUI 工作流
配置工作流
使用工作流 JSON 和提示词/输出节点配置 plugins.entries.comfy.config.music。
云端身份验证(可选)
对于 Comfy Cloud,请设置 COMFY_API_KEY 或 COMFY_CLOUD_API_KEY。
调用工具
/tool music_generate prompt="Warm ambient synth loop with soft tape texture"
示例提示词:
Generate a cinematic piano track with soft strings and no vocals.
Generate an energetic chiptune loop about launching a rocket at sunrise.
支持的提供商
| 提供商 | 默认模型 | 参考输入 | 支持的控制项 | 身份验证 |
|---|---|---|---|---|
| ComfyUI | workflow |
最多 1 张图像 | 工作流定义的音乐或音频 | COMFY_API_KEY, COMFY_CLOUD_API_KEY |
lyria-3-clip-preview |
最多 10 张图像 | lyrics, instrumental, format |
GEMINI_API_KEY, GOOGLE_API_KEY |
|
| MiniMax | music-2.6 |
无 | lyrics, instrumental, durationSeconds, format=mp3 |
MINIMAX_API_KEY 或 MiniMax OAuth |
能力矩阵
music_generate、契约测试和共享实时扫描使用的显式模式契约:
| 提供商 | generate |
edit |
编辑限制 | 共享实时通道 |
|---|---|---|---|---|
| ComfyUI | ✓ | ✓ | 1 张图像 | 不在共享扫描中;由 extensions/comfy/comfy.live.test.ts 覆盖 |
| ✓ | ✓ | 10 张图像 | generate, edit |
|
| MiniMax | ✓ | — | 无 | generate |
使用 action: "list" 在运行时检查可用的共享提供商和模型:
/tool music_generate action=list
使用 action: "status" 检查当前由会话支持的音乐任务:
/tool music_generate action=status
直接生成示例:
/tool music_generate prompt="Dreamy lo-fi hip hop with vinyl texture and gentle rain" instrumental=true
工具参数
promptstringrequired音乐生成提示词。action: "generate" 必填。
action"generate" | "status" | "list""status" 返回当前会话任务;"list" 检查提供商。
modelstring提供商/模型覆盖(例如 google/lyria-3-pro-preview、
comfy/workflow)。
lyricsstring当提供商支持显式歌词输入时使用的可选歌词。
instrumentalboolean当提供商支持时,请求仅器乐输出。
imagestring单个参考图像路径或 URL。
imagesstring[]多个参考图像(在支持的提供商上最多 10 张)。
durationSecondsnumber当提供商支持时,目标时长(秒)。
format"mp3" | "wav"当提供商支持时的输出格式提示。
filenamestringtimeoutMsnumber异步行为
由会话支持的音乐生成会作为后台任务运行:
- 后台任务:
music_generate创建后台任务,立即返回已启动/任务响应,并稍后在后续智能体消息中发布完成的曲目。 - 防止重复: 当任务处于
queued或running时,同一会话中后续的music_generate调用会返回任务状态,而不是启动另一轮生成。使用action: "status"显式检查。 - Status 查询:
openclaw tasks list或openclaw tasks show <taskId>会检查排队中、运行中和终态状态。 - 完成唤醒: OpenClaw 会把内部完成事件注入回同一会话,让模型可以自行写出面向用户的后续消息。
- 提示词提示: 同一会话中的后续用户/手动轮次会在音乐任务已在进行中时获得一条小型运行时提示,因此模型不会盲目再次调用
music_generate。 - 无会话回退: 没有真实智能体会话的直接/本地上下文会内联运行,并在同一轮中返回最终音频结果。
任务生命周期
| 状态 | 含义 |
|---|---|
queued |
任务已创建,正在等待提供商接受。 |
running |
提供商正在处理(通常 30 秒到 3 分钟,取决于提供商和时长)。 |
succeeded |
曲目已准备好;智能体会被唤醒并将它发布到对话中。 |
failed |
提供商错误或超时;智能体会携带错误详情被唤醒。 |
从 CLI 检查状态:
openclaw tasks list
openclaw tasks show <taskId>
openclaw tasks cancel <taskId>
配置
模型选择
{
agents: {
defaults: {
musicGenerationModel: {
primary: "google/lyria-3-clip-preview",
fallbacks: ["minimax/music-2.6"],
},
},
},
}
提供商选择顺序
OpenClaw 会按以下顺序尝试提供商:
- 来自工具调用的
model参数(如果智能体指定了一个)。 - 配置中的
musicGenerationModel.primary。 - 按顺序使用
musicGenerationModel.fallbacks。 - 仅使用身份验证支持的提供商默认值进行自动检测:
- 当前默认提供商优先;
- 其余已注册的音乐生成提供商按提供商 ID 顺序。
如果某个提供商失败,会自动尝试下一个候选项。如果全部失败,错误会包含每次尝试的详情。
设置 agents.defaults.mediaGenerationAutoProviderFallback: false 即可只使用显式的 model、primary 和 fallbacks 条目。
提供商说明
ComfyUI
由工作流驱动,依赖已配置的图以及提示词/输出字段的节点映射。内置 comfy 插件会通过音乐生成提供商注册表接入共享 music_generate 工具。
Google (Lyria 3)
使用 Lyria 3 批量生成。当前内置流程支持提示词、可选歌词文本和可选参考图像。
MiniMax
使用批量 music_generation 端点。支持提示词、可选歌词、器乐模式、时长控制,以及通过 minimax API-key 身份验证或 minimax-portal OAuth 输出 mp3。
选择合适路径
- 共享提供商支持:当你需要模型选择、提供商故障转移,以及内置异步任务/Status 流程时使用。
- 插件路径(ComfyUI):当你需要自定义工作流图,或需要不属于共享内置音乐能力的提供商时使用。
如果你正在调试 ComfyUI 特定行为,请参阅 ComfyUI。如果你正在调试共享提供商行为,请从 Google (Gemini) 或 MiniMax 开始。
提供商能力模式
共享音乐生成契约支持显式模式声明:
generate用于仅提示词生成。- 当请求包含一个或多个参考图像时使用
edit。
新的提供商实现应优先使用显式模式块:
capabilities: {
generate: {
maxTracks: 1,
supportsLyrics: true,
supportsFormat: true,
},
edit: {
enabled: true,
maxTracks: 1,
maxInputImages: 1,
supportsFormat: true,
},
}
maxInputImages、supportsLyrics 和 supportsFormat 等旧版扁平字段不足以声明编辑支持。提供商应显式声明 generate 和 edit,以便实时测试、契约测试和共享 music_generate 工具能够确定性地验证模式支持。
实时测试
共享内置提供商的选择性启用实时覆盖:
OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/music-generation-providers.live.test.ts
仓库包装器:
pnpm test:live:media music
这个实时文件会从 ~/.profile 加载缺失的提供商环境变量,默认优先使用实时/环境 API key,而不是已存储的身份验证配置文件,并在提供商启用编辑模式时同时运行 generate 和已声明的 edit 覆盖。当前覆盖:
google:generate加editminimax: 仅generatecomfy: 单独的 Comfy 实时覆盖,不属于共享提供商扫描
内置 ComfyUI 音乐路径的选择加入式实时覆盖:
OPENCLAW_LIVE_TEST=1 COMFY_LIVE_TEST=1 pnpm test:live -- extensions/comfy/comfy.live.test.ts
当这些部分已配置时,Comfy 实时文件还会覆盖 comfy 图像和视频工作流。