/

Docs
History
Schema
Generate

Filter operations

Conversations2

get/v1/projects/statistics/numbersGet project statistics with numbers
get/v1/projects/statistics/chartGet project statistics chart data
post/v1/jobs/transcribeTranscribe media to text
get/v1/jobs/ai-contentGet AI-generated content
post/v1/jobs/ai-contentCreate AI Content
post/v1/jobs/allGet a list of jobs
get/v1/jobsRetrieve job details
get/v1/projects/by-api-keyGet a project by API key
post/v1/jobs/ai-content/customGenerate Customized AI Content
get/v1/jobs/ai-content/estimateEstimate AI Content Cost
get/v1/voice-agentsRetrieve a list of voice agents
post/v1/voice-agentsCreate a new voice agent
get/v1/voice-agents/{voiceAgentId}Retrieve a specific voice agent by ID
patch/v1/voice-agents/{voiceAgentId}Update an existing voice agent
post/v1/voice-agents/callInitiate a call with a voice agent. This endpoint is kept to testing outbound calls via Twilio only.
post/v1/voice-agents/cloneClone a voice agent
post/v1/jobs/text-to-speechInitiate a text to speech job
post/v1/realtime/ttsGenerates an audio file from a text string (not streamed).
post/v1/realtime/tts-streamGenerates a streamed audio file from a text string.
post/v1/realtime/sttGenerates an speech to text transcription (not streamed).
get/v1/voice-agents/phone-numberGet a phone number by its ID.
post/v1/voice-agents/phone-numberAdd a phone number for a user.
delete/v1/voice-agents/phone-numberDelete a Phone Number
post/v1/voice-agents/assign-numberAssign a phone number to a Voice Agent.
post/v1/voice-agents/unassignUnassign a phone number from Voice Agents.
get/v1/voice-agents/phone-number/listReturn a list of phone numbers for a user.
post/v1/voice-agents/phone-number/callCall Voice Agent using Twilio custom phone number.
post/v1/voice-agents/knowledge-baseCreate new knowledge base items.
get/v1/voice-agents/knowledge-base/{id}Get Knowledge Base Item by ID.
delete/v1/voice-agents/knowledge-base/{id}Delete Knowledge Base Item.
patch/v1/voice-agents/knowledge-base/{id}Update a knowledge base item by Id.
get/v1/voice-agents/knowledge-base/listReturn a list of Knowledge Base Items.
post/v1/voice-agents/knowledge-base/toggle-activationToggle activation of a knowledge base item for a voice agent.
get/v1/voice-agents/knowledge-base/size-infoGet Knowledge Base Size Information.
post/v1/voice-agents/knowledge-base/{id}/urlAdd URL to Knowledge Base URL Item.
delete/v1/voice-agents/knowledge-base/{id}/urlDelete URL from Knowledge Base URL Item.
post/v1/voice-agents/web-toolCreate a new web tool.
get/v1/voice-agents/web-tool/{id}Get a web tool by ID.
delete/v1/voice-agents/web-tool/{id}Delete a web tool by Id.
patch/v1/voice-agents/web-tool/{id}Update a web tool by Id.
get/v1/voice-agents/web-tool/listReturn a list of Web Tools.
post/v1/voice-agents/web-tool/toggle-activationToggle activation of a web tool for a voice agent.
post/v1/voice-agents/web-tool/version-checkCheck for newer versions of Web Tools.
post/v1/voice-agents/web-tool/test-api-toolTest API Tool connectivity and validate configuration.
get/v1/voice-agents/collections/listList Collections.
post/v1/voice-agents/collectionsCreate Collection.
delete/v1/voice-agents/collections/{id}Delete Collection.
patch/v1/voice-agents/collections/{id}Update Collection.
post/v1/voice-agents/collections/moveMove Web Tool to Collection.
get/v1/voice-agents/conversation/{conversationId}Get Conversation by ID.
get/v1/voice-agents/campaignsList campaigns with pagination
post/v1/voice-agents/campaignsCreate an outbound campaign
get/v1/voice-agents/campaigns/{id}Get a campaign by ID
delete/v1/voice-agents/campaigns/{id}Delete a campaign
patch/v1/voice-agents/campaigns/{id}Update a campaign's name
post/v1/voice-agents/campaigns/{id}/cancelCancel a campaign
post/v1/voice-agents/campaigns/{id}/retryRetry a campaign
post/v1/voice-agents/campaigns/{id}/pausePause a campaign
post/v1/voice-agents/campaigns/{id}/resumeResume a paused campaign
post/v1/voice-agents/voice-dictionariesCreate a Voice Dictionary
get/v1/voice-agents/voice-dictionaries/listList Voice Dictionaries
get/v1/voice-agents/voice-dictionaries/{id}Get Voice Dictionary by ID
delete/v1/voice-agents/voice-dictionaries/{id}Delete Voice Dictionary
patch/v1/voice-agents/voice-dictionaries/{id}Update Voice Dictionary
post/v1/voice-agents/voice-dictionaries/toggle-activationToggle Voice Dictionary Activation
get/v1/agent-analytics/overviewGet Overview Analytics
get/v1/agent-analytics/performanceGet Performance Analytics
get/v1/agent-analytics/satisfactionGet Satisfaction and Outcome Analytics
get/v1/agent-analytics/conversations/exportExport Conversations
get/v1/agent-analytics/logs/{id}Get Call Log by ID
get/v1/agent-analytics/logsList Call Logs
post/v1/projects/secretsCreate a Secret
get/v1/projects/secrets/listList Secrets
delete/v1/projects/secrets/{id}Delete a Secret
patch/v1/projects/secrets/{id}Update a Secret
post/v2/tts/voices/custom/preloadPreload a cloned TTS voice into the system
get/v2/jobsList Jobs
post/v2/jobsCreate Job
post/v2/jobs/generate-transcription-ai-contentGenerate AI Content
get/v2/tts/voicesList TTS voices
post/v2/tts/voicesCreate TTS voice
get/v2/tts/dialectsList dialects
post/v2/tts/voices/{id}/favouriteFavorite a TTS voice
get/v2/tts/voices/{id}Get TTS voice
delete/v2/tts/voices/{id}Delete TTS voice
post/v2/tts/voices/previewPreview TTS voice
get/v2/tts/voices/default/currentGet default TTS voice
post/v2/tts/voices/extract-transcriptionExtract transcription from voice audio
get/v2/tts/historiesList TTS histories
post/v2/tts/historiesCreate TTS history
get/v2/tts/histories/{id}Get TTS history
delete/v2/tts/histories/{id}Delete TTS history
delete/v2/jobs/{id}Delete Job
patch/v2/jobs/{id}Update Job Title
get/v2/jobs/view/{id}Get Single Job
get/v2/voice-agentsList Voice Agents
post/v2/voice-agentsCreate Voice Agent
get/v2/voice-agents/{voiceAgentId}Get Voice Agent
patch/v2/voice-agents/{voiceAgentId}Update Voice Agent
post/v2/voice-agents/web-toolCreate Web Tool
get/v2/voice-agents/web-tool/listList Web Tools

Changes to Delete Voice Dictionary

delete/v1/voice-agents/voice-dictionaries/{id}

Nov 3, 20267e6123597b29 Revision changes
- info
  endpoint added