Voice Feature Guide
Learn how to use and configure voice capabilities for your Agent5ive agents.
Overview
The Realtime Voice feature allows your agents to listen and respond using natural speech, creating a more intuitive and accessible interaction experience. This feature leverages OpenAI's speech-to-text (Whisper) and text-to-speech (TTS) technologies to provide high-quality voice interactions.
What is Realtime Voice?
Realtime Voice allows your agent to have spoken conversations with users. Instead of typing messages back and forth, users can:
- Speak to the agent - Users can talk naturally using their microphone
- Hear the agent's responses - The agent responds with a human-like voice
- See text transcripts - All spoken words are also shown as text
This creates a more natural and accessible way to interact with your agent, similar to talking with a virtual assistant like Siri or Alexa, but with all the specialized knowledge and capabilities of your custom agent.
OpenAI API Key Required
Getting an OpenAI API Key
To use the Realtime Voice feature, you'll need an OpenAI API key. An API key is like a special password that allows your agent to use OpenAI's voice technology. You'll also need to have credits (or a payment method) in your OpenAI account to pay for the voice service. Follow these steps to get your API key:
Create an OpenAI account
If you don't already have one, sign up for an account at https://platform.openai.com/signup
Navigate to API keys
Once logged in, go to the API section and select 'API keys' from the left sidebar.
Create a new API key
Click on the 'Create new secret key' button, provide a name for your key (e.g., 'Agent5ive Voice'), and create the key.
Copy your API key
Copy the generated API key immediately and store it securely. Note that OpenAI will only show this key once.
Important Security Notes
- Never share your API key publicly or commit it to version control systems
- Agent5ive securely encrypts your API key in our database
- Your key is only used for processing voice interactions for your agents
- You can revoke access at any time by deleting the key from your OpenAI dashboard
Adding Credits to Your OpenAI Account
To use the voice features, you'll need to ensure your OpenAI account has sufficient credits. New accounts typically receive some free credits, but you'll likely need to add a payment method for continued use.
Access your OpenAI account settings
Log in to your OpenAI account and navigate to the 'Billing' section.
Add a payment method
Add a valid credit card or other supported payment method to your account.
Set usage limits (recommended)
Configure usage limits to prevent unexpected charges. You can set monthly spending caps in the 'Usage limits' section.
Add credits (prepaid)
If available for your account type, you can prepay for credits to better manage your spending.