快速开始

音乐生成

Edit source

music_generate 工具让智能体可以通过共享音乐生成能力,使用已配置的提供商来创建音乐或音频,目前支持 Google、MiniMax,以及通过工作流配置的 ComfyUI。

对于有会话支持的智能体运行,OpenClaw 会将音乐生成作为后台任务启动,在任务账本中跟踪它,然后在曲目就绪时再次唤醒智能体,以便智能体告知用户并附上完成的音频。在使用仅消息工具可见投递的群组/渠道聊天中,智能体会通过消息工具转发结果。如果完成智能体只写入私有最终回复,OpenClaw 会回退到带有生成媒体的直接渠道发送。完成唤醒会明确警告智能体,在这些路由中普通最终回复是私有的。

快速开始

共享提供商支持

  • 配置认证

    为至少一个提供商设置 API key,例如 GEMINI_API_KEYMINIMAX_API_KEY

  • 选择默认模型(可选)

    json5
    {  agents: {    defaults: {      musicGenerationModel: {        primary: "google/lyria-3-clip-preview",      },    },  },}
  • 询问智能体

    "Generate an upbeat synthpop track about a night drive through a neon city."

    智能体会自动调用 music_generate。无需工具允许列表。

  • 对于没有会话支持的智能体运行的直接同步上下文,内置工具仍会回退到内联生成,并在工具结果中返回最终媒体路径。

    ComfyUI 工作流

  • 配置工作流

    使用工作流 JSON 和提示词/输出节点配置 plugins.entries.comfy.config.music

  • 云认证(可选)

    对于 Comfy Cloud,请设置 COMFY_API_KEYCOMFY_CLOUD_API_KEY

  • 调用工具

    text
    /tool music_generate prompt="Warm ambient synth loop with soft tape texture"
  • 示例提示词:

    text
    Generate a cinematic piano track with soft strings and no vocals.
    text
    Generate an energetic chiptune loop about launching a rocket at sunrise.

    支持的提供商

    提供商 默认模型 参考输入 支持的控制项 认证
    ComfyUI workflow 最多 1 张图片 工作流定义的音乐或音频 COMFY_API_KEY, COMFY_CLOUD_API_KEY
    Google 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 覆盖
    Google 10 张图片 generate, edit
    MiniMax generate

    使用 action: "list" 在运行时检查可用的共享提供商和模型:

    text
    /tool music_generate action=list

    使用 action: "status" 检查当前有会话支持的音乐任务:

    text
    /tool music_generate action=status

    直接生成示例:

    text
    /tool music_generate prompt="Dreamy lo-fi hip hop with vinyl texture and gentle rain" instrumental=true

    工具参数

    promptstringrequired

    音乐生成提示词。action: "generate" 必填。

    action"generate" | "status" | "list"default: generate

    "status" 返回当前会话任务;"list" 检查提供商。

    modelstring

    提供商/模型覆盖(例如 google/lyria-3-pro-previewcomfy/workflow)。

    lyricsstring

    当提供商支持显式歌词输入时,可选歌词。

    instrumentalboolean

    当提供商支持时,请求仅器乐输出。

    imagestring

    单个参考图片路径或 URL。

    imagesstring[]

    多张参考图片(支持的提供商最多 10 张)。

    durationSecondsnumber

    当提供商支持时,以秒为单位的目标时长提示。

    format"mp3" | "wav"

    当提供商支持时的输出格式提示。

    filenamestring

    OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9InRpbWVvdXRNcyIgdHlwZT0ibnVtYmVyIg 可选的提供商请求超时时间,单位为毫秒。省略时,如果已配置,OpenClaw 会使用 agents.defaults.musicGenerationModel.timeoutMs。低于 10000ms 的值会提升到 10000ms,并在工具结果中报告。 OPENCLAW_DOCS_MARKER:paramClose:

    异步行为

    有会话支持的音乐生成会作为后台任务运行:

    • 后台任务: music_generate 会创建后台任务,立即返回已启动/任务响应,并稍后在后续智能体消息中发布完成的曲目。
    • 防止重复: 当任务处于 queuedrunning 状态时,同一会话中后续的 music_generate 调用会返回任务状态,而不是启动另一次生成。使用 action: "status" 可显式检查。
    • 状态查询: openclaw tasks listopenclaw tasks show <taskId> 可检查排队、运行中和终止状态。
    • 完成唤醒: OpenClaw 会将内部完成事件注入回同一会话,让模型可以自行编写面向用户的后续消息。
    • 提示词提示: 同一会话中之后的用户/手动轮次会在音乐任务已在进行中时获得一个小的运行时提示,因此模型不会盲目再次调用 music_generate
    • 无会话回退: 没有真实智能体会话的直接/本地上下文会内联运行,并在同一轮中返回最终音频结果。

    任务生命周期

    状态 含义
    queued 任务已创建,等待提供商接受。
    running 提供商正在处理(通常为 30 秒到 3 分钟,取决于提供商和时长)。
    succeeded 曲目已就绪;智能体会被唤醒并将其发布到对话。
    failed 提供商错误或超时;智能体会被唤醒并带有错误详情。

    从 CLI 检查状态:

    bash
    openclaw tasks listopenclaw tasks show <taskId>openclaw tasks cancel <taskId>

    配置

    模型选择

    json5
    {  agents: {    defaults: {      musicGenerationModel: {        primary: "google/lyria-3-clip-preview",        fallbacks: ["minimax/music-2.6"],      },    },  },}

    提供商选择顺序

    OpenClaw 会按以下顺序尝试提供商:

    1. 工具调用中的 model 参数(如果智能体指定了一个)。
    2. 配置中的 musicGenerationModel.primary
    3. 按顺序使用 musicGenerationModel.fallbacks
    4. 仅使用基于认证的提供商默认值进行自动检测:
      • 当前默认提供商优先;
      • 其余已注册的音乐生成提供商按提供商 ID 顺序。

    如果某个提供商失败,会自动尝试下一个候选项。如果全部失败,错误会包含每次尝试的详情。

    设置 agents.defaults.mediaGenerationAutoProviderFallback: false 以仅使用显式的 modelprimaryfallbacks 条目。

    提供商说明

    ComfyUI

    由工作流驱动,并依赖已配置的图以及提示词/输出字段的节点映射。内置的 comfy 插件通过音乐生成提供商注册表接入共享的 music_generate 工具。

    Google (Lyria 3)

    使用 Lyria 3 批量生成。当前内置流程支持提示词、可选歌词文本和可选参考图片。

    MiniMax

    使用批量 music_generation 端点。支持提示词、可选歌词、器乐模式、时长引导,以及通过 minimax API key 认证或 minimax-portal OAuth 输出 mp3。

    选择合适的路径

    • 共享提供商支持:当你需要模型选择、提供商故障转移,以及内置异步任务/状态流程时使用。
    • 插件路径(ComfyUI):当你需要自定义工作流图,或需要不属于共享内置音乐能力的提供商时使用。

    如果你正在调试 ComfyUI 特定行为,请参阅 ComfyUI。如果你正在调试共享提供商行为,请从 Google (Gemini)MiniMax 开始。

    提供商能力模式

    共享音乐生成契约支持显式模式声明:

    • generate 用于仅提示词生成。
    • 当请求包含一张或多张参考图片时使用 edit

    新的提供商实现应优先使用显式模式块:

    typescript
    capabilities: {  generate: {    maxTracks: 1,    supportsLyrics: true,    supportsFormat: true,  },  edit: {    enabled: true,    maxTracks: 1,    maxInputImages: 1,    supportsFormat: true,  },}

    maxInputImagessupportsLyricssupportsFormat 等旧版扁平字段不足以声明编辑支持。提供商应显式声明 generateedit,以便实时测试、契约测试和共享的 music_generate 工具能够确定性地验证模式支持。

    实时测试

    共享内置提供商的选择加入式实时覆盖:

    bash
    OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/music-generation-providers.live.test.ts

    仓库包装器:

    bash
    pnpm test:live:media music

    此 live 文件会从 ~/.profile 加载缺失的提供商环境变量,默认优先使用 live/env API 密钥,而不是已存储的认证配置文件,并且在提供商启用 edit 模式时同时运行 generate 和声明的 edit 覆盖范围。当前覆盖范围:

    • googlegenerateedit
    • minimax:仅 generate
    • comfy:单独的 Comfy live 覆盖范围,不属于共享的提供商 sweep

    为内置 ComfyUI 音乐路径启用可选 live 覆盖范围:

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

    配置了对应部分时,Comfy live 文件也会覆盖 comfy 图像和视频工作流。

    相关内容

    Was this useful?