Deepgram Voicebot

A demo is live at https://deepgram.com/agent

Table of contents:

• Prerequisites
• Getting started

Getting an API Key

🔑 To access the Deepgram API you will need a free Deepgram API Key.

Prerequisites

• Node v20 or higher (though I recommend installing it through nvm)
• yarn

Getting started

Assuming you want to develop "locally", i.e. bring-your-own-key, just set a DEEPGRAM_API_KEY environment variable and run the dev command. Any DG key will do, it just needs usage:write.

Create a .env file

Create a .env file in the root of the project and add the following:

DEEPGRAM_API_KEY=<your-deepgram-api-key>

See sample.env.local for more details.

Use a CLI-compatible password manager

Remember: use minimally-privileged keys, avoid sending them in shell commands, and avoid saving them as plaintext to files! One secure approach is to use a CLI-compatible password manager like pass or bitwarden. A pass example:

DEEPGRAM_API_KEY=$(pass deepgram/my-key) yarn dev

Installing dependencies

yarn install

Running the app

yarn dev

When Next.js starts up, it'll give you a localhost URL to visit.

Documentation

You can learn more about the Deepgram API at developers.deepgram.com.

Development and Contributing

Interested in contributing? We ❤️ pull requests!

To make sure our community is safe for all, be sure to review and agree to our Code of Conduct. Then see the Contribution guidelines for more information.

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