OpenSpeech TTS API
A simple and effective Text-to-Speech API compatible with OpenAI's endpoint
Explore the docs »
View Demo
·
Report Bug
·
(back to top)
### Built With
We used Python + Flask + Gevent WSGI for depolyment and Edge TTS for the TTS support.
(back to top)
## Getting Started
This is how you will succesfully run your OpenSpeech TTS Server:
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
Python 3.10 + above with the following libarires in a virtual environment:
```sh
pip install Flask
pip install edge-tts
pip install cryptography
pip install gevent
pip install art
```
### Installation
_Below is a step by step installation guide to run succesfuly the TTS Server._
1. Clone the repo
```sh
git clone https://github.com/github_username/repo_name.git
```
3. Create & Activate a Virtual Environment in Python
```sh
python -m venv /path/to/new/virtual/environment
source
/bin/activate
```
4. Run the api.py python
```js
cd ./openspeech-tts/main
python api.py
```
5. When prompted, enter the desired API key that you want to access the server & the Port to forward the API
```sh
Enter API Key: ....
Enter Port: ....
```
6. The server is up and ready to run!
(back to top)
## Usage
You can use the TTS API in the same way you use the OpenAI Text-to-Speech:
```sh
curl http://localhost:5000/v1/audio/speech \
-H "Authorization: Bearer API-KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "tts-1",
"input": "Today is a wonderful day to build something people love!",
"voice": "alloy"
}' \
--output speech.mp3
```
_For the request example, please refer to the [Sample Request Curl](https://example.com)_
(back to top)
## Roadmap
- [x] Add Changelog
- [x] Add main api.py file
- [ ] Add Additional Examples
- [ ] Adding secure https connection
- [ ] Adding more endpoints from OpenAI API
- [ ] v1/audio/translations
- [ ] v1/audio/transcriptions
See the [open issues](https://github.com/PantelisDeveloping/openspeech-tts/) for a full list of proposed features (and known issues).
(back to top)
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b PantelisDeveloping/openspeech-tts`)
3. Commit your Changes (`git commit -m 'Committing changes'`)
4. Push to the Branch (`git push origin PantelisDeveloping/openspeech-tts`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
(back to top)
## Contact
Pantelis
Project Link: [https://github.com/PantelisDeveloping/openspeech-tts](https://github.com/PantelisDeveloping/openspeech-tts)
(back to top)
---
license: apache-2.0
---