Langsung ke konten utama

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.

Alat music_generate memungkinkan agen membuat musik atau audio melalui kapabilitas pembuatan musik bersama dengan penyedia yang dikonfigurasi — Google, MiniMax, dan ComfyUI yang dikonfigurasi alur kerja saat ini. Untuk eksekusi agen berbasis sesi, OpenClaw memulai pembuatan musik sebagai tugas latar belakang, melacaknya di ledger tugas, lalu membangunkan agen lagi saat trek siap sehingga agen dapat memberi tahu pengguna dan melampirkan audio yang sudah selesai. Dalam obrolan grup/channel yang menggunakan pengiriman terlihat hanya melalui alat pesan, agen meneruskan hasil melalui alat pesan. Jika agen penyelesaian hanya menulis balasan akhir privat, OpenClaw melakukan fallback ke pengiriman channel langsung dengan media yang dihasilkan. Wake penyelesaian secara eksplisit memperingatkan agen bahwa balasan akhir normal bersifat privat di rute tersebut.
Alat bersama bawaan hanya muncul ketika setidaknya satu penyedia pembuatan musik tersedia. Jika Anda tidak melihat music_generate di alat agen Anda, konfigurasikan agents.defaults.musicGenerationModel atau siapkan kunci API penyedia.

Mulai cepat

1

Konfigurasikan auth

Tetapkan kunci API untuk setidaknya satu penyedia — misalnya GEMINI_API_KEY atau MINIMAX_API_KEY.
2

Pilih model default (opsional)

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

Minta agen

“Generate an upbeat synthpop track about a night drive through a neon city.”Agen memanggil music_generate secara otomatis. Tidak perlu allow-list alat.
Untuk konteks sinkron langsung tanpa eksekusi agen berbasis sesi, alat bawaan tetap melakukan fallback ke pembuatan inline dan mengembalikan path media akhir dalam hasil alat.
Contoh prompt:
Generate a cinematic piano track with soft strings and no vocals.
Generate an energetic chiptune loop about launching a rocket at sunrise.

Penyedia yang didukung

PenyediaModel defaultInput referensiKontrol yang didukungAuth
ComfyUIworkflowHingga 1 gambarMusik atau audio yang ditentukan alur kerjaCOMFY_API_KEY, COMFY_CLOUD_API_KEY
Googlelyria-3-clip-previewHingga 10 gambarlyrics, instrumental, formatGEMINI_API_KEY, GOOGLE_API_KEY
MiniMaxmusic-2.6Tidak adalyrics, instrumental, durationSeconds, format=mp3MINIMAX_API_KEY atau OAuth MiniMax

Matriks kapabilitas

Kontrak mode eksplisit yang digunakan oleh music_generate, pengujian kontrak, dan sweep live bersama:
PenyediagenerateeditBatas editLane live bersama
ComfyUI1 gambarTidak ada dalam sweep bersama; dicakup oleh extensions/comfy/comfy.live.test.ts
Google10 gambargenerate, edit
MiniMaxTidak adagenerate
Gunakan action: "list" untuk memeriksa penyedia dan model bersama yang tersedia saat runtime:
/tool music_generate action=list
Gunakan action: "status" untuk memeriksa tugas musik berbasis sesi yang aktif:
/tool music_generate action=status
Contoh pembuatan langsung:
/tool music_generate prompt="Dreamy lo-fi hip hop with vinyl texture and gentle rain" instrumental=true

Parameter alat

prompt
string
wajib
Prompt pembuatan musik. Wajib untuk action: "generate".
action
"generate" | "status" | "list"
default:"generate"
"status" mengembalikan tugas sesi saat ini; "list" memeriksa penyedia.
model
string
Override penyedia/model (mis. google/lyria-3-pro-preview, comfy/workflow).
lyrics
string
Lirik opsional ketika penyedia mendukung input lirik eksplisit.
instrumental
boolean
Minta output khusus instrumental ketika penyedia mendukungnya.
image
string
Path atau URL gambar referensi tunggal.
images
string[]
Beberapa gambar referensi (hingga 10 pada penyedia yang mendukung).
durationSeconds
number
Durasi target dalam detik ketika penyedia mendukung petunjuk durasi.
format
"mp3" | "wav"
Petunjuk format output ketika penyedia mendukungnya.
filename
string
Petunjuk nama file output.
timeoutMs
number
Timeout permintaan penyedia opsional dalam milidetik. Jika dihilangkan, OpenClaw menggunakan agents.defaults.musicGenerationModel.timeoutMs jika dikonfigurasi. Nilai di bawah 10000ms dinaikkan menjadi 10000ms dan dilaporkan dalam hasil alat.
Tidak semua penyedia mendukung semua parameter. OpenClaw tetap memvalidasi batas keras seperti jumlah input sebelum pengiriman. Ketika penyedia mendukung durasi tetapi menggunakan maksimum yang lebih pendek daripada nilai yang diminta, OpenClaw membatasi ke durasi terdekat yang didukung. Petunjuk opsional yang benar-benar tidak didukung diabaikan dengan peringatan ketika penyedia atau model yang dipilih tidak dapat mematuhinya. Hasil alat melaporkan pengaturan yang diterapkan; details.normalization menangkap pemetaan dari yang diminta ke yang diterapkan.

Perilaku async

