Tools

Geração de música

A ferramenta music_generate permite que o agente crie música ou áudio por meio da capacidade compartilhada de geração de música com provedores configurados — Google, MiniMax e ComfyUI configurado por workflow atualmente.

Para execuções de agente com sessão, o OpenClaw inicia a geração de música como uma tarefa em segundo plano, rastreia-a no livro-razão de tarefas e então desperta o agente novamente quando a faixa está pronta para que o agente possa avisar o usuário e anexar o áudio finalizado. Em chats de grupo/canal que usam entrega visível somente por ferramenta de mensagem, o agente retransmite o resultado por meio da ferramenta de mensagem. Se o agente de conclusão escrever apenas uma resposta final privada, o OpenClaw recorre a um envio direto pelo canal com a mídia gerada. O despertar de conclusão avisa explicitamente o agente de que respostas finais normais são privadas nessas rotas.

Início rápido

Com provedor compartilhado

  • Configurar autenticação

    Defina uma chave de API para pelo menos um provedor — por exemplo GEMINI_API_KEY ou MINIMAX_API_KEY.

  • Escolher um modelo padrão (opcional)

    {
      agents: {
        defaults: {
          musicGenerationModel: {
            primary: "google/lyria-3-clip-preview",
          },
        },
      },
    }
    
  • Pedir ao agente

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

    O agente chama music_generate automaticamente. Nenhuma lista de permissões de ferramenta é necessária.

  • Para contextos síncronos diretos sem uma execução de agente com sessão, a ferramenta integrada ainda recorre à geração inline e retorna o caminho da mídia final no resultado da ferramenta.

    Workflow do ComfyUI

  • Configurar o workflow

    Configure plugins.entries.comfy.config.music com um workflow JSON e nós de prompt/saída.

  • Autenticação na nuvem (opcional)

    Para o Comfy Cloud, defina COMFY_API_KEY ou COMFY_CLOUD_API_KEY.

  • Chamar a ferramenta

    /tool music_generate prompt="Warm ambient synth loop with soft tape texture"
    
  • Exemplos de prompts:

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

    Provedores compatíveis

    Provedor Modelo padrão Entradas de referência Controles compatíveis Autenticação
    ComfyUI workflow Até 1 imagem Música ou áudio definido pelo workflow COMFY_API_KEY, COMFY_CLOUD_API_KEY
    Google lyria-3-clip-preview Até 10 imagens lyrics, instrumental, format GEMINI_API_KEY, GOOGLE_API_KEY
    MiniMax music-2.6 Nenhuma lyrics, instrumental, durationSeconds, format=mp3 MINIMAX_API_KEY ou OAuth do MiniMax

    Matriz de capacidade

    O contrato de modo explícito usado por music_generate, testes de contrato e a varredura live compartilhada:

    Provedor generate edit Limite de edição Lanes live compartilhadas
    ComfyUI 1 imagem Não está na varredura compartilhada; coberto por extensions/comfy/comfy.live.test.ts
    Google 10 imagens generate, edit
    MiniMax Nenhuma generate

    Use action: "list" para inspecionar provedores e modelos compartilhados disponíveis em runtime:

    /tool music_generate action=list
    

    Use action: "status" para inspecionar a tarefa de música ativa com sessão:

    /tool music_generate action=status
    

    Exemplo de geração direta:

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

    Parâmetros da ferramenta

    promptstringrequired

    Prompt de geração de música. Obrigatório para action: "generate".

    action"generate" | "status" | "list"

    "status" retorna a tarefa de sessão atual; "list" inspeciona provedores.

    modelstring

    Substituição de provedor/modelo (por exemplo, google/lyria-3-pro-preview, comfy/workflow).

    lyricsstring

    Letra opcional quando o provedor oferece suporte a entrada explícita de letra.

    instrumentalboolean

    Solicita saída somente instrumental quando o provedor oferece suporte a isso.

    imagestring

    Caminho ou URL de uma única imagem de referência.

    imagesstring[]

    Múltiplas imagens de referência (até 10 em provedores compatíveis).

    durationSecondsnumber

    Duração-alvo em segundos quando o provedor oferece suporte a dicas de duração.

    format"mp3" | "wav"

    Dica de formato de saída quando o provedor oferece suporte a isso.

    filenamestring
    timeoutMsnumber

    Comportamento assíncrono

    A geração de música com sessão é executada como uma tarefa em segundo plano:

    • Tarefa em segundo plano: music_generate cria uma tarefa em segundo plano, retorna uma resposta de início/tarefa imediatamente e publica a faixa finalizada depois em uma mensagem de acompanhamento do agente.
    • Prevenção de duplicidade: enquanto uma tarefa está queued ou running, chamadas posteriores de music_generate na mesma sessão retornam o status da tarefa em vez de iniciar outra geração. Use action: "status" para verificar explicitamente.
    • Consulta de status: openclaw tasks list ou openclaw tasks show <taskId> inspeciona status em fila, em execução e terminal.
    • Despertar de conclusão: o OpenClaw injeta um evento interno de conclusão de volta na mesma sessão para que o modelo possa escrever ele mesmo o acompanhamento voltado ao usuário.
    • Dica de prompt: turnos posteriores de usuário/manual na mesma sessão recebem uma pequena dica de runtime quando uma tarefa de música já está em andamento, para que o modelo não chame music_generate novamente sem critério.
    • Fallback sem sessão: contextos diretos/locais sem uma sessão real de agente executam inline e retornam o resultado final de áudio no mesmo turno.

    Ciclo de vida da tarefa

    Estado Significado
    queued Tarefa criada, aguardando o provedor aceitá-la.
    running O provedor está processando (normalmente de 30 segundos a 3 minutos, dependendo do provedor e da duração).
    succeeded Faixa pronta; o agente desperta e a publica na conversa.
    failed Erro ou timeout do provedor; o agente desperta com detalhes do erro.

    Verifique o status pela CLI:

    openclaw tasks list
    openclaw tasks show <taskId>
    openclaw tasks cancel <taskId>
    

    Configuração

    Seleção de modelo

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

    Ordem de seleção de provedor

    O OpenClaw tenta provedores nesta ordem:

    1. Parâmetro model da chamada de ferramenta (se o agente especificar um).
    2. musicGenerationModel.primary da configuração.
    3. musicGenerationModel.fallbacks em ordem.
    4. Detecção automática usando apenas padrões de provedor baseados em autenticação:
      • provedor padrão atual primeiro;
      • demais provedores de geração de música registrados em ordem de ID de provedor.

    Se um provedor falhar, o próximo candidato é tentado automaticamente. Se todos falharem, o erro inclui detalhes de cada tentativa.

    Defina agents.defaults.mediaGenerationAutoProviderFallback: false para usar apenas entradas explícitas de model, primary e fallbacks.

    Observações sobre provedores

    ComfyUI

    Orientado por workflow e depende do grafo configurado mais o mapeamento de nós para campos de prompt/saída. O Plugin comfy incluído se conecta à ferramenta compartilhada music_generate por meio do registro de provedores de geração de música.

    Google (Lyria 3)

    Usa geração em lote do Lyria 3. O fluxo incluído atual oferece suporte a prompt, texto de letra opcional e imagens de referência opcionais.

    MiniMax

    Usa o endpoint em lote music_generation. Oferece suporte a prompt, letras opcionais, modo instrumental, direcionamento de duração e saída mp3 por meio de autenticação com chave de API minimax ou OAuth minimax-portal.

    Escolhendo o caminho certo

    • Com provedor compartilhado quando você quer seleção de modelo, failover de provedor e o fluxo assíncrono integrado de tarefa/status.
    • Caminho de Plugin (ComfyUI) quando você precisa de um grafo de workflow personalizado ou de um provedor que não faz parte da capacidade compartilhada integrada de música.

    Se você estiver depurando comportamento específico do ComfyUI, consulte ComfyUI. Se você estiver depurando comportamento de provedor compartilhado, comece com Google (Gemini) ou MiniMax.

    Modos de capacidade do provedor

    O contrato compartilhado de geração de música oferece suporte a declarações explícitas de modo:

    • generate para geração somente por prompt.
    • edit quando a solicitação inclui uma ou mais imagens de referência.

    Novas implementações de provedor devem preferir blocos de modo explícitos:

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

    Campos legados planos, como maxInputImages, supportsLyrics e supportsFormat, não são suficientes para anunciar suporte a edição. Provedores devem declarar generate e edit explicitamente para que testes live, testes de contrato e a ferramenta compartilhada music_generate possam validar o suporte a modo de forma determinística.

    Testes live

    Cobertura live opt-in para os provedores compartilhados incluídos:

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

    Wrapper do repositório:

    pnpm test:live:media music
    

    Este arquivo live carrega variáveis de ambiente ausentes do provedor a partir de ~/.profile, prefere chaves de API live/env em vez de perfis de autenticação armazenados por padrão e executa cobertura tanto de generate quanto de edit declarado quando o provedor habilita o modo de edição. Cobertura hoje:

    • google: generate mais edit
    • minimax: apenas generate
    • comfy: cobertura ao vivo separada do Comfy, não a varredura compartilhada de provedores

    Cobertura ao vivo opcional para o caminho de música ComfyUI incluído:

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

    O arquivo ao vivo do Comfy também cobre fluxos de trabalho de imagem e vídeo do comfy quando essas seções estão configuradas.

    Relacionados