# TTS-API

TTS-API is a REST API service that converts text into spoken Catalan for local projects, letting other programs generate voiceovers, read documents aloud, or add spoken-language features. It is open source and self-hosted, installable on Docker Hub.

Canonical page: https://ourlocalhost.com/app/5909/tts-api

## Description

TTS-API is a REST API service that converts text into spoken Catalan for local projects, letting other programs generate voiceovers, read documents aloud, or add spoken-language features.

## Platform availability

Available on 0 of 10 platforms.

## Health score

15/100 (Low), based on 5 of 5 factors.
- Maintained: 0 (last commit 977 days ago)
- Popular: 31 (36 GitHub stars)
- Easy to install: 25 (0 install platforms, install notes, Docker image)
- Light to run: 10 (16 GB minimum RAM)
- Security check: 20 (1 serious finding, 6 minor, CI, OpenSSF Scorecard 2.8/10)

## Security check

1 serious finding: Uses proxy-addr 2.0.7, which has a known critical vulnerability.
Automated checks on commit b968589, 15 Nov 2026. Not an audit.

## Links

- GitHub: https://github.com/pedroetb/tts-api
- Docker Hub: https://hub.docker.com/r/projecteaina/tts-api

## Common questions

### How do I install the required TTS engines before running the project manually?

Install one or more supported engines such as GoogleSpeech, gTTS, Festival, or eSpeak using the provided package and pip commands. You also need Node.js and npm, then run npm install and npm start.

### How can the Docker Swarm deployment be reverse proxied?

The service is prepared for Traefik and is intended to be reachable at the tts subdomain of the domain you configure. Caddy is used because Docker Swarm does not support device configuration and Traefik cannot proxy Docker containers and Swarm services together, so Caddy fronts the tts-api container.

### How do clients request audio from the running API?

Send POST requests to the API endpoint, or use the built-in web form at the root URL. Both local audio playback and downloading the audio file are available using different voice codes.

---
Source: Our Local Host (https://ourlocalhost.com/app/5909/tts-api), the self-hosted and open-source app directory.
