Flask Voice Agent Starter

Start building interactive voice experiences with Deepgram's Voice Agent API using Python Flask starter application. This project demonstrates how to create a voice agent that can engage in natural conversations using Deepgram's advanced AI capabilities.

What is Deepgram?

Deepgram's 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.

Prerequisites

• Python 3.8 or higher
• Deepgram API key
• Modern web browser with microphone support
• Port Audio installed locally

Quickstart

Follow these steps to get started with this starter application.

Clone the repository

1. Go to GitHub and clone the repository.

2. Install dependencies:

pip install -r requirements.txt

3. Set your Deepgram API key:

export DEEPGRAM_API_KEY=your_api_key_here

Running the Application

Start the Flask server:

python app.py

Then open your browser and go to:

http://localhost:3000

• Allow microphone access when prompted.
• Speak into your microphone to interact with the Deepgram Voice Agent.
• You should hear the agent's responses played back in your browser.

Using Cursor & MDC Rules

This application can be modify as needed by using the app-requirements.mdc file. This file allows you to specify various settings and parameters for the application in a structured format that can be use along with Cursor's AI Powered Code Editor.

Using the app-requirements.mdc File

1. Clone or Fork this repo.
2. Modify the app-requirements.mdc
3. Add the necessary configuration settings in the file.
4. You can refer to the MDC file used to help build this starter application by reviewing app-requirements.mdc

Testing

Test the application with:

pytest -v test_app.py

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
• Join the Deepgram Github Discussions Community
• Join the Deepgram Discord Community

Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Security

For security concerns, please see our Security Policy.

Code of Conduct

Please see our Code of Conduct for community guidelines.

Author

Deepgram

License

This project is licensed under the MIT license. See the LICENSE file for more info.