Saltar al contenido principal

Documentation Index

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

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

La herramienta music_generate permite al agente crear música o audio mediante la capacidad compartida de generación de música con proveedores configurados: Google, MiniMax y ComfyUI configurado por workflow actualmente. Para ejecuciones de agente respaldadas por sesión, OpenClaw inicia la generación de música como una tarea en segundo plano, la registra en el libro de tareas y luego vuelve a despertar al agente cuando la pista está lista para que el agente pueda avisar al usuario y adjuntar el audio terminado. En chats de grupo/canal que usan entrega visible solo mediante herramienta de mensajes, el agente transmite el resultado mediante la herramienta de mensajes. Si el agente de finalización escribe solo una respuesta final privada, OpenClaw recurre a un envío directo por el canal con los medios generados. El despertar de finalización advierte explícitamente al agente que las respuestas finales normales son privadas en esas rutas.
La herramienta compartida integrada solo aparece cuando hay al menos un proveedor de generación de música disponible. Si no ves music_generate en las herramientas de tu agente, configura agents.defaults.musicGenerationModel o configura una clave de API de proveedor.

Inicio rápido

1

Configurar autenticación

Define una clave de API para al menos un proveedor; por ejemplo, GEMINI_API_KEY o MINIMAX_API_KEY.
2

Elegir un modelo predeterminado (opcional)

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

Pedirle al agente

“Genera una pista de synthpop animada sobre un recorrido nocturno por una ciudad de neón.”El agente llama a music_generate automáticamente. No hace falta una lista de permisos de herramientas.
Para contextos sincrónicos directos sin una ejecución de agente respaldada por sesión, la herramienta integrada aún recurre a la generación en línea y devuelve la ruta final de los medios en el resultado de la herramienta.
Prompts de ejemplo:
Generate a cinematic piano track with soft strings and no vocals.
Generate an energetic chiptune loop about launching a rocket at sunrise.

Proveedores compatibles

ProveedorModelo predeterminadoEntradas de referenciaControles compatiblesAutenticación
ComfyUIworkflowHasta 1 imagenMúsica o audio definidos por el workflowCOMFY_API_KEY, COMFY_CLOUD_API_KEY
Googlelyria-3-clip-previewHasta 10 imágeneslyrics, instrumental, formatGEMINI_API_KEY, GOOGLE_API_KEY
MiniMaxmusic-2.6Ningunalyrics, instrumental, durationSeconds, format=mp3MINIMAX_API_KEY o OAuth de MiniMax

Matriz de capacidades

El contrato de modo explícito usado por music_generate, las pruebas de contrato y el barrido live compartido:
ProveedorgenerateeditLímite de ediciónCarriles live compartidos
ComfyUI1 imagenNo está en el barrido compartido; cubierto por extensions/comfy/comfy.live.test.ts
Google10 imágenesgenerate, edit
MiniMaxNingunogenerate
Usa action: "list" para inspeccionar proveedores y modelos compartidos disponibles en tiempo de ejecución:
/tool music_generate action=list
Usa action: "status" para inspeccionar la tarea de música activa respaldada por sesión:
/tool music_generate action=status
Ejemplo de generación directa:
/tool music_generate prompt="Dreamy lo-fi hip hop with vinyl texture and gentle rain" instrumental=true

Parámetros de la herramienta

prompt
string
requerido
Prompt de generación de música. Requerido para action: "generate".
action
"generate" | "status" | "list"
predeterminado:"generate"
"status" devuelve la tarea de sesión actual; "list" inspecciona proveedores.
model
string
Anulación de proveedor/modelo (por ejemplo, google/lyria-3-pro-preview, comfy/workflow).
lyrics
string
Letra opcional cuando el proveedor admite entrada explícita de letra.
instrumental
boolean
Solicita una salida solo instrumental cuando el proveedor lo admite.
image
string
Ruta o URL de una sola imagen de referencia.
images
string[]
Varias imágenes de referencia (hasta 10 en proveedores compatibles).
durationSeconds
number
Duración objetivo en segundos cuando el proveedor admite indicaciones de duración.
format
"mp3" | "wav"
Indicación de formato de salida cuando el proveedor lo admite.
filename
string
Indicación de nombre de archivo de salida.
timeoutMs
number
Tiempo de espera opcional de la solicitud al proveedor en milisegundos. Cuando se omite, OpenClaw usa agents.defaults.musicGenerationModel.timeoutMs si está configurado. Los valores inferiores a 10000ms se elevan a 10000ms y se informan en el resultado de la herramienta.
No todos los proveedores admiten todos los parámetros. OpenClaw aun así valida límites estrictos, como los recuentos de entrada, antes del envío. Cuando un proveedor admite duración pero usa un máximo más corto que el valor solicitado, OpenClaw limita al valor compatible más cercano. Las indicaciones opcionales realmente no compatibles se ignoran con una advertencia cuando el proveedor o modelo seleccionado no puede cumplirlas. Los resultados de la herramienta informan la configuración aplicada; details.normalization captura cualquier asignación de solicitado a aplicado.

Comportamiento asíncrono

