/

Docs
History
Schema
Generate

Filter operations

access:all3

Agents Insights1

Agents Platform192

get/v1/convai/conversation/get-signed-urlGet Signed Url
get/v1/convai/conversation/get_signed_urlGet Signed Url
get/v1/convai/conversation/tokenGet Webrtc Token
post/v1/convai/twilio/outbound-callHandle An Outbound Call Via Twilio
post/v1/convai/twilio/register-callRegister A Twilio Call And Return Twiml
post/v1/convai/exotel/outbound-callHandle An Outbound Call Via Exotel
post/v1/convai/whatsapp/outbound-callMake An Outbound Call Via Whatsapp
post/v1/convai/whatsapp/outbound-messageSend An Outbound Message Via Whatsapp
post/v1/convai/agents/createCreate Agent
get/v1/convai/agents/summariesGet Agent Summaries
get/v1/convai/agents/{agent_id}Get Agent
delete/v1/convai/agents/{agent_id}Delete Agent
patch/v1/convai/agents/{agent_id}Patches An Agent Settings
get/v1/convai/agents/{agent_id}/widgetGet Agent Widget Config
get/v1/convai/agents/{agent_id}/linkGet Shareable Agent Link
post/v1/convai/agents/{agent_id}/avatarPost Agent Avatar
post/v1/convai/agents/{agent_id}/hold-audioPost Agent Hold Audio
delete/v1/convai/agents/{agent_id}/hold-audioDelete Agent Hold Audio
get/v1/convai/agentsList Agents
get/v1/convai/agent/{agent_id}/knowledge-base/sizeReturns The Size Of The Agent'S Knowledge Base
post/v1/convai/agent/{agent_id}/llm-usage/calculateCalculate Expected Llm Usage For An Agent
post/v1/convai/agents/{agent_id}/duplicateDuplicate Agent
post/v1/convai/agents/{agent_id}/simulate-conversationSimulates A Conversation
post/v1/convai/agents/{agent_id}/simulate-conversation/streamSimulates A Conversation (Stream)
post/v1/convai/agent-testing/foldersCreate Agent Test Folder
get/v1/convai/agent-testing/folders/{folder_id}Get Agent Test Folder By Id
delete/v1/convai/agent-testing/folders/{folder_id}Delete Agent Test Folder
patch/v1/convai/agent-testing/folders/{folder_id}Update Agent Test Folder
post/v1/convai/agent-testing/bulk-moveBulk Move Tests To Folder
get/v1/convai/conversationsGet Conversations
get/v1/convai/usersGet Conversation Users
get/v1/convai/conversations/resolveResolve Conversation Reference
get/v1/convai/conversations/{conversation_id}Get Conversation Details
delete/v1/convai/conversations/{conversation_id}Delete Conversation
get/v1/convai/conversations/{conversation_id}/summaryGet Conversation Summary
get/v1/convai/conversations/{conversation_id}/sip-messagesGet Sip Messages For A Conversation
get/v1/convai/conversations/{conversation_id}/audioGet Conversation Audio
get/v1/convai/conversations/{conversation_id}/files/{file_id}Get Conversation File
delete/v1/convai/conversations/{conversation_id}/files/{file_id}Delete File Upload
post/v1/convai/conversations/{conversation_id}/feedbackSend Conversation Feedback
get/v1/convai/conversations/messages/text-searchText Search Conversation Messages
get/v1/convai/conversations/messages/smart-searchSmart Search Conversation Messages
post/v1/convai/conversations/{conversation_id}/tagsAssign Conversation Tags
delete/v1/convai/conversations/{conversation_id}/tags/{tag_id}Unassign Conversation Tag
get/v1/convai/tagsList Conversation Tags
post/v1/convai/tagsCreate Conversation Tag
get/v1/convai/tags/{tag_id}Get Conversation Tag
delete/v1/convai/tags/{tag_id}Delete Conversation Tag
patch/v1/convai/tags/{tag_id}Update Conversation Tag
get/v1/convai/phone-numbersList Phone Numbers
post/v1/convai/phone-numbersImport Phone Number
get/v1/convai/phone-numbers/{phone_number_id}Get Phone Number
delete/v1/convai/phone-numbers/{phone_number_id}Delete Phone Number
patch/v1/convai/phone-numbers/{phone_number_id}Update Phone Number
get/v1/convai/v2/phone-numbersList Phone Numbers Page
get/v1/convai/phone-numbers/{phone_number_id}/sip-messagesGet Sip Messages For A Phone Number
post/v1/convai/llm-usage/calculateCalculate Expected Llm Usage
get/v1/convai/llm/listList Available Llms
post/v1/convai/conversations/{conversation_id}/filesUpload File
get/v1/convai/analytics/live-countGet Live Count
get/v1/convai/knowledge-base/summariesGet Knowledge Base Summaries By Ids
get/v1/convai/knowledge-baseGet Knowledge Base List
post/v1/convai/knowledge-baseAdd To Knowledge Base
post/v1/convai/knowledge-base/urlCreate Url Document
post/v1/convai/knowledge-base/fileCreate File Document
post/v1/convai/knowledge-base/textCreate Text Document
get/v1/convai/knowledge-base/{documentation_id}Get Documentation From Knowledge Base
delete/v1/convai/knowledge-base/{documentation_id}Delete Knowledge Base Document Or Folder
patch/v1/convai/knowledge-base/{documentation_id}Update Document
patch/v1/convai/knowledge-base/{documentation_id}/update-fileUpdate File Document
get/v1/convai/knowledge-base/rag-indexGet Rag Index Overview.
post/v1/convai/knowledge-base/rag-indexCompute Rag Indexes In Batch
post/v1/convai/knowledge-base/{documentation_id}/refreshRefresh Url Document Content
get/v1/convai/knowledge-base/{documentation_id}/rag-indexGet Rag Indexes Of The Specified Knowledgebase Document.
post/v1/convai/knowledge-base/{documentation_id}/rag-indexCompute Rag Index.
delete/v1/convai/knowledge-base/{documentation_id}/rag-index/{rag_index_id}Delete Rag Index.
get/v1/convai/knowledge-base/searchSearch Knowledge Base Content
post/v1/convai/agents/{agent_id}/knowledge-base/rag-queryQuery Agent Knowledge Base Rag
get/v1/convai/knowledge-base/{documentation_id}/dependent-agentsGet Dependent Agents List
post/v1/convai/knowledge-base/dependent-agentsGet Dependent Agents For Multiple Documents
get/v1/convai/knowledge-base/{documentation_id}/contentGet Document Content
get/v1/convai/knowledge-base/{documentation_id}/source-file-urlGet Document Source File Url
get/v1/convai/knowledge-base/{documentation_id}/chunk/{chunk_id}Get Documentation Chunk From Knowledge Base
get/v1/convai/knowledge-base/{documentation_id}/chunksGet All Rag Chunks For A Document
post/v1/convai/knowledge-base/bulk-deleteBulk Delete Knowledge Base Documents
get/v1/convai/toolsGet Tools
post/v1/convai/toolsAdd Tool
get/v1/convai/tools/{tool_id}Get Tool
delete/v1/convai/tools/{tool_id}Delete Tool
patch/v1/convai/tools/{tool_id}Update Tool
get/v1/convai/tools/{tool_id}/dependent-agentsGet Dependent Agents List
get/v1/convai/tools/{tool_id}/executionsGet Tool Executions
get/v1/convai/analysis-itemsList Analysis Items
post/v1/convai/analysis-itemsCreate Analysis Item
patch/v1/convai/analysis-items/{analysis_item_id}/attachmentsUpdate Analysis Item Attachments
get/v1/convai/analysis-items/{analysis_item_id}Get Analysis Item
delete/v1/convai/analysis-items/{analysis_item_id}Delete Analysis Item
patch/v1/convai/analysis-items/{analysis_item_id}Update Analysis Item
get/v1/convai/analysis-items/{analysis_item_id}/versionsList Analysis Item Versions
post/v1/convai/analysis-items/{analysis_item_id}/copyCopy Analysis Item
get/v1/convai/analysis-items/{analysis_item_id}/dependent-agentsGet Analysis Item Dependent Agents
get/v1/convai/settingsGet Convai Settings
patch/v1/convai/settingsUpdate Convai Settings
get/v1/convai/settings/dashboardGet Convai Dashboard Settings
patch/v1/convai/settings/dashboardUpdate Convai Dashboard Settings
get/v1/convai/secretsGet Convai Workspace Secrets
post/v1/convai/secretsCreate Convai Workspace Secret
get/v1/convai/secrets/{secret_id}Get Convai Workspace Secret
delete/v1/convai/secrets/{secret_id}Delete Convai Workspace Secret
patch/v1/convai/secrets/{secret_id}Update Convai Workspace Secret
get/v1/convai/secrets/{secret_id}/dependencies/{resource_type}Get Secret Dependencies By Type
post/v1/convai/batch-calling/submitSubmit A Batch Call Request.
get/v1/convai/batch-calling/workspaceGet All Batch Calls For A Workspace.
get/v1/convai/batch-calling/{batch_id}Get A Batch Call By Id.
delete/v1/convai/batch-calling/{batch_id}Delete A Batch Call.
post/v1/convai/batch-calling/{batch_id}/cancelCancel A Batch Call.
post/v1/convai/batch-calling/{batch_id}/retryRetry A Batch Call.
get/v1/convai/batch-calling/{batch_id}/exportExport Batch Call Results
post/v1/convai/sip-trunk/outbound-callHandle An Outbound Call Via Sip Trunk
get/v1/convai/mcp-serversList Mcp Servers
post/v1/convai/mcp-serversCreate Mcp Server
get/v1/convai/mcp-servers/{mcp_server_id}Get Mcp Server
delete/v1/convai/mcp-servers/{mcp_server_id}Delete Mcp Server
patch/v1/convai/mcp-servers/{mcp_server_id}Update Mcp Server Configuration
get/v1/convai/mcp-servers/{mcp_server_id}/toolsList Mcp Server Tools
patch/v1/convai/mcp-servers/{mcp_server_id}/approval-policyUpdate Mcp Server Approval Policy
post/v1/convai/mcp-servers/{mcp_server_id}/tool-approvalsCreate Mcp Server Tool Approval
delete/v1/convai/mcp-servers/{mcp_server_id}/tool-approvals/{tool_name}Delete Mcp Server Tool Approval
post/v1/convai/mcp-servers/{mcp_server_id}/tool-configsCreate Mcp Tool Configuration Override
get/v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}Get Mcp Tool Configuration Override
delete/v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}Delete Mcp Tool Configuration Override
patch/v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}Update Mcp Tool Configuration Override
get/v1/convai/whatsapp-accounts/{phone_number_id}Get Whatsapp Account
delete/v1/convai/whatsapp-accounts/{phone_number_id}Delete Whatsapp Account
patch/v1/convai/whatsapp-accounts/{phone_number_id}Update Whatsapp Account
get/v1/convai/whatsapp-accountsList Whatsapp Accounts
get/v1/convai/agents/{agent_id}/branchesList Agent Branches
post/v1/convai/agents/{agent_id}/branchesCreate A New Branch
get/v1/convai/agents/{agent_id}/branches/{branch_id}Get Agent Branch
patch/v1/convai/agents/{agent_id}/branches/{branch_id}Update Agent Branch
get/v1/convai/agents/{agent_id}/versions/{version_id}Get Agent Version Metadata
get/v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge-previewPreview Merged Configuration
post/v1/convai/agents/{agent_id}/branches/{source_branch_id}/mergeMerge A Branch Into A Target Branch
get/v1/convai/agents/{agent_id}/branches/{branch_id}/rebase-previewPreview Rebased Configuration
post/v1/convai/agents/{agent_id}/branches/{branch_id}/rebaseRebase A Branch Onto Main
get/v1/convai/agents/{agent_id}/deploymentsList Agent Deployments
post/v1/convai/agents/{agent_id}/deploymentsCreate Or Update Deployments
post/v1/convai/agents/{agent_id}/draftsCreate Agent Draft
delete/v1/convai/agents/{agent_id}/draftsDelete Agent Draft
get/v1/convai/agents/{agent_id}/merge-proposalsList Proposals
post/v1/convai/agents/{agent_id}/merge-proposalsCreate A Merge Proposal
get/v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}Get A Merge Proposal
patch/v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}Update A Merge Proposal
post/v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/reviewsReview A Merge Proposal
post/v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/commentsComment On A Merge Proposal
post/v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/mergeMerge A Merge Proposal
get/v1/convai/outbound-campaigns/configGet Outbound Campaign Configuration
put/v1/convai/outbound-campaigns/configReplace Outbound Campaign Configuration
get/v1/convai/outbound-campaigns/campaignsList Outbound Campaigns
post/v1/convai/outbound-campaigns/campaigns/pause-allPause All Outbound Campaigns
post/v1/convai/outbound-campaigns/campaigns/stop-allStop All Outbound Campaigns
post/v1/convai/outbound-campaigns/campaigns/submitCreate An Outbound Campaign
get/v1/convai/outbound-campaigns/campaigns/{campaign_id}Get An Outbound Campaign
get/v1/convai/outbound-campaigns/campaigns/{campaign_id}/progressGet Outbound Campaign Progress
get/v1/convai/outbound-campaigns/campaigns/{campaign_id}/leadsList Outbound Campaign Leads
get/v1/convai/outbound-campaigns/campaigns/{campaign_id}/callsList Outbound Campaign Calls
get/v1/convai/outbound-campaigns/campaigns/{campaign_id}/follow-up-requestsGet Outbound Campaign Follow-Up Requests
get/v1/convai/outbound-campaigns/campaigns/{campaign_id}/exportExport Outbound Campaign Calls
get/v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads/{lead_id}Get An Outbound Campaign Lead
delete/v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads/{lead_id}Remove An Outbound Campaign Lead
post/v1/convai/outbound-campaigns/campaigns/{campaign_id}/pausePause An Outbound Campaign
post/v1/convai/outbound-campaigns/campaigns/{campaign_id}/resumeResume An Outbound Campaign
post/v1/convai/outbound-campaigns/campaigns/{campaign_id}/stopStop An Outbound Campaign
get/v1/convai/outbound-campaigns/attentionList Outbound Campaign Attention Items
post/v1/convai/outbound-campaigns/attention/{attention_id}/retryRetry An Outbound Campaign Attention Item
post/v1/convai/outbound-campaigns/attention/{attention_id}/resolveResolve An Outbound Campaign Attention Item
get/v1/convai/agents/{agent_id}/branches/{branch_id}/proceduresList Procedures
post/v1/convai/agents/{agent_id}/branches/{branch_id}/proceduresCreate Procedure
post/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/compileLegacy: Compile Procedures
get/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}Get Procedure
delete/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}Remove Procedure
get/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draftGet Procedure Draft
delete/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draftDelete Procedure Draft
patch/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draftUpdate Procedure Draft
get/v1/convai/environment-variablesList Environment Variables
post/v1/convai/environment-variablesCreate Environment Variable
get/v1/convai/environment-variables/{env_var_id}Get Environment Variable
delete/v1/convai/environment-variables/{env_var_id}Delete Environment Variable
patch/v1/convai/environment-variables/{env_var_id}Update Environment Variable
get/v1/convai/environmentsList Environments
post/v1/convai/environmentsCreate Environment
delete/v1/convai/environments/{environment}Delete Environment

