AlatDocumentation Index
Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
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
- Didukung penyedia bersama
- Alur kerja ComfyUI
Konfigurasikan auth
Tetapkan kunci API untuk setidaknya satu penyedia — misalnya
GEMINI_API_KEY atau MINIMAX_API_KEY.Penyedia yang didukung
| Penyedia | Model default | Input referensi | Kontrol yang didukung | Auth |
|---|---|---|---|---|
| ComfyUI | workflow | Hingga 1 gambar | Musik atau audio yang ditentukan alur kerja | COMFY_API_KEY, COMFY_CLOUD_API_KEY |
lyria-3-clip-preview | Hingga 10 gambar | lyrics, instrumental, format | GEMINI_API_KEY, GOOGLE_API_KEY | |
| MiniMax | music-2.6 | Tidak ada | lyrics, instrumental, durationSeconds, format=mp3 | MINIMAX_API_KEY atau OAuth MiniMax |
Matriks kapabilitas
Kontrak mode eksplisit yang digunakan olehmusic_generate, pengujian kontrak, dan
sweep live bersama:
| Penyedia | generate | edit | Batas edit | Lane live bersama |
|---|---|---|---|---|
| ComfyUI | ✓ | ✓ | 1 gambar | Tidak ada dalam sweep bersama; dicakup oleh extensions/comfy/comfy.live.test.ts |
| ✓ | ✓ | 10 gambar | generate, edit | |
| MiniMax | ✓ | — | Tidak ada | generate |
action: "list" untuk memeriksa penyedia dan model bersama yang tersedia saat
runtime:
action: "status" untuk memeriksa tugas musik berbasis sesi yang aktif:
Parameter alat
Prompt pembuatan musik. Wajib untuk
action: "generate"."status" mengembalikan tugas sesi saat ini; "list" memeriksa penyedia.Override penyedia/model (mis.
google/lyria-3-pro-preview,
comfy/workflow).Lirik opsional ketika penyedia mendukung input lirik eksplisit.
Minta output khusus instrumental ketika penyedia mendukungnya.
Path atau URL gambar referensi tunggal.
Beberapa gambar referensi (hingga 10 pada penyedia yang mendukung).
Durasi target dalam detik ketika penyedia mendukung petunjuk durasi.
Petunjuk format output ketika penyedia mendukungnya.
Petunjuk nama file output.
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_generatemembuat 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
queuedataurunning, panggilanmusic_generateberikutnya dalam sesi yang sama mengembalikan status tugas alih-alih memulai pembuatan lain. Gunakanaction: "status"untuk memeriksa secara eksplisit. - Pencarian status:
openclaw tasks listatauopenclaw 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_generatelagi 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
| Status | Arti |
|---|---|
queued | Tugas dibuat, menunggu penyedia menerimanya. |
running | Penyedia sedang memproses (biasanya 30 detik hingga 3 menit tergantung penyedia dan durasi). |
succeeded | Trek siap; agen bangun dan mempostingnya ke percakapan. |
failed | Error penyedia atau timeout; agen bangun dengan detail error. |
Konfigurasi
Pemilihan model
Urutan pemilihan penyedia
OpenClaw mencoba penyedia dalam urutan ini:- Parameter
modeldari panggilan alat (jika agen menentukannya). musicGenerationModel.primarydari konfigurasi.musicGenerationModel.fallbackssecara berurutan.- Deteksi otomatis hanya menggunakan default penyedia berbasis auth:
- penyedia default saat ini terlebih dahulu;
- penyedia pembuatan musik terdaftar yang tersisa dalam urutan id penyedia.
agents.defaults.mediaGenerationAutoProviderFallback: false untuk hanya menggunakan
entri model, primary, dan fallbacks eksplisit.
Catatan penyedia
ComfyUI
ComfyUI
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.Google (Lyria 3)
Google (Lyria 3)
Menggunakan pembuatan batch Lyria 3. Alur bawaan saat ini mendukung
prompt, teks lirik opsional, dan gambar referensi opsional.
MiniMax
MiniMax
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.
Mode kapabilitas penyedia
Kontrak pembuatan musik bersama mendukung deklarasi mode eksplisit:generateuntuk pembuatan hanya dari prompt.editketika permintaan menyertakan satu atau beberapa gambar referensi.
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:~/.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:generatepluseditminimax: hanyageneratecomfy: cakupan live Comfy terpisah, bukan sweep penyedia bersama
Terkait
- Tugas latar belakang — pelacakan tugas untuk eksekusi
music_generateyang terlepas - ComfyUI
- Referensi konfigurasi — konfigurasi
musicGenerationModel - Google (Gemini)
- MiniMax
- Model — konfigurasi model dan failover
- Ikhtisar alat