Voice AI Public APIs Overview
What are the Voice AI Public APIs?
The Voice AI Public APIs provide a programmatic interface for managing and integrating the Voice AI feature within your CRM. Instead of relying solely on the application's graphical interface, you can use these APIs to automate the creation and management of voice agents, retrieve detailed call information, and connect real-time events to your external systems.
Key Benefits of Using the APIs
- Automated Management: Programmatically create, update, and organize your voice agents and their actions, ensuring consistent configurations across your business.
- Comprehensive Data Access: Retrieve call logs, transcripts, and outcomes for in-depth analysis, reporting, and compliance needs.
- Seamless Integration: Use webhooks to receive real-time call data directly into your own applications and workflows, allowing for immediate action based on call events.
API Documentation and Sections
For the most up-to-date technical details, including authentication, endpoints, and request/response schemas, always refer to the official API documentation. The APIs are organized into the following main categories:
Voices (Catalog APIs)
These APIs allow you to browse the available synthetic voices for your agents.
- Get Voices: Retrieve a list of available voices. You can filter the list by language and specify an agent ID to see only compatible voices.
- Fetch Voice Details: Get detailed metadata for a specific voice, which includes a preview URL so you can listen to the voice before assigning it.
Call Log APIs
Access detailed records of calls handled by your Voice AI agents.
- List Call Logs: Returns a list of call logs for a specific location. You can filter the results by agent, contact, call type, action types, and date range. The results support sorting and pagination.
- Get Call Log: Retrieve the complete details for a single call using its unique call ID.
Agents APIs
Manage the configuration and settings of your Voice AI agents.
- Create Agent: Set up a new voice agent with a specific configuration.
- List Agents: Get a paginated list of all agents for a given location.
- Get Agent: Fetch the full configuration and settings for a specific agent.
- Patch Agent: Make partial updates to an existing agent's configuration.
- Delete Agent: Permanently remove an agent and all of its associated settings.
Actions APIs
Define and manage the specific behaviors that an agent can perform during a call, such as triggering a webhook or fetching data.
- Create Agent Action: Define a new action for a voice agent.
- Get Agent Action: Retrieve the configuration details for a specific action.
- Update Agent Action: Modify the parameters and behavior of an existing action.
- Delete Agent Action: Permanently remove an action from an agent.
Frequently Asked Questions
Can I manage voices via the API?
Yes. The Voices (Catalog) APIs allow you to retrieve the list of available voices and get detailed information about each one to help you make a selection.
What permissions are required to use these APIs?
You must have the appropriate user permissions within the CRM to manage Voice AI features and access call data. If you are unable to access certain resources, please consult your account administrator.
Where can I find the latest API specifications?
The official API documentation is the definitive source for all current endpoints, authentication methods, and data schemas. Always refer to this documentation for the most recent information.