ovos-tts-server 1.4.0a1

simple FastAPI server to host TTS plugins as a service

OpenVoiceOS TTS Server

Turn any OVOS TTS plugin into a microservice — a small, stateless FastAPI app that exposes a TTS plugin over HTTP.

Install

pip install ovos-tts-server

# Optional: enable non-WAV output (mp3, ogg, flac, ...) via pydub
pip install "ovos-tts-server[audio]"

Companion plugin

Use in your voice assistant via the companion TTS plugin.

Configuration

The plugin is configured the same way as if it were running inside the assistant — through mycroft.conf:

{
  "tts": {
    "module": "ovos-tts-plugin-piper",
    "ovos-tts-plugin-piper": {
      "model": "alan-low"
    }
  }
}

Usage

ovos-tts-server --help
usage: ovos-tts-server [-h] [--engine ENGINE] [--port PORT] [--host HOST] [--cache]

options:
  -h, --help       show this help message and exit
  --engine ENGINE  tts plugin to be used
  --port PORT      port number (default: 9666)
  --host HOST      host (default: 0.0.0.0)
  --cache          save every synth to disk

Example — serve the Piper plugin:

ovos-tts-server --engine ovos-tts-plugin-piper --cache

Then GET http://localhost:9666/synthesize/hello.

Endpoints

Method	Path	Description
GET	/status	Plugin name, supported languages, default voice/model
GET	/v2/synthesize?utterance=<text>[&lang=...][&voice=...]	Primary synthesis endpoint — returns WAV audio
GET	/synthesize/<utterance>	Legacy path-based synthesis endpoint

CORS is enabled for all origins.

Third-party API compatibility

The server can additionally expose its underlying TTS plugin behind drop-in compatibility endpoints for popular cloud TTS APIs — MaryTTS, ElevenLabs, OpenAI, Coqui, Google Cloud TTS, Amazon Polly, Azure, and Piper. Each vendor lives under its own URL prefix so multiple compat layers coexist with no path collisions. Auth tokens are accepted and silently ignored — wrap behind a reverse proxy if you need real auth.

See docs/api-compatibility.md for the full reference.

Documentation

• Configuration & voice/language flow
• Audio format conversion
• API compatibility reference

Docker

Build a small image that serves any plugin:

FROM python:3.11-slim

RUN pip install --no-cache-dir "ovos-tts-server[audio]" {PLUGIN_HERE}

ENTRYPOINT ["ovos-tts-server", "--engine", "{PLUGIN_HERE}", "--cache"]

docker build . -t my_ovos_tts_plugin
docker run -p 8080:9666 my_ovos_tts_plugin

Then GET http://localhost:8080/synthesize/hello.

Each plugin can ship its own Dockerfile in its repository using ovos-tts-server.

Development

pip install -e ".[audio,test]"
pytest test/ -v