Skip to content

feat: add article voice-agent-api-access #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Accessing Deepgram's Voice Agent API: Public Availability and Getting Started

Deepgram's Voice Agent API is publicly available, enabling users to incorporate voice agent capabilities into their applications. This API allows for seamless speech-to-speech interactions, making it a valuable tool for developing custom voice solutions.

### Getting Started with Deepgram Voice Agent API

To access and utilize the Deepgram Voice Agent API, follow these steps:

1. **Visit the Developer Documentation:** Begin by visiting the official [Deepgram Voice Agent documentation](https://developers.deepgram.com/docs/voice-agent) to understand the capabilities and usage guidelines.

2. **Create an Agent Configuration:** Use the [Deepgram Playground](http://playground.deepgram.com) to create your configuration file. This tool allows you to test and customize your voice agent settings before deploying them in a live environment.

3. **Integrate the API:** Once your configuration is set, integrate the Voice Agent API into your application using the endpoint `https://api.deepgram.com/agent`. Ensure that your application meets the required setup as outlined in the [documentation](https://developers.deepgram.com/docs/voice-agent).

### Requirements for Building with Voice Agent API
Deepgram's Voice Agent API has specific requirements to ensure smooth integration:
- **API Key:** Obtain a valid API key from Deepgram. This is crucial for authenticating requests.
- **Network Configuration:** Ensure your network allows communication with Deepgram’s API endpoints.
- **Technology Stack Compatibility:** While the API can be integrated into various stacks, refer to our [SDKs available on GitHub](https://github.com/deepgram) to check for any language-specific requirements or support.

### Conclusion
With the public availability of the Deepgram Voice Agent API, developers can readily implement advanced voice interaction capabilities into their projects. Leveraging the combination of the documentation and playground tool, you can create, test, and deploy your solutions efficiently.

If issues persist or the system behavior seems inconsistent, reach out to your Deepgram support representative (if you have one) or visit our community for assistance: [Deepgram Discord Community](https://discord.gg/deepgram)

### References
- [Deepgram Voice Agent Documentation](https://developers.deepgram.com/docs/voice-agent)
- [Deepgram Playground](http://playground.deepgram.com)
- [Deepgram GitHub Repositories](https://github.com/deepgram)
- [Deepgram Discord Community](https://discord.gg/deepgram)