Pembuatan musik berbasis sesi berjalan sebagai tugas latar belakang:
  • Tugas latar belakang: music_generate membuat tugas latar belakang, segera mengembalikan respons dimulai/tugas, dan memposting trek yang sudah selesai nanti dalam pesan agen tindak lanjut.
  • Pencegahan duplikat: saat tugas berstatus queued atau running, panggilan music_generate berikutnya dalam sesi yang sama mengembalikan status tugas alih-alih memulai pembuatan lain. Gunakan action: "status" untuk memeriksa secara eksplisit.
  • Pencarian status: openclaw tasks list atau openclaw tasks show <taskId> memeriksa status antrean, berjalan, dan terminal.
  • Wake penyelesaian: OpenClaw menyuntikkan event penyelesaian internal kembali ke sesi yang sama sehingga model dapat menulis tindak lanjut yang terlihat pengguna sendiri.
  • Petunjuk prompt: giliran pengguna/manual berikutnya dalam sesi yang sama mendapatkan petunjuk runtime kecil saat tugas musik sudah berjalan, sehingga model tidak memanggil music_generate lagi secara membabi buta.
  • Fallback tanpa sesi: konteks langsung/lokal tanpa sesi agen nyata berjalan inline dan mengembalikan hasil audio akhir dalam giliran yang sama.

Siklus hidup tugas

StatusArti
queuedTugas dibuat, menunggu penyedia menerimanya.
runningPenyedia sedang memproses (biasanya 30 detik hingga 3 menit tergantung penyedia dan durasi).
succeededTrek siap; agen bangun dan mempostingnya ke percakapan.
failedError penyedia atau timeout; agen bangun dengan detail error.
Periksa status dari CLI:
openclaw tasks list
openclaw tasks show <taskId>
openclaw tasks cancel <taskId>

Konfigurasi

Pemilihan model

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

Urutan pemilihan penyedia

OpenClaw mencoba penyedia dalam urutan ini:
  1. Parameter model dari panggilan alat (jika agen menentukannya).
  2. musicGenerationModel.primary dari konfigurasi.
  3. musicGenerationModel.fallbacks secara berurutan.
  4. Deteksi otomatis hanya menggunakan default penyedia berbasis auth:
    • penyedia default saat ini terlebih dahulu;
    • penyedia pembuatan musik terdaftar yang tersisa dalam urutan id penyedia.
Jika penyedia gagal, kandidat berikutnya dicoba secara otomatis. Jika semuanya gagal, error menyertakan detail dari setiap percobaan. Tetapkan agents.defaults.mediaGenerationAutoProviderFallback: false untuk hanya menggunakan entri model, primary, dan fallbacks eksplisit.

Catatan penyedia

Digerakkan alur kerja dan bergantung pada graph yang dikonfigurasi plus pemetaan node untuk field prompt/output. Plugin comfy bawaan terhubung ke alat music_generate bersama melalui registry penyedia pembuatan musik bersama.
Menggunakan pembuatan batch Lyria 3. Alur bawaan saat ini mendukung prompt, teks lirik opsional, dan gambar referensi opsional.
Menggunakan endpoint batch music_generation. Mendukung prompt, lirik opsional, mode instrumental, pengarah durasi, dan output mp3 melalui auth kunci API minimax atau OAuth minimax-portal.

Memilih jalur yang tepat

  • Didukung penyedia bersama ketika Anda menginginkan pemilihan model, failover penyedia, dan alur async tugas/status bawaan.
  • Jalur Plugin (ComfyUI) ketika Anda memerlukan graph alur kerja khusus atau penyedia yang bukan bagian dari kapabilitas musik bawaan bersama.
Jika Anda men-debug perilaku khusus ComfyUI, lihat ComfyUI. Jika Anda men-debug perilaku penyedia bersama, mulai dengan Google (Gemini) atau MiniMax.

Mode kapabilitas penyedia

Kontrak pembuatan musik bersama mendukung deklarasi mode eksplisit:
  • generate untuk pembuatan hanya dari prompt.
  • edit ketika permintaan menyertakan satu atau beberapa gambar referensi.
Implementasi penyedia baru sebaiknya menggunakan blok mode eksplisit:
capabilities: {
  generate: {
    maxTracks: 1,
    supportsLyrics: true,
    supportsFormat: true,
  },
  edit: {
    enabled: true,
    maxTracks: 1,
    maxInputImages: 1,
    supportsFormat: true,
  },
}
Field datar legacy seperti maxInputImages, supportsLyrics, dan supportsFormat tidak cukup untuk mengiklankan dukungan edit. Penyedia harus mendeklarasikan generate dan edit secara eksplisit agar pengujian live, pengujian kontrak, dan alat music_generate bersama dapat memvalidasi dukungan mode secara deterministik.

Pengujian live

Cakupan live opt-in untuk penyedia bawaan bersama:
OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/music-generation-providers.live.test.ts
Wrapper repo:
pnpm test:live:media music
File live ini memuat env var penyedia yang hilang dari ~/.profile, secara default memprioritaskan kunci API live/env di atas profil auth yang tersimpan, dan menjalankan cakupan generate serta edit yang dideklarasikan saat penyedia mengaktifkan mode edit. Cakupan saat ini:
  • google: generate plus edit
  • minimax: hanya generate
  • comfy: cakupan live Comfy terpisah, bukan sweep penyedia bersama
Ikut serta dalam cakupan live untuk jalur musik ComfyUI bawaan:
OPENCLAW_LIVE_TEST=1 COMFY_LIVE_TEST=1 pnpm test:live -- extensions/comfy/comfy.live.test.ts
File live Comfy juga mencakup alur kerja gambar dan video comfy saat bagian-bagian tersebut dikonfigurasi.

Terkait