mirror of
https://github.com/openclaw/openclaw.git
synced 2026-07-11 03:16:03 +00:00
Source-grounded rewrite of 529 published docs pages with per-unit information-loss verification: 1,713 factual corrections cited to src/**, generated surfaces regenerated, frontmatter titles preserved for i18n, release notes pages untouched. All docs gates green. Closes #100141
5.2 KiB
5.2 KiB
summary, read_when, title
| summary | read_when | title | ||
|---|---|---|---|---|
| Inworld streaming text-to-speech for OpenClaw replies |
|
Inworld |
Inworld is a streaming text-to-speech (TTS) provider. In OpenClaw it synthesizes outbound reply audio (MP3 by default, OGG_OPUS for voice notes) and raw PCM audio for telephony channels such as Voice Call.
OpenClaw posts to Inworld's streaming TTS endpoint, concatenates the returned base64 audio chunks into a single buffer, and hands the result to the standard reply-audio pipeline.
| Property | Value |
|---|---|
| Provider id | inworld |
| Plugin | official external package (@openclaw/inworld-speech) |
| Contract | speechProviders (TTS only) |
| Auth env var | INWORLD_API_KEY (HTTP Basic, Base64 dashboard credential) |
| Base URL | https://api.inworld.ai |
| Default voice | Sarah |
| Default model | inworld-tts-1.5-max |
| Output | MP3 (default), OGG_OPUS (voice notes), PCM 22050 Hz (telephony) |
| Website | inworld.ai |
| Docs | docs.inworld.ai/tts/tts |
Install plugin
openclaw plugins install @openclaw/inworld-speech
openclaw gateway restart
Getting started
Copy the credential from your Inworld dashboard (Workspace > API Keys) and set it as an env var. The value is sent verbatim as the HTTP Basic credential, so do not Base64-encode it again or convert it to a bearer token.```bash
INWORLD_API_KEY=<base64-credential-from-dashboard>
```
```json5
{
messages: {
tts: {
auto: "always",
provider: "inworld",
providers: {
inworld: {
voiceId: "Sarah",
modelId: "inworld-tts-1.5-max",
},
},
},
},
}
```
Send a reply through any connected channel. OpenClaw synthesizes the audio with Inworld and delivers it as MP3 (or OGG_OPUS when the channel expects a voice note).
Configuration options
| Option | Path | Description |
|---|---|---|
apiKey |
messages.tts.providers.inworld.apiKey |
Base64 dashboard credential. Falls back to INWORLD_API_KEY. |
baseUrl |
messages.tts.providers.inworld.baseUrl |
Override Inworld API base URL (default https://api.inworld.ai). |
voiceId |
messages.tts.providers.inworld.voiceId |
Voice identifier (default Sarah). Legacy alias: speakerVoiceId. |
modelId |
messages.tts.providers.inworld.modelId |
TTS model id (default inworld-tts-1.5-max). |
temperature |
messages.tts.providers.inworld.temperature |
Sampling temperature, 0 (exclusive) to 2 (optional). |