Agents Workspace Analytics2

Assets4

audio-effects1

audio-isolation4

audio-native4

content-provenance1

Conversational AI7

dubbing20

Dubbing17

Flows14

forced-alignment1

models1

music-finetunes5

music-generation7

productions11

Pronunciation Dictionary9

pvc-voices14

Realtime8

samples2

Single Use Token1

smb75

sound-generation1

Speech Engine6

speech-history5

speech-to-text3

studio23

text-to-dialogue4

text-to-speech4

text-to-voice5

video-to-music1

voice-changer2

voices21

workspace31

get/v1/userGet User Info
get/v1/user/subscriptionGet User Subscription Info
get/v1/usage/character-statsGet Characters Usage Metrics (Deprecated)
post/v1/convai/agent-testing/createCreate Agent Response Test
get/v1/convai/agent-testing/{test_id}Get Agent Response Test By Id
put/v1/convai/agent-testing/{test_id}Update Agent Response Test
delete/v1/convai/agent-testing/{test_id}Delete Agent Response Test
post/v1/convai/agent-testing/summariesGet Agent Response Test Summaries By Ids
get/v1/convai/agent-testingList Agent Response Tests
get/v1/convai/test-invocationsList Test Invocations
post/v1/convai/agents/{agent_id}/run-testsRun Tests On The Agent
get/v1/convai/test-invocations/{test_invocation_id}Get Test Invocation
patch/v1/convai/test-invocations/{test_invocation_id}Update Test Invocation
post/v1/convai/test-invocations/{test_invocation_id}/cancelCancel Test Invocation
post/v1/convai/test-invocations/{test_invocation_id}/resubmitResubmit Tests
get/v1/convai/agents/{agent_id}/triage-ticketsList Agent Conversation Tickets
post/v1/convai/agents/{agent_id}/triage-ticketsCreate Manual Agent Ticket
get/v1/convai/triage-ticketsList Workspace Conversation Tickets
post/v1/convai/triage-ticketsCreate Agent Conversation Ticket
get/v1/convai/agents/{agent_id}/triage-tickets/assignable-usersGet Agent Conversation Ticket Assignable Users
get/v1/convai/triage-tickets/{agentqa_ticket_id}Get Agent Conversation Ticket
delete/v1/convai/triage-tickets/{agentqa_ticket_id}Delete Agent Conversation Ticket
patch/v1/convai/triage-tickets/{agentqa_ticket_id}Update Agent Conversation Ticket
post/v1/convai/triage-tickets/{agentqa_ticket_id}/commentsAdd Comment To Agent Conversation Ticket
post/v1/convai/triage-tickets/{agentqa_ticket_id}/mergeMerge Agent Conversation Tickets
post/v1/convai/triage-tickets/{agentqa_ticket_id}/turn-commentsAdd Turn Comment To Agent Conversation Ticket
get/docsRedirect To Mintlify

Agents Platform

Changes to Stop All Outbound Campaigns

post/v1/convai/outbound-campaigns/campaigns/stop-all

Nov 10, 202649e0431bea4c Revision changes
- info
  endpoint added