La generación de música respaldada por sesión se ejecuta como una tarea en segundo plano:
  • Tarea en segundo plano: music_generate crea una tarea en segundo plano, devuelve inmediatamente una respuesta iniciada/de tarea y publica la pista terminada más tarde en un mensaje de seguimiento del agente.
  • Prevención de duplicados: mientras una tarea está queued o running, las llamadas posteriores a music_generate en la misma sesión devuelven el estado de la tarea en lugar de iniciar otra generación. Usa action: "status" para comprobarlo explícitamente.
  • Consulta de estado: openclaw tasks list u openclaw tasks show <taskId> inspecciona estados en cola, en ejecución y terminales.
  • Despertar de finalización: OpenClaw inyecta un evento interno de finalización de vuelta en la misma sesión para que el modelo pueda escribir por sí mismo el seguimiento visible para el usuario.
  • Indicación de prompt: los turnos posteriores de usuario/manual en la misma sesión reciben una pequeña indicación en tiempo de ejecución cuando una tarea de música ya está en curso, para que el modelo no llame a music_generate a ciegas de nuevo.
  • Reserva sin sesión: los contextos directos/locales sin una sesión real de agente se ejecutan en línea y devuelven el resultado de audio final en el mismo turno.

Ciclo de vida de la tarea

EstadoSignificado
queuedTarea creada, esperando a que el proveedor la acepte.
runningEl proveedor está procesando (normalmente de 30 segundos a 3 minutos según proveedor y duración).
succeededPista lista; el agente se despierta y la publica en la conversación.
failedError del proveedor o tiempo de espera agotado; el agente se despierta con detalles del error.
Comprueba el estado desde la CLI:
openclaw tasks list
openclaw tasks show <taskId>
openclaw tasks cancel <taskId>

Configuración

Selección de modelo

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

Orden de selección de proveedor

OpenClaw prueba proveedores en este orden:
  1. Parámetro model de la llamada de herramienta (si el agente especifica uno).
  2. musicGenerationModel.primary de la configuración.
  3. musicGenerationModel.fallbacks en orden.
  4. Detección automática usando solo valores predeterminados de proveedor respaldados por autenticación:
    • primero el proveedor predeterminado actual;
    • los proveedores de generación de música registrados restantes en orden de identificador de proveedor.
Si un proveedor falla, se prueba automáticamente el siguiente candidato. Si todos fallan, el error incluye detalles de cada intento. Define agents.defaults.mediaGenerationAutoProviderFallback: false para usar solo entradas explícitas de model, primary y fallbacks.

Notas de proveedores

Controlado por workflow y depende del grafo configurado más la asignación de nodos para campos de prompt/salida. El Plugin comfy incluido se conecta a la herramienta compartida music_generate mediante el registro de proveedores de generación de música.
Usa generación por lotes de Lyria 3. El flujo integrado actual admite prompt, texto opcional de letra e imágenes de referencia opcionales.
Usa el endpoint por lotes music_generation. Admite prompt, letra opcional, modo instrumental, dirección de duración y salida mp3 mediante autenticación con clave de API minimax u OAuth de minimax-portal.

Elegir la ruta adecuada

  • Respaldado por proveedor compartido cuando quieres selección de modelo, conmutación por error de proveedor y el flujo asíncrono integrado de tarea/estado.
  • Ruta de Plugin (ComfyUI) cuando necesitas un grafo de workflow personalizado o un proveedor que no forma parte de la capacidad musical compartida incluida.
Si estás depurando comportamiento específico de ComfyUI, consulta ComfyUI. Si estás depurando comportamiento de proveedor compartido, empieza con Google (Gemini) o MiniMax.

Modos de capacidad de proveedor

El contrato compartido de generación de música admite declaraciones explícitas de modo:
  • generate para generación solo con prompt.
  • edit cuando la solicitud incluye una o más imágenes de referencia.
Las nuevas implementaciones de proveedores deben preferir bloques de modo explícitos:
capabilities: {
  generate: {
    maxTracks: 1,
    supportsLyrics: true,
    supportsFormat: true,
  },
  edit: {
    enabled: true,
    maxTracks: 1,
    maxInputImages: 1,
    supportsFormat: true,
  },
}
Los campos planos heredados como maxInputImages, supportsLyrics y supportsFormat no bastan para anunciar compatibilidad con edición. Los proveedores deben declarar generate y edit explícitamente para que las pruebas live, las pruebas de contrato y la herramienta compartida music_generate puedan validar la compatibilidad de modo de forma determinista.

Pruebas live

Cobertura live con suscripción explícita para los proveedores integrados compartidos:
OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/music-generation-providers.live.test.ts
Wrapper del repo:
pnpm test:live:media music
Este archivo live carga las variables de entorno de proveedor que faltan desde ~/.profile, prefiere las claves de API de live/env antes que los perfiles de autenticación almacenados de forma predeterminada y ejecuta tanto la cobertura de generate como la de edit declarada cuando el proveedor habilita el modo edit. Cobertura actual:
  • google: generate más edit
  • minimax: solo generate
  • comfy: cobertura live separada de Comfy, no el barrido compartido de proveedores
Cobertura live opcional para la ruta de música de ComfyUI incluida:
OPENCLAW_LIVE_TEST=1 COMFY_LIVE_TEST=1 pnpm test:live -- extensions/comfy/comfy.live.test.ts
El archivo live de Comfy también cubre flujos de trabajo de imagen y video de comfy cuando esas secciones están configuradas.

Relacionado