Tools

音楽生成

music_generate ツールは、ComfyUI、fal、Google、MiniMax、OpenRouter をバックエンドとする共有の音楽生成機能を通じて、音楽または音声を作成します。

セッションに紐づくエージェント実行では、music_generate はバックグラウンドタスクとして開始され、タスク台帳で進行状況を追跡し、トラックの準備ができるとエージェントを起動して、ユーザーに通知し、完成した音声を添付できるようにします。完了エージェントは、セッションの可視返信契約に従います。設定されている場合は自動の最終返信を行い、セッションがメッセージツールを必要とする場合は message(action="send") を使います。リクエスト元のセッションが非アクティブ、または起動に失敗し、生成された音声がまだ返信に含まれていない場合、OpenClaw は不足している音声だけを含む冪等な直接フォールバックを送信します。

クイックスタート

Shared provider-backed

  • Configure auth

    少なくとも1つのプロバイダーに API キーを設定します。たとえば GEMINI_API_KEY または MINIMAX_API_KEY です。

  • Pick a default model (optional)

    json5
    {  agents: {    defaults: {      musicGenerationModel: {        primary: "google/lyria-3-clip-preview",      },    },  },}
  • Ask the agent

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

    エージェントは music_generate を自動的に呼び出します。ツールの許可リスト登録は不要です。

  • セッションに紐づくエージェント実行がない場合(直接/ローカルコンテキスト)、ツールはインラインで実行され、同じツール結果内で最終的なメディアパスを返します。

    ComfyUI workflow

  • Configure the workflow

    ワークフロー JSON とプロンプト/出力ノードを使用して plugins.entries.comfy.config.music を設定します。

  • Cloud auth (optional)

    Comfy Cloud の場合は、COMFY_API_KEY または COMFY_CLOUD_API_KEY を設定します。

  • Call the tool

    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.

    利用可能なプロバイダー/モデルを確認するには action: "list" を使い、アクティブなセッション紐づきの音楽タスクを確認するには action: "status" を使います。

    text
    /tool music_generate action=list/tool music_generate action=status

    直接生成の例:

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

    対応プロバイダー

    プロバイダー デフォルトモデル 参照入力 対応する制御 認証
    ComfyUI workflow 最大1枚の画像 ワークフロー定義の音楽または音声 COMFY_API_KEY, COMFY_CLOUD_API_KEY
    fal fal-ai/minimax-music/v2.6 なし lyrics, instrumental, durationSeconds, format FAL_KEY または FAL_API_KEY
    Google lyria-3-clip-preview 最大10枚の画像 lyrics, instrumental, format GEMINI_API_KEY, GOOGLE_API_KEY
    MiniMax music-2.6 なし lyrics, instrumental, format(mp3 のみ) MINIMAX_API_KEY または MiniMax OAuth
    OpenRouter google/lyria-3-pro-preview 最大1枚の画像 lyrics, instrumental, durationSeconds, format OPENROUTER_API_KEY

    MiniMax は、同じモデルを共有する2つのプロバイダー ID を登録します。API キー認証用の minimax と OAuth 用の minimax-portal です。モデル参照は認証パスに従います(minimax/music-2.6minimax-portal/music-2.6)。MiniMax を参照してください。

    fal は、デフォルトの MiniMax バックエンドモデルに加えて、fal-ai/ace-step/prompt-to-audio(wav、歌詞なし、インストゥルメンタル切り替えなし)と fal-ai/stable-audio-25/text-to-audio(wav、プロンプトのみ)も公開しています。Google のデフォルト lyria-3-clip-preview は mp3 のみを出力します。lyria-3-pro-preview は wav にも対応します。MiniMax は music-2.6-freemusic-covermusic-cover-free も公開しています。OpenRouter は google/lyria-3-clip-preview も公開しています。

    機能マトリクス

    music_generate、契約テスト、共有ライブスイープで使われる明示的なモード契約:

    プロバイダー generate edit 編集上限 共有ライブレーン
    ComfyUI 1枚の画像 共有スイープには含まれません。extensions/comfy/comfy.live.test.ts でカバーされています
    fal なし generate
    Google 10枚の画像 generate, edit
    MiniMax なし generate
    OpenRouter 1枚の画像 generate, edit

    ツールパラメーター

    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 は、設定されている場合は agents.defaults.musicGenerationModel.timeoutMs を使い、120000ms 未満の値は 120000ms に引き上げ、それ以外の場合はプロバイダーリクエストのデフォルトを 300000ms にします。

    非同期動作

    セッションに紐づく音楽生成はバックグラウンドタスクとして実行されます。

    • バックグラウンドタスク: music_generate はバックグラウンドタスクを作成し、開始済み/タスク応答を即座に返し、完成したトラックを後続のエージェントメッセージで後から投稿します。
    • 重複防止: タスクが queued または running の間、同じセッション内の後続の music_generate 呼び出しは、別の生成を開始する代わりにタスクステータスを返します。明示的に確認するには action: "status" を使います。最近完了した一致リクエストも2分間重複排除されます。
    • ステータス参照: openclaw tasks list または openclaw tasks show <taskId> は、キュー済み、実行中、終了状態を確認します。
    • 完了時の起動: OpenClaw は内部の完了イベントを同じセッションに注入し、モデルがユーザー向けの後続メッセージを自分で書けるようにします。
    • プロンプトヒント: 同じセッション内の後続のユーザー/手動ターンでは、音楽タスクがすでに進行中の場合に小さなランタイムヒントを受け取るため、モデルが盲目的に再度 music_generate を呼び出すことはありません。
    • セッションなしフォールバック: 実際のエージェントセッションを持たない直接/ローカルコンテキストはインラインで実行され、同じターンで最終的な音声結果を返します。

    タスクライフサイクル

    音楽タスクは、一般的なタスクレジストリと同じ状態を公開します(timed_outcancelledlost を含む完全な状態マシンについては バックグラウンドタスク を参照してください)。ほとんどの音楽実行は次のように遷移します。

    状態 意味
    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: ["fal/fal-ai/minimax-music/v2.6", "minimax/music-2.6"],      },    },  },}

    プロバイダー選択順序

    OpenClaw は次の順序でプロバイダーを試します。

    1. ツール呼び出しの model パラメーター(エージェントが指定した場合)。
    2. 設定の musicGenerationModel.primary
    3. musicGenerationModel.fallbacks の順序。
    4. 認証済みプロバイダーのデフォルトのみを使った自動検出:
      • 現在のデフォルトテキストモデルプロバイダーが音楽生成も提供している場合は、それを最初に使用します。
      • 残りの登録済み音楽生成プロバイダーを、プロバイダー ID のアルファベット順に使用します。

    プロバイダーが失敗した場合、次の候補が自動的に試されます。すべて失敗した場合、エラーには各試行の詳細が含まれます。

    明示的な modelprimaryfallbacks エントリのみを使うには、agents.defaults.mediaGenerationAutoProviderFallback: false を設定します。

    プロバイダーノート

    ComfyUI

    ワークフロー駆動で、プロンプト/出力フィールド用に構成されたグラフとノードマッピングに依存します。バンドルされた comfy Plugin は、音楽生成プロバイダー レジストリを通じて、共有の music_generate ツールに接続します。

    fal

    共有プロバイダー認証パスを通じて fal モデルエンドポイントを使用します。バンドルされたプロバイダーはデフォルトで fal-ai/minimax-music/v2.6 を使用し、プロンプトから音声へのリクエスト向けに fal-ai/ace-step/prompt-to-audiofal-ai/stable-audio-25/text-to-audio も公開します。 歌詞とインストゥルメンタルモードは MiniMax モデル専用です。他の 2 つの モデルはプロンプトのみです。

    Google (Lyria 3)

    Lyria 3 バッチ生成を使用します。現在のバンドルされたフローは、 プロンプト、任意の歌詞テキスト、任意の参照画像をサポートします。 デフォルトの lyria-3-clip-preview モデルは mp3 のみを出力します。 lyria-3-pro-preview モデルは wav もサポートします。

    MiniMax

    バッチ music_generation エンドポイントを使用します。プロンプト、任意の 歌詞、インストゥルメンタルモード、および minimax API キー認証または minimax-portal OAuth 経由の mp3 出力をサポートします。music-2.6-freemusic-covermusic-cover-free モデルも公開します。

    OpenRouter

    ストリーミングを有効にした OpenRouter チャット補完の音声出力を使用します。 バンドルされたプロバイダーはデフォルトで google/lyria-3-pro-preview を使用し、 openrouter/google/lyria-3-clip-preview も公開します。

    適切なパスの選択

    • 共有プロバイダー支援 は、モデル選択、プロバイダー フェイルオーバー、組み込みの非同期タスク/ステータスフローが必要な場合に使用します。
    • Plugin パス (ComfyUI) は、カスタムワークフローグラフ、または 共有のバンドルされた音楽機能に含まれないプロバイダーが必要な場合に使用します。

    ComfyUI 固有の動作をデバッグしている場合は、 ComfyUI を参照してください。共有プロバイダーの 動作をデバッグしている場合は、falGoogle (Gemini)MiniMax、または OpenRouter から始めてください。

    プロバイダー機能モード

    共有の音楽生成コントラクトは、明示的なモード宣言をサポートします。

    • generate はプロンプトのみの生成用です。
    • edit はリクエストに 1 つ以上の参照画像が含まれる場合に使用します。

    新しいプロバイダー実装では、明示的なモードブロックを優先してください。

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

    maxInputImagessupportsLyricssupportsFormat などのレガシーなフラットフィールドだけでは、編集サポートの告知には 不十分 です。プロバイダーは generateedit を明示的に宣言し、ライブテスト、コントラクト テスト、および共有の music_generate ツールがモードサポートを 決定論的に検証できるようにする必要があります。

    ライブテスト

    共有のバンドルされたプロバイダー (fal、Google、MiniMax、 OpenRouter) 向けのオプトインのライブカバレッジ:

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

    同じテストファイルを実行する同等のリポジトリラッパー:

    bash
    pnpm test:live:media:music

    このライブファイルは、デフォルトで保存済みの認証 プロファイルよりも先に、すでにエクスポートされたプロバイダー環境変数を使用し、 プロバイダーが編集モードを有効にしている場合は generate と宣言済みの edit カバレッジの両方を実行します。現在のカバレッジ:

    • google: generateedit
    • fal: generate のみ
    • minimax: generate のみ
    • openrouter: generateedit
    • comfy: 共有プロバイダーの一括テストではなく、別個の Comfy ライブカバレッジ

    バンドルされた ComfyUI 音楽パス向けのオプトインのライブカバレッジ:

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

    Comfy ライブファイルは、該当セクションが構成されている場合、 comfy の画像および動画ワークフローもカバーします。

    関連

    Was this useful?
    On this page

    On this page