文本转语音(TTS)

OpenClaw 可以使用 ElevenLabs、OpenAI 或 Edge TTS 将出站回复转换为音频。它可以在 OpenClaw 能发送音频的任何地方工作;Telegram 会得到一个圆形语音笔记气泡。

支持的服务

  • ElevenLabs(主要或后备提供商)
  • OpenAI(主要或后备提供商;也用于摘要)
  • Edge TTS(主要或后备提供商;使用 node-edge-tts,没有 API key 时的默认值)

Edge TTS 说明

Edge TTS 通过 node-edge-tts 库使用 Microsoft Edge 的在线神经 TTS 服务。这是一个托管服务(非本地),使用 Microsoft 的端点,不需要 API key。node-edge-tts 暴露了语音配置选项和输出格式,但并非所有选项都受 Edge 服务支持。

因为 Edge TTS 是一个没有发布 SLA 或配额的公共 web 服务,请将其视为尽力而为。如果你需要有保证的限制和支持,请使用 OpenAI 或 ElevenLabs。Microsoft 的 Speech REST API 文档记录了每个请求 10 分钟的音频限制;Edge TTS 没有发布限制,因此假设类似或更低的限制。

可选的 key

如果你想要 OpenAI 或 ElevenLabs:

  • ELEVENLABS_API_KEY(或 XI_API_KEY
  • OPENAI_API_KEY

Edge TTS 需要 API key。如果未找到 API key,OpenClaw 默认使用 Edge TTS(除非通过 messages.tts.edge.enabled=false 禁用)。

如果配置了多个提供商,首先使用选定的提供商,其他提供商作为后备选项。自动摘要使用配置的 summaryModel(或 agents.defaults.model.primary),因此如果启用摘要,该提供商也必须经过身份验证。

服务链接

默认启用吗?

不。自动 TTS 默认关闭。在配置中使用 messages.tts.auto 启用它,或者使用 /tts always(别名:/tts on)按会话启用。

一旦 TTS 开启,Edge TTS 默认启用,并且在没有 OpenAI 或 ElevenLabs API key 时自动使用。

配置

TTS 配置位于 openclaw.json 中的 messages.tts 下。完整架构在 Gateway configuration 中。

最小配置(启用 + 提供商)

{
  messages: {
    tts: {
      auto: "always",
      provider: "elevenlabs"
    }
  }
}

OpenAI 主要,ElevenLabs 后备

{
  messages: {
    tts: {
      auto: "always",
      provider: "openai",
      summaryModel: "openai/gpt-4.1-mini",
      modelOverrides: {
        enabled: true
      },
      openai: {
        apiKey: "openai_api_key",
        model: "gpt-4o-mini-tts",
        voice: "alloy"
      },
      elevenlabs: {
        apiKey: "elevenlabs_api_key",
        baseUrl: "https://api.elevenlabs.io",
        voiceId: "voice_id",
        modelId: "eleven_multilingual_v2",
        seed: 42,
        applyTextNormalization: "auto",
        languageCode: "en",
        voiceSettings: {
          stability: 0.5,
          similarityBoost: 0.75,
          style: 0.0,
          useSpeakerBoost: true,
          speed: 1.0
        }
      }
    }
  }
}

Edge TTS 主要(无 API key)

{
  messages: {
    tts: {
      auto: "always",
      provider: "edge",
      edge: {
        enabled: true,
        voice: "en-US-MichelleNeural",
        lang: "en-US",
        outputFormat: "audio-24khz-48kbitrate-mono-mp3",
        rate: "+10%",
        pitch: "-5%"
      }
    }
  }
}

禁用 Edge TTS

{
  messages: {
    tts: {
      edge: {
        enabled: false
      }
    }
  }
}

自定义限制 + 偏好路径

{
  messages: {
    tts: {
      auto: "always",
      maxTextLength: 4000,
      timeoutMs: 30000,
      prefsPath: "~/.openclaw/settings/tts.json"
    }
  }
}

仅在入站语音笔记后用音频回复

{
  messages: {
    tts: {
      auto: "inbound"
    }
  }
}

禁用长回复的自动摘要

{
  messages: {
    tts: {
      auto: "always"
    }
  }
}

然后运行:

/tts summary off

字段说明

  • auto:自动 TTS 模式(offalwaysinboundtagged)。
    • inbound 仅在入站语音笔记后发送音频。
    • tagged 仅在回复包含 [[tts]] 标签时发送音频。
  • enabled:旧版切换(doctor 将其迁移到 auto)。
  • mode"final"(默认)或 "all"(包括工具/块回复)。
  • provider"elevenlabs""openai""edge"(后备自动)。
  • 如果 provider 未设置,OpenClaw 优先使用 openai(如果有 key),然后 elevenlabs(如果有 key),否则 edge
  • summaryModel:用于自动摘要的可选廉价模型;默认为 agents.defaults.model.primary
    • 接受 provider/model 或配置的模型别名。
  • modelOverrides:允许模型发出 TTS 指令(默认开启)。
  • maxTextLength:TTS 输入的硬上限(字符)。如果超过,/tts audio 失败。
  • timeoutMs:请求超时(毫秒)。
  • prefsPath:覆盖本地偏好 JSON 路径(提供商/限制/摘要)。
  • apiKey 值回退到环境变量(ELEVENLABS_API_KEY/XI_API_KEYOPENAI_API_KEY)。
  • elevenlabs.baseUrl:覆盖 ElevenLabs API base URL。
  • elevenlabs.voiceSettings
    • stabilitysimilarityBooststyle0..1
    • useSpeakerBoosttrue|false
    • speed0.5..2.0(1.0 = 正常)
  • elevenlabs.applyTextNormalizationauto|on|off
  • elevenlabs.languageCode:2 字母 ISO 639-1(例如 ende
  • elevenlabs.seed:整数 0..4294967295(尽力确定性)
  • edge.enabled:允许使用 Edge TTS(默认 true;无 API key)。
  • edge.voice:Edge 神经语音名称(例如 en-US-MichelleNeural)。
  • edge.lang:语言代码(例如 en-US)。
  • edge.outputFormat:Edge 输出格式(例如 audio-24khz-48kbitrate-mono-mp3)。
    • 请参阅 Microsoft Speech 输出格式以获取有效值;并非所有格式都受 Edge 支持。
  • edge.rate / edge.pitch / edge.volume:百分比字符串(例如 +10%-5%)。
  • edge.saveSubtitles:在音频文件旁边写入 JSON 字幕。
  • edge.proxy:Edge TTS 请求的代理 URL。
  • edge.timeoutMs:请求超时覆盖(毫秒)。

模型驱动的覆盖(默认开启)

默认情况下,模型可以为单个回复发出 TTS 指令。当 messages.tts.autotagged 时,需要这些指令来触发音频。

启用后,模型可以发出 [[tts:...]] 指令来覆盖单个回复的语音,以及一个可选的 [[tts:text]]...[[/tts:text]] 块来提供仅应出现在音频中的表现标签(笑声、歌唱提示等)。

示例回复有效负载:

Here you go.

[[tts:provider=elevenlabs voiceId=pMsXgVXv3BLzUgSXRplE model=eleven_v3 speed=1.1]]
[[tts:text]](laughs) Read the song once more.[[/tts:text]]

可用的指令键(启用时):

  • provideropenai | elevenlabs | edge
  • voice(OpenAI 语音)或 voiceId(ElevenLabs)
  • model(OpenAI TTS 模型或 ElevenLabs 模型 id)
  • stabilitysimilarityBooststylespeeduseSpeakerBoost
  • applyTextNormalizationauto|on|off
  • languageCode(ISO 639-1)
  • seed

禁用所有模型覆盖:

{
  messages: {
    tts: {
      modelOverrides: {
        enabled: false
      }
    }
  }
}

可选的允许列表(在保持标签启用的同时禁用特定覆盖):

{
  messages: {
    tts: {
      modelOverrides: {
        enabled: true,
        allowProvider: false,
        allowSeed: false
      }
    }
  }
}

每用户偏好

斜杠命令将本地覆盖写入 prefsPath(默认:~/.openclaw/settings/tts.json,使用 OPENCLAW_TTS_PREFSmessages.tts.prefsPath 覆盖)。

存储的字段:

  • enabled
  • provider
  • maxLength(摘要阈值;默认 1500 字符)
  • summarize(默认 true

这些覆盖该 host 的 messages.tts.*

输出格式(固定)

  • Telegram:Opus 语音笔记(来自 ElevenLabs 的 opus_48000_64,来自 OpenAI 的 opus)。
    • 48kHz / 64kbps 是一个很好的语音笔记权衡,圆形气泡所需。
  • 其他频道:MP3(来自 ElevenLabs 的 mp3_44100_128,来自 OpenAI 的 mp3)。
    • 44.1kHz / 128kbps 是语音清晰度的默认平衡。
  • Edge TTS:使用 edge.outputFormat(默认 audio-24khz-48kbitrate-mono-mp3)。
    • node-edge-tts 接受 outputFormat,但并非所有格式都可从 Edge 服务获得。
    • 输出格式值遵循 Microsoft Speech 输出格式(包括 Ogg/WebM Opus)。
    • Telegram sendVoice 接受 OGG/MP3/M4A;如果需要有保证的 Opus 语音笔记,请使用 OpenAI/ElevenLabs。
    • 如果配置的 Edge 输出格式失败,OpenClaw 会使用 MP3 重试。

OpenAI/ElevenLabs 格式是固定的;Telegram 期望 Opus 用于语音笔记 UX。

自动 TTS 行为

启用后,OpenClaw:

  • 如果回复已包含媒体或 MEDIA: 指令,则跳过 TTS。
  • 跳过非常短的回复(< 10 个字符)。
  • 启用时使用 agents.defaults.model.primary(或 summaryModel)摘要长回复。
  • 将生成的音频附加到回复。

如果回复超过 maxLength 且摘要关闭(或摘要模型没有 API key),则跳过音频并发送正常的文本回复。

流程图

回复 -> TTS 启用?
  否  -> 发送文本
  是 -> 有媒体 / MEDIA: / 短?
          是 -> 发送文本
          否  -> 长度 > 限制?
                   否  -> TTS -> 附加音频
                   是 -> 摘要启用?
                            否  -> 发送文本
                            是 -> 摘要(summaryModel 或 agents.defaults.model.primary)
                                      -> TTS -> 附加音频

斜杠命令用法

有一个命令:/tts。有关启用详细信息,请参见 Slash commands

Discord 说明:/tts 是内置的 Discord 命令,因此 OpenClaw 在那里注册 /voice 作为原生命令。文本 /tts 仍然有效。

/tts off
/tts always
/tts inbound
/tts tagged
/tts status
/tts provider openai
/tts limit 2000
/tts summary off
/tts audio Hello from OpenClaw

说明:

  • 命令需要授权的发送者(允许列表/所有者规则仍然适用)。
  • 必须启用 commands.text 或原生命令注册。
  • off|always|inbound|tagged 是每会话切换(/tts on/tts always 的别名)。
  • limitsummary 存储在本地偏好中,而不是主配置中。
  • /tts audio 生成一次性音频回复(不会打开 TTS)。

Agent 工具

tts 工具将文本转换为语音并返回 MEDIA: 路径。当结果兼容 Telegram 时,该工具包含 [[audio_as_voice]],以便 Telegram 发送语音气泡。

Gateway RPC

Gateway 方法:

  • tts.status
  • tts.enable
  • tts.disable
  • tts.convert
  • tts.setProvider
  • tts.providers