https://github.com/deepgram-starters/flask-live-text-to-speech
Get started using Deepgram's Live Text-to-Speech with this Flask demo app
https://github.com/deepgram-starters/flask-live-text-to-speech
deepgram live real-time text-to-speech tts websockets
Last synced: 4 months ago
JSON representation
Get started using Deepgram's Live Text-to-Speech with this Flask demo app
- Host: GitHub
- URL: https://github.com/deepgram-starters/flask-live-text-to-speech
- Owner: deepgram-starters
- License: mit
- Created: 2024-08-29T19:27:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-09T17:36:48.000Z (about 1 year ago)
- Last Synced: 2025-05-09T18:46:32.866Z (about 1 year ago)
- Topics: deepgram, live, real-time, text-to-speech, tts, websockets
- Language: Python
- Homepage: https://community.deepgram.com/
- Size: 123 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Flask Live Text-to-Speech Starter
[](https://discord.gg/xWRaCDBtW4)
This example app demonstrates how to use the Deepgram Text-to-Speech API over WebSockets with Flask/Python.
The flow of this sample is:
1. A websocket is opened from the UI to the backend Flask component
1. Text is sent over a websocket to the backend component
1. If a connection has not been established to Deepgram, create a websocket connection using the Python SDK and send the text to convert to audio
1. An audio byte response with synthesized text-to-speech is returned and forward back through the WebSocket created by the UI
1. Those audio bytes are then played by the media device contained within your browser
## What is Deepgram?
[Deepgram’s](https://deepgram.com/) voice AI platform provides APIs for speech-to-text, text-to-speech, and full speech-to-speech voice agents. Over 200,000+ developers use Deepgram to build voice AI products and features.
## Sign-up to Deepgram
Before you start, it's essential to generate a Deepgram API key to use in this project. [Sign-up now for Deepgram and create an API key](https://console.deepgram.com/signup?jump=keys).
## Quickstart
### Manual
Follow these steps to get started with this starter application.
#### Clone the repository
Go to GitHub and [clone the repository](https://github.com/deepgram-starters/flask-live-text-to-speech).
#### Install dependencies
Install the project dependencies.
```bash
pip install -r requirements.txt
```
#### Set your Deepgram API key
If using bash, this can be done in your `~/.bash_profile` like so:
```bash
export DEEPGRAM_API_KEY="YOUR_DEEPGRAM_API_KEY"
```
#### Run the Flask Application
If you have set your `DEEPGRAM_API_KEY` environment variable, start the Backend go application using this command:
```bash
python app.py
```
If you haven't, this could also be done by a simple export before executing your Go application:
```bash
DEEPGRAM_API_KEY="YOUR_DEEPGRAM_API_KEY" python app.py
```
This will start both the Frontend UI and Backend Component. You should see output like this:
```bash
* Serving Flask app 'app'
* Debug mode: on
WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
* Running on http://127.0.0.1:5000
Press CTRL+C to quit
```
Copy and paste the URL with port (ie `http://127.0.0.1:5000`) into your web browser to start converting text into audio!
## Issue Reporting
If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The [Security Policy](./SECURITY.md) details the procedure for contacting Deepgram.
## Getting Help
We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:
- [Open an issue in this repository](https://github.com/deepgram-starters/flask-live-text-to-speech/issues/new)
- [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions)
- [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4)
## Author
[Deepgram](https://deepgram.com)
## License
This project is licensed under the MIT license. See the [LICENSE](./LICENSE) file for more info.