Search skmtc
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
access:all
2
Agents Insights
1
Agents Platform
162
get
/v1/convai/conversation/get-signed-url
Get Signed Url
get
/v1/convai/conversation/get_signed_url
Get Signed Url
get
/v1/convai/conversation/token
Get Webrtc Token
post
/v1/convai/twilio/outbound-call
Handle An Outbound Call Via Twilio
post
/v1/convai/twilio/register-call
Register A Twilio Call And Return Twiml
post
/v1/convai/exotel/outbound-call
Handle An Outbound Call Via Exotel
post
/v1/convai/whatsapp/outbound-call
Make An Outbound Call Via Whatsapp
post
/v1/convai/whatsapp/outbound-message
Send An Outbound Message Via Whatsapp
post
/v1/convai/agents/create
Create Agent
get
/v1/convai/agents/summaries
Get 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}/widget
Get Agent Widget Config
get
/v1/convai/agents/{agent_id}/link
Get Shareable Agent Link
post
/v1/convai/agents/{agent_id}/avatar
Post Agent Avatar
post
/v1/convai/agents/{agent_id}/hold-audio
Post Agent Hold Audio
delete
/v1/convai/agents/{agent_id}/hold-audio
Delete Agent Hold Audio
get
/v1/convai/agents
List Agents
get
/v1/convai/agent/{agent_id}/knowledge-base/size
Returns The Size Of The Agent'S Knowledge Base
post
/v1/convai/agent/{agent_id}/llm-usage/calculate
Calculate Expected Llm Usage For An Agent
post
/v1/convai/agents/{agent_id}/duplicate
Duplicate Agent
post
/v1/convai/agents/{agent_id}/simulate-conversation
Simulates A Conversation
post
/v1/convai/agents/{agent_id}/simulate-conversation/stream
Simulates A Conversation (Stream)
post
/v1/convai/agent-testing/folders
Create 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-move
Bulk Move Tests To Folder
get
/v1/convai/conversations
Get Conversations
get
/v1/convai/users
Get Conversation Users
get
/v1/convai/conversations/resolve
Resolve 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}/summary
Get Conversation Summary
get
/v1/convai/conversations/{conversation_id}/sip-messages
Get Sip Messages For A Conversation
get
/v1/convai/conversations/{conversation_id}/audio
Get Conversation Audio
post
/v1/convai/conversations/{conversation_id}/feedback
Send Conversation Feedback
get
/v1/convai/conversations/messages/text-search
Text Search Conversation Messages
get
/v1/convai/conversations/messages/smart-search
Smart Search Conversation Messages
post
/v1/convai/conversations/{conversation_id}/tags
Assign Conversation Tags
delete
/v1/convai/conversations/{conversation_id}/tags/{tag_id}
Unassign Conversation Tag
get
/v1/convai/tags
List Conversation Tags
post
/v1/convai/tags
Create 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-numbers
List Phone Numbers
post
/v1/convai/phone-numbers
Import 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-numbers
List Phone Numbers Page
get
/v1/convai/phone-numbers/{phone_number_id}/sip-messages
Get Sip Messages For A Phone Number
post
/v1/convai/llm-usage/calculate
Calculate Expected Llm Usage
get
/v1/convai/llm/list
List Available Llms
post
/v1/convai/conversations/{conversation_id}/files
Upload File
delete
/v1/convai/conversations/{conversation_id}/files/{file_id}
Delete File Upload
get
/v1/convai/analytics/live-count
Get Live Count
get
/v1/convai/knowledge-base/summaries
Get Knowledge Base Summaries By Ids
get
/v1/convai/knowledge-base
Get Knowledge Base List
post
/v1/convai/knowledge-base
Add To Knowledge Base
post
/v1/convai/knowledge-base/url
Create Url Document
post
/v1/convai/knowledge-base/file
Create File Document
post
/v1/convai/knowledge-base/text
Create 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-file
Update File Document
get
/v1/convai/knowledge-base/rag-index
Get Rag Index Overview.
post
/v1/convai/knowledge-base/rag-index
Compute Rag Indexes In Batch
post
/v1/convai/knowledge-base/{documentation_id}/refresh
Refresh Url Document Content
get
/v1/convai/knowledge-base/{documentation_id}/rag-index
Get Rag Indexes Of The Specified Knowledgebase Document.
post
/v1/convai/knowledge-base/{documentation_id}/rag-index
Compute Rag Index.
delete
/v1/convai/knowledge-base/{documentation_id}/rag-index/{rag_index_id}
Delete Rag Index.
get
/v1/convai/knowledge-base/search
Search Knowledge Base Content
post
/v1/convai/agents/{agent_id}/knowledge-base/rag-query
Query Agent Knowledge Base Rag
get
/v1/convai/knowledge-base/{documentation_id}/dependent-agents
Get Dependent Agents List
post
/v1/convai/knowledge-base/dependent-agents
Get Dependent Agents For Multiple Documents
get
/v1/convai/knowledge-base/{documentation_id}/content
Get Document Content
get
/v1/convai/knowledge-base/{documentation_id}/source-file-url
Get 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}/chunks
Get All Rag Chunks For A Document
post
/v1/convai/knowledge-base/bulk-delete
Bulk Delete Knowledge Base Documents
get
/v1/convai/tools
Get Tools
post
/v1/convai/tools
Add 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-agents
Get Dependent Agents List
get
/v1/convai/tools/{tool_id}/executions
Get Tool Executions
get
/v1/convai/settings
Get Convai Settings
patch
/v1/convai/settings
Update Convai Settings
get
/v1/convai/settings/dashboard
Get Convai Dashboard Settings
patch
/v1/convai/settings/dashboard
Update Convai Dashboard Settings
get
/v1/convai/secrets
Get Convai Workspace Secrets
post
/v1/convai/secrets
Create 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/submit
Submit A Batch Call Request.
get
/v1/convai/batch-calling/workspace
Get 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}/cancel
Cancel A Batch Call.
post
/v1/convai/batch-calling/{batch_id}/retry
Retry A Batch Call.
get
/v1/convai/batch-calling/{batch_id}/export
Export Batch Call Results
post
/v1/convai/sip-trunk/outbound-call
Handle An Outbound Call Via Sip Trunk
get
/v1/convai/mcp-servers
List Mcp Servers
post
/v1/convai/mcp-servers
Create 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}/tools
List Mcp Server Tools
patch
/v1/convai/mcp-servers/{mcp_server_id}/approval-policy
Update Mcp Server Approval Policy
post
/v1/convai/mcp-servers/{mcp_server_id}/tool-approvals
Create 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-configs
Create 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-accounts
List Whatsapp Accounts
get
/v1/convai/agents/{agent_id}/branches
List Agent Branches
post
/v1/convai/agents/{agent_id}/branches
Create 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-preview
Preview Merged Configuration
post
/v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge
Merge A Branch Into A Target Branch
get
/v1/convai/agents/{agent_id}/branches/{branch_id}/rebase-preview
Preview Rebased Configuration
post
/v1/convai/agents/{agent_id}/branches/{branch_id}/rebase
Rebase A Branch Onto Main
get
/v1/convai/agents/{agent_id}/deployments
List Agent Deployments
post
/v1/convai/agents/{agent_id}/deployments
Create Or Update Deployments
post
/v1/convai/agents/{agent_id}/drafts
Create Agent Draft
delete
/v1/convai/agents/{agent_id}/drafts
Delete Agent Draft
get
/v1/convai/agents/{agent_id}/merge-proposals
List Proposals
post
/v1/convai/agents/{agent_id}/merge-proposals
Create 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}/reviews
Review A Merge Proposal
post
/v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/comments
Comment On A Merge Proposal
post
/v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}/merge
Merge A Merge Proposal
get
/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures
List Procedures
post
/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures
Create Procedure
post
/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/compile
Legacy: 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}/draft
Get Procedure Draft
delete
/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft
Delete Procedure Draft
patch
/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft
Update Procedure Draft
get
/v1/convai/environment-variables
List Environment Variables
post
/v1/convai/environment-variables
Create 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/environments
List Environments
post
/v1/convai/environments
Create Environment
delete
/v1/convai/environments/{environment}
Delete Environment
Agents Workspace Analytics
2
Assets
4
audio-effects
1
audio-isolation
4
audio-native
4
Conversational AI
7
dubbing
20
Dubbing
17
Flows
14
forced-alignment
1
models
1
music-finetunes
5
music-generation
7
productions
11
Pronunciation Dictionary
9
pvc-voices
14
Realtime
1
samples
2
Single Use Token
1
smb
36
sound-generation
1
Speech Engine
6
speech-history
5
speech-to-text
3
studio
23
text-to-dialogue
4
text-to-speech
4
text-to-voice
5
video-to-music
1
voice-changer
2
voices
21
workspace
30
get
/v1/user
Get User Info
get
/v1/user/subscription
Get User Subscription Info
get
/v1/usage/character-stats
Get Characters Usage Metrics (Deprecated)
post
/v1/convai/agent-testing/create
Create 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/summaries
Get Agent Response Test Summaries By Ids
get
/v1/convai/agent-testing
List Agent Response Tests
get
/v1/convai/test-invocations
List Test Invocations
post
/v1/convai/agents/{agent_id}/run-tests
Run 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}/cancel
Cancel Test Invocation
post
/v1/convai/test-invocations/{test_invocation_id}/resubmit
Resubmit Tests
get
/v1/convai/agents/{agent_id}/triage-tickets
List Agent Conversation Tickets
post
/v1/convai/agents/{agent_id}/triage-tickets
Create Manual Agent Ticket
get
/v1/convai/triage-tickets
List Workspace Conversation Tickets
post
/v1/convai/triage-tickets
Create Agent Conversation Ticket
get
/v1/convai/agents/{agent_id}/triage-tickets/assignable-users
Get 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}/comments
Add Comment To Agent Conversation Ticket
post
/v1/convai/triage-tickets/{agentqa_ticket_id}/merge
Merge Agent Conversation Tickets
post
/v1/convai/triage-tickets/{agentqa_ticket_id}/turn-comments
Add Turn Comment To Agent Conversation Ticket
get
/docs
Redirect To Mintlify
Agents Platform
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Delete Tool
delete
/v1/convai/tools/{tool_id}
Apr 3, 2026
deb5e58ddddf
Revision changes
info
added the new optional
query
request parameter
force
Feb 8, 2026
5b595807512c
Revision changes
info
endpoint added