Skip to content

API_HTTP.md

Latest commit

 

History

History
45 lines (32 loc) · 1.21 KB

API_HTTP.md

File metadata and controls

45 lines (32 loc) · 1.21 KB
Raw

🌐 HTTP API

Install the necessary dependencies:

python3 -m pip install piper-tts[http]

Download a voice, for example:

python3 -m piper.download_voices en_US-lessac-medium

Run the web server:

python3 -m piper.http_server -m en_US-lessac-medium

This will start an HTTP server on port 5000 (use --host and --port to override). If you have voices in a different directory, use --data-dir <DIR>

Now you can get WAV files via HTTP:

curl -X POST -H 'Content-Type: application/json' -d '{ "text": "This is a test." }' -o test.wav localhost:5000

The JSON data fields area:

  • text (required) - text to synthesize
  • voice (optional) - name of voice to use; defaults to -m <VOICE>
  • speaker (optional) - name of speaker for multi-speaker voices
  • speaker_id (optional) - id of speaker for multi-speaker voices; overrides speaker
  • length_scale (optional) - speaking speed; defaults to 1
  • noise_scale (optional) - speaking variability
  • noise_w_scale (optional) - phoneme width variability
  • realtime (optional) - stream with a provisional WAV header and zero‑padding for low‑latency playback

Get the available voices with:

curl localhost:5000/voices