https://github.com/deepgram-starters/django-voice-agent
Get started using Deepgram's Voice Agent with this Django demo app
https://github.com/deepgram-starters/django-voice-agent
agent-api deepgram live real-time speech-to-speech voice-agent websocket
Last synced: 4 months ago
JSON representation
Get started using Deepgram's Voice Agent with this Django demo app
- Host: GitHub
- URL: https://github.com/deepgram-starters/django-voice-agent
- Owner: deepgram-starters
- License: mit
- Created: 2025-05-15T14:04:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-20T23:18:42.000Z (10 months ago)
- Last Synced: 2025-08-21T01:15:02.421Z (10 months ago)
- Topics: agent-api, deepgram, live, real-time, speech-to-speech, voice-agent, websocket
- Language: Python
- Homepage: https://community.deepgram.com/
- Size: 45.9 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Django Voice Agent Starter
Get started using Deepgram's Voice Agent capabilities with this Python Django demo app. This application demonstrates how to integrate Deepgram's services to build a voice-controlled agent.
## 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).
## Prerequisites
- Python 3.8 or higher
- pip for package installation
- A [Deepgram API Key](https://console.deepgram.com/signup?jump=keys)
## Quickstart
Follow these steps to get started with this starter application.
### Clone the repository
1. Go to Github and [clone](https://github.com/deepgram-starters/django-voice-agent.git)
2. Install dependencies:
```bash
pip install -r requirements.txt
```
3. Set your Deepgram API key:
```bash
export DEEPGRAM_API_KEY=your_api_key_here
```
## Running the Application
Start the application server:
```bash
python app.py
```
Then open your browser and go to:
```
http://localhost:8080
```
- 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](.cursor/rules/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](https://www.cursor.com/) 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](.cursor/rules/app-requirements.mdc)
## Testing
Test the application with:
```bash
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](https://github.com/deepgram-starters/django-voice-agent/issues/new)
- [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions)
- [Join the Deepgram Discord Community](https://discord.gg/deepgram)
## Contributing
Contributions are welcome! Please see our [Contributing Guidelines](./CONTRIBUTING.md) for more details on how to submit pull requests, report issues, and suggest enhancements.
## Code of Conduct
This project and everyone participating in it is governed by the [Deepgram Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
## Security
If you discover a security vulnerability, please follow our [Security Policy](./SECURITY.md) to report it. Please do not report security vulnerabilities on the public GitHub issue tracker.
## License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
## Author
[Deepgram](https://deepgram.com)