How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ElevenLabs

ElevenLabs Agents Platform API

Build, configure and manage Conversational AI agents, knowledge bases, tools, and conversations.

Documentation Provider Profile APIs.io OpenAPI GitHub

ElevenLabs Agents Platform API is one of 50 APIs that ElevenLabs publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Agents Platform. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, rate-limit docs, and an AsyncAPI specification.

This API exposes 150 operations across 108 paths, and defines 843 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against the base URL https://api.elevenlabs.io.

150 operations 108 paths 843 schemas 20 DELETE66 GET17 PATCH47 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.elevenlabs.io
Resource Areas
1

Paths & Operations 150

Across 108 paths, the API surfaces 150 operations — 20 DELETE, 66 GET, 17 PATCH, 47 POST. Each is listed below with its method, path, parameters, and response codes.

Agents Platform 150

Build, configure and manage Conversational AI agents, knowledge bases, tools, and conversations.

GET
/v1/convai/conversation/get-signed-url
Get Signed Url
get_conversation_signed_link 7 params → 200422
GET
/v1/convai/conversation/get_signed_urldeprecated
Get Signed Url
get_signed_url_deprecated 7 params → 200422
GET
/v1/convai/conversation/token
Get Webrtc Token
get_livekit_token 7 params → 200422
POST
/v1/convai/twilio/outbound-call
Handle An Outbound Call Via Twilio
handle_twilio_outbound_call 1 param body → 200422
POST
/v1/convai/twilio/register-call
Register A Twilio Call And Return Twiml
register_twilio_call 1 param body → 200422
POST
/v1/convai/exotel/outbound-call
Handle An Outbound Call Via Exotel
handle_exotel_outbound_call 1 param body → 200422
POST
/v1/convai/whatsapp/outbound-call
Make An Outbound Call Via Whatsapp
whatsapp_outbound_call 1 param body → 200422
POST
/v1/convai/whatsapp/outbound-message
Send An Outbound Message Via Whatsapp
whatsapp_outbound_message 1 param body → 200422
POST
/v1/convai/agents/create
Create Agent
create_agent_route 2 params body → 200422
GET
/v1/convai/agents/summaries
Get Agent Summaries
get_agent_summaries_route 2 params → 200422
GET
/v1/convai/agents/{agent_id}
Get Agent
get_agent_route 4 params → 200422
PATCH
/v1/convai/agents/{agent_id}
Patches An Agent Settings
patch_agent_settings_route 4 params body → 200422
DELETE
/v1/convai/agents/{agent_id}
Delete Agent
delete_agent_route 2 params → 200204422
GET
/v1/convai/agents/{agent_id}/widget
Get Agent Widget Config
get_agent_widget_route 3 params → 200422
GET
/v1/convai/agents/{agent_id}/link
Get Shareable Agent Link
get_agent_link_route 2 params → 200422
POST
/v1/convai/agents/{agent_id}/avatar
Post Agent Avatar
post_agent_avatar_route 2 params body → 200422
POST
/v1/convai/agents/{agent_id}/hold-audio
Post Agent Hold Audio
post_agent_hold_audio_route 2 params body → 200422
DELETE
/v1/convai/agents/{agent_id}/hold-audio
Delete Agent Hold Audio
delete_agent_hold_audio_route 2 params → 200422
GET
/v1/convai/agents
List Agents
get_agents_route 10 params → 200422
GET
/v1/convai/agent/{agent_id}/knowledge-base/size
Returns The Size Of The Agent'S Knowledge Base
get_agent_knowledge_base_size 2 params → 200422
POST
/v1/convai/agent/{agent_id}/llm-usage/calculate
Calculate Expected Llm Usage For An Agent
get_agent_llm_expected_cost_calculation 2 params body → 200422
POST
/v1/convai/agents/{agent_id}/duplicate
Duplicate Agent
duplicate_agent_route 2 params body → 200422
POST
/v1/convai/agents/{agent_id}/simulate-conversationdeprecated
Simulates A Conversation
run_conversation_simulation_route 2 params body → 200422
POST
/v1/convai/agents/{agent_id}/simulate-conversation/streamdeprecated
Simulates A Conversation (Stream)
run_conversation_simulation_route_stream 2 params body → 200422
POST
/v1/convai/agent-testing/folders
Create Agent Test Folder
create_agent_test_folder_route 1 param body → 200422
GET
/v1/convai/agent-testing/folders/{folder_id}
Get Agent Test Folder By Id
get_agent_test_folder_route 2 params → 200422
PATCH
/v1/convai/agent-testing/folders/{folder_id}
Update Agent Test Folder
update_agent_test_folder_route 2 params body → 200422
DELETE
/v1/convai/agent-testing/folders/{folder_id}
Delete Agent Test Folder
delete_agent_test_folder_route 3 params → 204422
POST
/v1/convai/agent-testing/bulk-move
Bulk Move Tests To Folder
agent_testing_bulk_move_route 1 param body → 200422
GET
/v1/convai/conversations
Get Conversations
get_conversation_histories_route 42 params → 200422
GET
/v1/convai/users
Get Conversation Users
get_conversation_users_route 10 params → 200422
GET
/v1/convai/conversations/resolve
Resolve Conversation Reference
resolve_conversation_reference_route 3 params → 200422
GET
/v1/convai/conversations/{conversation_id}
Get Conversation Details
get_conversation_history_route 3 params → 200422
DELETE
/v1/convai/conversations/{conversation_id}
Delete Conversation
delete_conversation_route 2 params → 200422
GET
/v1/convai/conversations/{conversation_id}/summary
Get Conversation Summary
get_conversation_summary_route 3 params → 200422
GET
/v1/convai/conversations/{conversation_id}/sip-messages
Get Sip Messages For A Conversation
get_conversation_sip_messages 4 params → 200422
GET
/v1/convai/conversations/{conversation_id}/audio
Get Conversation Audio
get_conversation_audio_route 2 params → 200422
POST
/v1/convai/conversations/{conversation_id}/feedback
Send Conversation Feedback
post_conversation_feedback_route 1 param body → 200422
GET
/v1/convai/conversations/messages/text-search
Text Search Conversation Messages
text_search_conversation_messages_route 35 params → 200422
GET
/v1/convai/conversations/messages/smart-search
Smart Search Conversation Messages
smart_search_conversation_messages_route 5 params → 200422
POST
/v1/convai/conversations/{conversation_id}/tags
Assign Conversation Tags
assign_conversation_tags_route 2 params body → 204422
DELETE
/v1/convai/conversations/{conversation_id}/tags/{tag_id}
Unassign Conversation Tag
unassign_conversation_tag_route 3 params → 204422
GET
/v1/convai/tags
List Conversation Tags
list_conversation_tags_route 3 params → 200422
POST
/v1/convai/tags
Create Conversation Tag
create_conversation_tag_route 1 param body → 200422
GET
/v1/convai/tags/{tag_id}
Get Conversation Tag
get_conversation_tag_route 2 params → 200422
PATCH
/v1/convai/tags/{tag_id}
Update Conversation Tag
update_conversation_tag_route 2 params body → 200422
DELETE
/v1/convai/tags/{tag_id}
Delete Conversation Tag
delete_conversation_tag_route 2 params → 204422
POST
/v1/convai/phone-numbers
Import Phone Number
create_phone_number_route 1 param body → 200422
GET
/v1/convai/phone-numbers
List Phone Numbers
list_phone_numbers_route 4 params → 200422
GET
/v1/convai/phone-numbers/{phone_number_id}
Get Phone Number
get_phone_number_route 2 params → 200422
DELETE
/v1/convai/phone-numbers/{phone_number_id}
Delete Phone Number
delete_phone_number_route 2 params → 200422
PATCH
/v1/convai/phone-numbers/{phone_number_id}
Update Phone Number
update_phone_number_route 2 params body → 200422
GET
/v1/convai/phone-numbers/{phone_number_id}/sip-messages
Get Sip Messages For A Phone Number
list_sip_messages 4 params → 200422
POST
/v1/convai/llm-usage/calculate
Calculate Expected Llm Usage
get_public_llm_expected_cost_calculation body → 200422
GET
/v1/convai/llm/list
List Available Llms
list_available_llms 1 param → 200422
POST
/v1/convai/conversations/{conversation_id}/files
Upload File
upload_file_route 2 params body → 200422
DELETE
/v1/convai/conversations/{conversation_id}/files/{file_id}
Delete File Upload
cancel_file_upload_route 3 params → 200422
GET
/v1/convai/analytics/live-count
Get Live Count
get_live_count 3 params → 200422
GET
/v1/convai/knowledge-base/summaries
Get Knowledge Base Summaries By Ids
get_agent_knowledge_base_summaries_route 2 params → 200422
POST
/v1/convai/knowledge-basedeprecated
Add To Knowledge Base
add_documentation_to_knowledge_base 2 params body → 200422
GET
/v1/convai/knowledge-base
Get Knowledge Base List
get_knowledge_base_list_route 12 params → 200422
POST
/v1/convai/knowledge-base/url
Create Url Document
create_url_document_route 1 param body → 200422
POST
/v1/convai/knowledge-base/file
Create File Document
create_file_document_route 1 param body → 200422
POST
/v1/convai/knowledge-base/text
Create Text Document
create_text_document_route 1 param body → 200422
PATCH
/v1/convai/knowledge-base/{documentation_id}
Update Document
update_document_route 2 params body → 200422
GET
/v1/convai/knowledge-base/{documentation_id}
Get Documentation From Knowledge Base
get_documentation_from_knowledge_base 3 params → 200422
DELETE
/v1/convai/knowledge-base/{documentation_id}
Delete Knowledge Base Document Or Folder
delete_knowledge_base_document 3 params → 200422
PATCH
/v1/convai/knowledge-base/{documentation_id}/update-file
Update File Document
update_file_document_route 2 params body → 200422
POST
/v1/convai/knowledge-base/rag-index
Compute Rag Indexes In Batch
get_or_create_rag_indexes 1 param body → 200422
GET
/v1/convai/knowledge-base/rag-index
Get Rag Index Overview
get_rag_index_overview 1 param → 200422
POST
/v1/convai/knowledge-base/{documentation_id}/refresh
Refresh Url Document Content
refresh_url_document_route 2 params → 200422
POST
/v1/convai/knowledge-base/{documentation_id}/rag-index
Compute Rag Index
rag_index_status 2 params body → 200422
GET
/v1/convai/knowledge-base/{documentation_id}/rag-index
Get Rag Indexes Of The Specified Knowledgebase Document
get_rag_indexes 2 params → 200422
DELETE
/v1/convai/knowledge-base/{documentation_id}/rag-index/{rag_index_id}
Delete Rag Index
delete_rag_index 3 params → 200422
GET
/v1/convai/knowledge-base/search
Search Knowledge Base Content
search_knowledge_base_content_route 5 params → 200422
POST
/v1/convai/agents/{agent_id}/knowledge-base/rag-query
Query Agent Knowledge Base Rag
query_agent_knowledge_base_rag_route 3 params body → 200422
GET
/v1/convai/knowledge-base/{documentation_id}/dependent-agents
Get Dependent Agents List
get_knowledge_base_dependent_agents 5 params → 200422
POST
/v1/convai/knowledge-base/dependent-agents
Get Dependent Agents For Multiple Documents
get_knowledge_base_bulk_dependent_agents_route 4 params body → 200422
GET
/v1/convai/knowledge-base/{documentation_id}/content
Get Document Content
get_knowledge_base_content 2 params → 200422
GET
/v1/convai/knowledge-base/{documentation_id}/source-file-url
Get Document Source File Url
get_knowledge_base_source_file_url 2 params → 200422
GET
/v1/convai/knowledge-base/{documentation_id}/chunk/{chunk_id}
Get Documentation Chunk From Knowledge Base
get_documentation_chunk_from_knowledge_base 4 params → 200422
GET
/v1/convai/knowledge-base/{documentation_id}/chunks
Get All Rag Chunks For A Document
get_documentation_chunks_from_knowledge_base 5 params → 200422
POST
/v1/convai/knowledge-base/bulk-delete
Bulk Delete Knowledge Base Documents
post_knowledge_base_bulk_delete_route 1 param body → 200422
GET
/v1/convai/agents/{agent_id}/topics
Get Agent Conversation Topics
get_agent_topics_route 9 params → 200422
POST
/v1/convai/tools
Add Tool
add_tool_route 1 param body → 200422
GET
/v1/convai/tools
Get Tools
get_tools_route 9 params → 200422
GET
/v1/convai/tools/{tool_id}
Get Tool
get_tool_route 3 params → 200422
PATCH
/v1/convai/tools/{tool_id}
Update Tool
update_tool_route 2 params body → 200422
DELETE
/v1/convai/tools/{tool_id}
Delete Tool
delete_tool_route 3 params → 200422
GET
/v1/convai/tools/{tool_id}/dependent-agents
Get Dependent Agents List
get_tool_dependent_agents_route 4 params → 200422
GET
/v1/convai/tools/{tool_id}/executions
Get Tool Executions
get_tool_executions_route 9 params → 200422
GET
/v1/convai/settings
Get Convai Settings
get_settings_route 1 param → 200422
PATCH
/v1/convai/settings
Update Convai Settings
update_settings_route 1 param body → 200422
GET
/v1/convai/settings/dashboard
Get Convai Dashboard Settings
get_dashboard_settings_route 1 param → 200422
PATCH
/v1/convai/settings/dashboard
Update Convai Dashboard Settings
update_dashboard_settings_route 1 param body → 200422
POST
/v1/convai/secrets
Create Convai Workspace Secret
create_secret_route 1 param body → 200422
GET
/v1/convai/secrets
Get Convai Workspace Secrets
get_secrets_route 5 params → 200422
GET
/v1/convai/secrets/{secret_id}
Get Convai Workspace Secret
get_secret_route 2 params → 200422
DELETE
/v1/convai/secrets/{secret_id}
Delete Convai Workspace Secret
delete_secret_route 2 params → 204422
PATCH
/v1/convai/secrets/{secret_id}
Update Convai Workspace Secret
update_secret_route 2 params body → 200422
GET
/v1/convai/secrets/{secret_id}/dependencies/{resource_type}
Get Secret Dependencies By Type
get_secret_dependencies_route 5 params → 200422
POST
/v1/convai/batch-calling/submit
Submit A Batch Call Request
create_batch_call 1 param body → 200422
GET
/v1/convai/batch-calling/workspace
Get All Batch Calls For A Workspace
get_workspace_batch_calls 4 params → 200422
GET
/v1/convai/batch-calling/{batch_id}
Get A Batch Call By Id
get_batch_call 2 params → 200422
DELETE
/v1/convai/batch-calling/{batch_id}
Delete A Batch Call
delete_batch_call 2 params → 204422
POST
/v1/convai/batch-calling/{batch_id}/cancel
Cancel A Batch Call
cancel_batch_call 2 params → 200422
POST
/v1/convai/batch-calling/{batch_id}/retry
Retry A Batch Call
retry_batch_call 2 params → 200422
GET
/v1/convai/batch-calling/{batch_id}/export
Export Batch Call Results
export_batch_call 2 params → 200422
POST
/v1/convai/sip-trunk/outbound-call
Handle An Outbound Call Via Sip Trunk
handle_sip_trunk_outbound_call 1 param body → 200422
POST
/v1/convai/mcp-servers
Create Mcp Server
create_mcp_server_route 1 param body → 200422
GET
/v1/convai/mcp-servers
List Mcp Servers
list_mcp_servers_route 1 param → 200422
GET
/v1/convai/mcp-servers/{mcp_server_id}
Get Mcp Server
get_mcp_route 2 params → 200422
DELETE
/v1/convai/mcp-servers/{mcp_server_id}
Delete Mcp Server
delete_mcp_server_route 2 params → 200422
PATCH
/v1/convai/mcp-servers/{mcp_server_id}
Update Mcp Server Configuration
update_mcp_server_config_route 2 params body → 200422
GET
/v1/convai/mcp-servers/{mcp_server_id}/tools
List Mcp Server Tools
list_mcp_server_tools_route 3 params → 200422
PATCH
/v1/convai/mcp-servers/{mcp_server_id}/approval-policydeprecated
Update Mcp Server Approval Policy
update_mcp_server_approval_policy_route 2 params body → 200422
POST
/v1/convai/mcp-servers/{mcp_server_id}/tool-approvals
Create Mcp Server Tool Approval
add_mcp_server_tool_approval_route 2 params body → 200422
DELETE
/v1/convai/mcp-servers/{mcp_server_id}/tool-approvals/{tool_name}
Delete Mcp Server Tool Approval
remove_mcp_server_tool_approval_route 3 params → 200422
POST
/v1/convai/mcp-servers/{mcp_server_id}/tool-configs
Create Mcp Tool Configuration Override
add_mcp_tool_config_override_route 3 params body → 200409422
GET
/v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}
Get Mcp Tool Configuration Override
get_mcp_tool_config_override_route 3 params → 200404422
PATCH
/v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}
Update Mcp Tool Configuration Override
update_mcp_tool_config_override_route 4 params body → 200404422
DELETE
/v1/convai/mcp-servers/{mcp_server_id}/tool-configs/{tool_name}
Delete Mcp Tool Configuration Override
remove_mcp_tool_config_override_route 3 params → 200422
GET
/v1/convai/whatsapp-accounts/{phone_number_id}
Get Whatsapp Account
get_whatsapp_account 2 params → 200422
PATCH
/v1/convai/whatsapp-accounts/{phone_number_id}
Update Whatsapp Account
update_whatsapp_account 2 params body → 200422
DELETE
/v1/convai/whatsapp-accounts/{phone_number_id}
Delete Whatsapp Account
delete_whatsapp_account 2 params → 200422
GET
/v1/convai/whatsapp-accounts
List Whatsapp Accounts
list_whatsapp_accounts 2 params → 200422
POST
/v1/convai/agents/{agent_id}/branches
Create A New Branch
create_branch_route 2 params body → 200422
GET
/v1/convai/agents/{agent_id}/branches
List Agent Branches
get_branches_route 5 params → 200422
GET
/v1/convai/agents/{agent_id}/branches/{branch_id}
Get Agent Branch
get_branch_route 3 params → 200422
PATCH
/v1/convai/agents/{agent_id}/branches/{branch_id}
Update Agent Branch
update_branch_route 3 params body → 200422
GET
/v1/convai/agents/{agent_id}/versions/{version_id}
Get Agent Version Metadata
get_version_metadata_route 3 params → 200422
GET
/v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge-preview
Preview Merged Configuration
merge_preview_route 5 params → 200422
POST
/v1/convai/agents/{agent_id}/branches/{source_branch_id}/merge
Merge A Branch Into A Target Branch
merge_branch_into_target 4 params body → 200422
GET
/v1/convai/agents/{agent_id}/branches/{branch_id}/rebase-preview
Preview Rebased Configuration
rebase_preview_route 3 params → 200422
POST
/v1/convai/agents/{agent_id}/branches/{branch_id}/rebase
Rebase A Branch Onto Main
rebase_branch_onto_main 3 params → 200422
POST
/v1/convai/agents/{agent_id}/deployments
Create Or Update Deployments
create_agent_deployment_route 2 params body → 200422
POST
/v1/convai/agents/{agent_id}/drafts
Create Agent Draft
create_agent_draft_route 3 params body → 200422
DELETE
/v1/convai/agents/{agent_id}/drafts
Delete Agent Draft
delete_agent_draft_route 3 params → 200422
POST
/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures
Create Procedure
create_procedure_route 3 params body → 200422
GET
/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures
List Procedures
list_procedures_route 4 params → 200422
POST
/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/compile
Compile Procedures
compile_procedures_route 3 params → 200400422
DELETE
/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}
Remove Procedure
remove_procedure_route 4 params → 200422
GET
/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}
Get Procedure
get_procedure_route 6 params → 200422
GET
/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft
Get Procedure Draft
get_procedure_draft_route 4 params → 200422
PATCH
/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft
Update Procedure Draft
update_procedure_draft_route 4 params body → 200422
DELETE
/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft
Delete Procedure Draft
delete_procedure_draft_route 4 params → 200422
GET
/v1/convai/environment-variables
List Environment Variables
list_environment_variables 6 params → 200400422
POST
/v1/convai/environment-variables
Create Environment Variable
create_environment_variable 1 param body → 200400409422
GET
/v1/convai/environment-variables/{env_var_id}
Get Environment Variable
get_environment_variable 2 params → 200404422
PATCH
/v1/convai/environment-variables/{env_var_id}
Update Environment Variable
update_environment_variable 2 params body → 200400404422

Schemas 843

The contract defines 843 schemas that model the data the API accepts and returns. The most detailed are WidgetConfigResponseModel (53 properties), WidgetTextContents (50 properties), WidgetConfig-Input (49 properties), WidgetConfig-Output (49 properties). Each schema is shown below with its type and property counts.

RAGDocumentIndexesResponseModel
object
1 property 1 required
ListProductsParams
object
2 properties
AlertingSettingsResponse
object
Customer-facing view of alerting settings. Unlike AdminAlertingSettingsResponse, it has no internalnotifiers field: those are ElevenLabs-internal delivery chan…
3 properties
KnowledgeBaseRagToolStatus
string
LLMUsageCalculatorResponseModel
object
1 property 1 required
TTSOptimizeStreamingLatency
integer
CreateAuthConnectionEnvironmentVariableRequest
object
3 properties 3 required
AgentKnowledgeBaseRagChunkResponseModel
object
8 properties 8 required
AlertingPagerDutyNotifierResponse
object
3 properties 1 required
ConversationConfigOverrideConfig
object
2 properties
ToolErrorHandlingMode
string
Controls how tool errors are processed before being shared with the agent.
ASTLessThanOrEqualsOperatorNode-Input
object
3 properties 2 required
FeaturesUsageCommonModel
object
18 properties
TTSConversationalConfigWorkflowOverride-Output
object
14 properties
WorkflowOverrideAgentNodeModel-Input
object
9 properties 1 required
GetToolExecutionsPageResponseModel
object
3 properties 2 required
ASTLessThanOperatorNode-Input
object
3 properties 2 required
Body_Get_dependent_agents_for_multiple_documents_v1_convai_knowledge_base_dependent_agents_post
object
1 property 1 required
GetConversationsPageResponseModel
object
3 properties 2 required
EffectsSpec-Output
object
Filter preset, distance (proximity EQ), and environment (convolution reverb).
6 properties 6 required
ASTLLMNode-Output
object
3 properties 3 required
ConversationHistoryTranscriptResponseModel
object
27 properties 2 required
ListProceduresResponseModel
object
1 property 1 required
DataCollectionResultCommonModel
object
5 properties 2 required
AlertingSettings
object
Alerting configuration used at both per-agent and per-workspace level. Cascade order for per-monitor threshold and auto-resolve: agent → workspace → system def…
3 properties
TwilioEdgeLocation
string
Valid Twilio edge locations.
ClientEvent
string
KnowledgeBaseDependentType
string
GetAgentKnowledgebaseSizeResponseModel
object
1 property 1 required
ASTNotEqualsOperatorNode-Output
object
3 properties 3 required
TelephonyCallConfig-Output
object
3 properties
WidgetConfigResponseModel
object
53 properties 1 required
SentimentAnalysisSettings
object
TransferToAgentToolConfig-Output
object
2 properties 1 required
WhatsAppTemplateTextParam
object
3 properties 1 required
GetConversationUsersPageResponseModel
object
3 properties 2 required
RagConfig-Input
object
8 properties
DTMFInputConfig
object
Configuration for DTMF (keypad) input collection during phone calls.
3 properties
EmbedVariant
string
BuiltInTools-Input
object
System tools a conversational agent can be given. Deliberately not named ConversationalBuiltInTools: BuiltInToolsInput and BuiltInToolsOutput are part of the p…
7 properties
ThresholdGuardrail
object
2 properties
ConversationTagResponseModel
object
6 properties 6 required
MockNoMatchBehavior
string
Body_Create_URL_document_v1_convai_knowledge_base_url_post
object
6 properties 1 required
AgentWorkflowRequestModel
object
3 properties
GetAgentEmbedResponseModel
object
2 properties 2 required
GetAgentTestFolderResponseModel
object
4 properties 2 required
RequiredConstraints
object
Wrapper for anyOf/allOf composition constraints scoped to required fields.
2 properties
ListCalendarEventsParams
object
2 properties
ConversationSentimentAnalysis
object
6 properties 6 required
TopicSortBy
string
Body_Update_document_v1_convai_knowledge_base__documentation_id__patch
object
2 properties
ToolResponseMockConfig-Output
object
3 properties 1 required
PreToolSpeechMode
string
ConversationTTSUsageModel
object
Aggregated TTS usage for a conversation (analytics-only, not billing).
4 properties
AttachedUserDataCollectionRef
object
4 properties 2 required
LanguagePreset-Output
object
3 properties 1 required
CreateAgentProcedureParams
object
1 property
ImageAvatar
object
2 properties
VoicemailDetectionToolConfig
object
Allows the agent to detect when a voicemail system is encountered. This tool should be invoked by the LLM when it detects that the call has been answered by a…
2 properties
TestsFeatureUsageCommonModel
object
3 properties
Position-Output
object
2 properties 2 required
TopicSentimentAggregate
object
5 properties
RestoreCalendarEventParams
object
1 property
CreateProductParams
object
1 property
KnowledgeBaseRagChunkModel
object
3 properties 3 required
LLMCategoryUsage
object
2 properties
TurnConfigWorkflowOverride
object
14 properties
ConversationHistorySIPTrunkingPhoneCallModel
object
8 properties 6 required
CreateAgentResponseModel
object
1 property 1 required
WhatsAppOutboundCallResponse
object
3 properties 3 required
LLMUsageCalculatorLLMResponseModel
object
3 properties 3 required
CreateHolidayParams
object
1 property
OutputFormat
string
SIPTrunkCredentialsRequestModel
object
2 properties 1 required
WhatsAppTemplateImageParam
object
2 properties 1 required
ToolExecution
object
Execution-related properties for a tool (2025-11-25 only).
1 property
DependentPhoneNumberIdentifier
object
4 properties 4 required
StartProcedureToolResultErrorModel
object
4 properties 2 required
ConversationHistoryMultivoiceMessagePartModel
object
Represents a single voice part of a multi-voice message.
3 properties 3 required
BackgroundSoundSourceType
string
The type of background sound source.
TTSConversationalConfigOverrideConfig
object
7 properties
UserFeedback
object
2 properties 2 required
KnowledgeBaseDocumentChunkResponseModel
object
3 properties 3 required
DeleteClientParams
object
Delete a client, cascading deletion of all their appointments first.
1 property
SafetyResponseModel
object
3 properties
WorkflowStartNodeModel-Input
object
3 properties
ASTNode-Input
ConversationHistoryEvaluationCriteriaResultCommonModel
object
6 properties 3 required
OmitSchemaOverride
object
1 property
SoftTimeoutConfigOverrideConfig
object
2 properties
ConversationSimulationSpecification
object
A specification that will be used to simulate a conversation between an agent and an AI user.
4 properties 1 required
ConvAIEnvVarLocator
object
Used to reference an environment variable by label.
1 property 1 required
ConvAIFileUploadResponseModel
object
1 property 1 required
KnowledgeBaseToolResultModel
object
4 properties
ASTSubtractionOperatorNode-Input
object
3 properties 2 required
DeleteStaffParams
object
Delete an existing staff member from the system.
1 property
PatchWorkspaceSecretRequest
object
3 properties 3 required
ToolUsageStatsResponseModel
object
2 properties 1 required
DependentBranchInfo
object
5 properties 5 required
MCPApprovalPolicyUpdateRequestModel
object
Request model for updating MCP Server approval mode.
1 property 1 required
GetWhatsAppAccountResponse
object
12 properties 6 required
UpdateEnvironmentVariableRequest
object
1 property 1 required
AgentKnowledgeBaseRagQueryRequestModel
object
4 properties 1 required
OrchestratorToolMockBehaviorConfig
object
Orchestrator-side config: tools are identified by resolved names.
3 properties
RAGIndexOverviewEmbeddingModelResponseModel
object
2 properties 2 required
DashboardDataCollectionChartModel
object
3 properties 2 required
AgentWorkflowResponseModel
object
3 properties 3 required
WorkflowToolMaxIterationsExceededStepModel
object
3 properties 2 required
GuardrailsV1-Input
object
6 properties
ASTGreaterThanOperatorNode-Output
object
3 properties 3 required
FileInputConfigWorkflowOverride
object
3 properties
AgentWorkspaceOverrides-Output
object
2 properties
DynamicVariableUpdateCommonModel
object
Tracks a dynamic variable update that occurred during tool execution.
6 properties 6 required
ListClientsParams
object
List clients ordered by most recently updated, with an optional limit.
1 property
MCPApprovalPolicy
string
Defines the MCP server-level approval policy for tool execution.
CreateAssetParams
object
1 property
ConversationHistoryTranscriptApiIntegrationWebhookToolsResultCommonModel-Input
object
14 properties 6 required
LanguagePresetTranslation
object
2 properties 2 required
AnalysisCharging
object
Cost of running post-call analysis on this conversation. Present once an analysis pass has run, billed or not.
2 properties 2 required
PlatformCategory
string
Buckets that make up the non-LLM platformcharge of a conversation.
WhatsAppTemplateButtonComponentParams
object
4 properties 3 required
UpdateBookingPageAppearanceParams
object
1 property
Body_Duplicate_Agent_v1_convai_agents__agent_id__duplicate_post
object
1 property
UpdateHolidayParams
object
1 property
AgentHoldAudioConfig
object
Custom hold audio played on loop to callers waiting in the agent's queue. Set by uploading a file through the agent hold-audio endpoint. Values sent in agent c…
5 properties 5 required
ToolRequestModel
object
2 properties 1 required
KnowledgeBaseSortBy
string
Body_Patches_an_Agent_settings_v1_convai_agents__agent_id__patch
object
7 properties
MCPToolConfigOverride-Output
object
12 properties 1 required
LLMInfoModel
object
10 properties 7 required
ObjectJsonSchemaProperty-Input
object
9 properties
WhatsAppTemplateImageParamDetails
object
1 property 1 required
GetKnowledgeBaseSummaryFolderResponseModel
object
14 properties 9 required
Body_Upload_file_v1_convai_conversations__conversation_id__files_post
object
1 property 1 required
RAGDocumentIndexUsage
object
1 property 1 required
TTSOutputFormat
string
ASTAndOperatorNode-Output
object
2 properties 2 required
ConversationHistoryTwilioPhoneCallModel
object
7 properties 7 required
OptOutSmsReminderParams
object
1 property
ListAgentProceduresParams
object
1 property
EvaluationSettings-Input
object
Settings to evaluate an agent's performance. Agents are evaluated against a set of criteria, with success being defined as meeting some combination of those cr…
1 property
ASTNullNode-Input
object
1 property
DependentUnknownAgentIdentifier
object
A model that represents an agent dependent on a knowledge base/tools to which the user has no direct access.
3 properties 1 required
QueryParamsJsonSchema-Output
object
2 properties 1 required
ASTNode-Output
ProcedureDraftResponseModel
object
6 properties 3 required
ToolTypeFilter
string
PostWorkspaceSecretResponseModel
object
3 properties 3 required
ConversationHistoryFeedbackCommonModel
object
6 properties
VoiceMailDetectionResultSuccessModel
object
4 properties
AgentTransfer-Output
object
8 properties 1 required
BackgroundSoundConfig
object
4 properties
TransferToAgentToolResultSuccessModel-Input
object
11 properties 3 required
WhatsAppConversationInfo
object
4 properties 1 required
AgentTestFolderPathSegmentResponseModel
object
2 properties 1 required
WorkflowToolResponseModel-Input
object
A common model for workflow tool responses.
1 property
KnowledgeBaseToolStatus
string
KnowledgeBaseLocator
object
4 properties 3 required
InteractionBudget
string
ListServicesParams
object
2 properties
TextNormalisationType
string
Method for converting numbers to words before sending to TTS
InboundSIPTrunkConfigRequestModel
object
6 properties
LLMLiteralJsonSchemaProperty
object
3 properties 2 required
CreateSIPTrunkPhoneNumberRequestV2
object
8 properties 2 required
ProcedureListItemResponseModel
object
11 properties 2 required
PatchConvAISettingsRequest
object
6 properties
UpdateServiceParams
object
Update an existing service's information.
1 property
EvaluationResultFilter
string
MCPServerMetadataResponseModel
object
2 properties 1 required
ASTStringNode-Output
object
2 properties 2 required
ConversationHistoryTranscriptCommonModel-Input
object
23 properties 2 required
WidgetStyles
object
20 properties
ASTNotEqualsOperatorNode-Input
object
3 properties 2 required
ASRInputFormat
string
GetPhoneNumberSIPTrunkResponseModel
object
12 properties 4 required
Tool
object
Definition for a tool the client can call.
9 properties 2 required
TwilioMachineDetectionConfig
object
How to run Twilio's carrier-level answering machine detection (AMD) on a call.
1 property
RagConfigWorkflowOverride-Output
object
8 properties
MCPServerRequestModel
object
Request model for creating/updating an MCP Server configuration.
1 property 1 required
GetScheduleParams
object
2 properties
UpdateOrderParams
object
1 property
TurnModel
string
Version of the turn detection model to use.
EndCallTriggerAction
object
1 property
MediaCodec
string
AgentDeploymentRequestItem
object
2 properties 2 required
SIPLogMessage
object
9 properties 9 required
ConversationHistoryTranscriptOtherToolsResultCommonModel
object
11 properties 5 required
SupportedVoice
object
9 properties 2 required
CancelCalendarEventParams
object
1 property
AgentTestingSettings
object
Settings for agent testing configuration.
1 property
WorkflowExpressionConditionModel-Output
object
3 properties 3 required
PhoneNumberAgentInfo
object
4 properties 2 required
DeleteGroupSessionParams
object
Permanently remove a previously-cancelled group session. Group analogue of deletecalendarevent: cancel (cancelgroupsessionforall) is the soft, history-preservi…
1 property
UpdateStaffParams
object
Update an existing staff member's information.
1 property
ConversationHistoryTranscriptSystemToolResultCommonModel-Input
object
12 properties 6 required
PlayDTMFToolConfig
object
Allows the agent to play DTMF tones during a phone call. This tool can be used to interact with automated phone systems, such as navigating phone menus, enteri…
3 properties
ConversationInitiationSource
string
Enum representing the possible sources for conversation initiation.
ASTNumberNode-Input
object
2 properties 1 required
GetSecretDependenciesResponseModel
object
2 properties 1 required
MessagesSearchResult
object
transcriptindex: index of the message in the conversation transcript chunktext: text of the transcript; transcript messages if very long could have several chu…
8 properties 6 required
LLMReasoningEffort
string
GetAppointmentByConfirmationNumberParams
object
Look up an appointment by the booking confirmation number the caller quotes. The confirmation number is the 8-character code shown on the booking confirmation…
1 property
TurnConfigOverride
object
1 property
RAGIndexBatchSuccessfulResponseModel
object
2 properties 2 required
Body_Simulates_a_conversation_v1_convai_agents__agent_id__simulate_conversation_post
object
3 properties 1 required
AlertingWebhookNotifier
object
2 properties 1 required
AttachedSystemEvaluationRef
object
4 properties 2 required
PromptAgentAPIModelWorkflowOverride-Output
object
20 properties
EvaluationCriteriaSummaryResult
object
3 properties 1 required
UUITransferConfig
object
User-to-User Information envelope for SIP REFER transfers (RFC 7433). Outbound payloads are hex-encoded (the only encoding RFC 7433 defines). The protocol disc…
3 properties 1 required
ClientToolConfig-Input
object
A client tool is one that sends an event to the user's client to trigger something client side
16 properties 2 required
VisitedAgentRef
object
An agent (and optional branch) that participated in the call, in first-seen transcript order.
2 properties 1 required
RagConfig-Output
object
8 properties
KnowledgeBaseContentSearchResponseModel
object
2 properties 1 required
ConversationInitiationClientDataConfig-Output
object
5 properties
CreateAgentTestFolderResponseModel
object
2 properties 2 required
OutboundCallRecipient
object
4 properties
ASTGreaterThanOrEqualsOperatorNode-Input
object
3 properties 2 required
CreateTransferRuleParams
object
2 properties
TransferToAgentToolResultErrorModel
object
4 properties 2 required
AuthConnectionLocator
object
Used to reference an auth connection from the workspace's auth connection store.
1 property 1 required
FieldConflict
object
5 properties 2 required
ListLocationsParams
object
Params + Reception-proxied run() for listlocations.
1 property
ExternalSyncProvider
string
ContextualUpdateInfo
object
2 properties 1 required
ModerationGuardrail-Input
object
2 properties
ToolExecutionResponseModel
object
14 properties 7 required
MCPServerTransport
string
Supported MCP server transport types.
ConflictSection
string
TransferTypeEnum
string
UpdateBookingPageSettingsParams
object
1 property
GetKnowledgeBaseListResponseModel
object
3 properties 2 required
TransferToNumberToolConfig-Input
object
3 properties 1 required
ConversationConfig-Input
object
9 properties
ConversationVoiceRewardModel
object
2 properties 2 required
PlayDTMFResultSuccessModel
object
4 properties 1 required
PromptEvaluationCriteria
object
An evaluation using the transcript and a prompt for a yes/no achieved answer
10 properties 3 required
ASTMultiplicationOperatorNode-Input
object
3 properties 2 required
BatchFailureResponseModel
object
4 properties 4 required
WorkflowResultConditionModel-Output
object
3 properties 3 required
AgentMetadata
object
4 properties 1 required
Body_Send_an_outbound_message_via_WhatsApp_v1_convai_whatsapp_outbound_message_post
object
7 properties 6 required
AgentConfigOverrideConfig
object
4 properties
GetOrCreateRAGIndexRequestModel
object
3 properties 3 required
RagConfigWorkflowOverride-Input
object
8 properties
DependentUnknownToolIdentifier
object
A model that represents an tool dependent on a knowledge base/tools to which the user has no direct access.
2 properties 1 required
ConversationHistoryRagUsageCommonModel
object
2 properties 2 required
TransferToNumberToolConfig-Output
object
3 properties 1 required
WorkflowExpressionConditionModel-Input
object
3 properties 1 required
GetPhoneNumberInboundSIPTrunkConfigResponseModel
object
7 properties 4 required
TransferToNumberResultExotelSuccessModel
object
6 properties 1 required
ProcedureAtVersionResponseModel
object
7 properties 3 required
GetKnowledgeBaseFileResponseModel
object
15 properties 8 required
AgentTransfer-Input
object
8 properties 1 required
SkipTurnToolResponseModel
object
3 properties
ExternalSyncJobTrigger
string
KnowledgeBaseFolderPathSegmentSummaryResponseModel
object
1 property 1 required
FocusGuardrail
object
1 property
DeleteLocationParams
object
1 property
WorkflowEndNodeModel-Input
object
3 properties
CreateClientAppointmentParams
object
1 property
PromptAgentAPIModelOverrideConfig
object
5 properties
CreateProcedureResponseModel
object
1 property 1 required
UpdateProcedureDraftRequestModel
object
4 properties 3 required
PromptInjectionGuardrail
object
1 property
CustomGuardrailsConfig-Output
object
Config container for custom guardrails list
1 property
WorkflowEdgeModel-Output
object
4 properties 4 required
AgentSortBy
string
AttachedUserEvaluationRef
object
6 properties 2 required
ASTDynamicVariableNode-Input
object
2 properties 1 required
PostAgentAvatarResponseModel
object
2 properties 1 required
CreateAgentBranchResponseModel
object
2 properties 2 required
SIPUriDynamicVariableTransferDestination
object
2 properties 1 required
PromptAgentAPIModel-Input
object
20 properties
CustomLLM
object
7 properties 1 required
QueryParamsJsonSchema-Input
object
2 properties 1 required
EndProcedureToolResultSuccessModel
object
5 properties 2 required
UpdateAgentProcedureParams
object
1 property
AgentSummaryResponseModel
object
8 properties 6 required
GetConvAISettingsResponseModel
object
6 properties
CancelGroupSessionForAllParams
object
Cancel an entire group session and notify every registered participant. Destructive -- prefer cancelgroupsessionregistration for cancelling a single attendee.
1 property
TTSConversationalConfig-Output
object
14 properties
UpdateAgentRuleParams
object
1 property
TriggeredGuardrailCommonModel
object
2 properties 1 required
GetConversationTagsPageResponseModel
object
3 properties 2 required
LLMDeprecationConfigModel
object
5 properties 5 required
Body_Post_Agent_avatar_v1_convai_agents__agent_id__avatar_post
object
1 property 1 required
DeleteAgentProcedureParams
object
1 property
GuardrailType
string
Body_Create_or_update_deployments_v1_convai_agents__agent_id__deployments_post
object
1 property 1 required
ListAgentReferencesParams
object
1 property
MessagesSearchResponse
object
4 properties 2 required
KnowledgeBaseFolderPathSegmentResponseModel
object
2 properties 2 required
BatchCallingCampaignInformation
object
2 properties 2 required
ConversationUserResponseModel
object
9 properties 6 required
RagChunkMetadata
object
3 properties 3 required
DeleteTransferRuleParams
object
1 property
SystemToolConfig-Output
object
A system tool is a tool that is used to call a system method in the server
13 properties 2 required
AgentBranchSummary
object
18 properties 7 required
BackupLLMOverride
object
2 properties 1 required
AgentBranchBasicInfo
object
2 properties 2 required
WebhookToolConfig-Output
object
A webhook tool is a tool that calls an external webhook from our server
17 properties 3 required
GetAgentsPageResponseModel
object
3 properties 2 required
KnowledgeBaseToolConfig
object
2 properties
AlertingSlackNotifierResponse
object
4 properties 2 required
WorkflowStandaloneAgentNodeModel-Input
object
9 properties
AgentConfigAPIModelWorkflowOverride-Output
object
8 properties
PlatformUsage
object
Per-category breakdown of platformcharge (the analogue of llmusage).
1 property
WidgetExpandable
string
CreateServiceQuoteRequestParams
object
1 property
ToolCallSoundType
string
Predefined tool call sounds; None means no sound.
ConvAISecretLocator
object
Used to reference a secret from the agent's secret store.
1 property 1 required
ConversationConfigClientOverride-Input
object
5 properties
SoftTimeoutConfigWorkflowOverride
object
8 properties
ProcedureRefResponseModel
object
10 properties 1 required
ASTAdditionOperatorNode-Output
object
3 properties 3 required
KnowledgeBaseToolInfo
object
1 property
LeaveMessageParams
object
1 property
SIPUriTransferDestination
object
2 properties 1 required
WhatsAppAccountType
string
ResourceAccessInfo
object
6 properties 4 required
DeleteCalendarEventParams
object
Permanently remove a previously-cancelled calendar event. This delete tool is the irreversible follow-up to cancelcalendarevent. The backend rejects the call (…
1 property
Body_Compute_RAG_indexes_in_batch_v1_convai_knowledge_base_rag_index_post
object
1 property 1 required
ContentFormat
string
Canonical representation of a knowledge base document's stored content. HTML is the legacy default; documents created before this field existed are interpreted…
ASRConversationalConfig
object
4 properties
TransferToNumberResultTwilioSuccessModel
object
9 properties 3 required
MetricRecord
object
1 property 1 required
KnowledgeBaseDocumentType
string
ConversationInitiationClientDataConfig-Input
object
5 properties
EndCallToolResultModel
object
4 properties
ObjectJsonSchemaProperty-Output
object
8 properties
KnowledgeBaseSourceFileUrlResponseModel
object
1 property 1 required
Body_Bulk_move_tests_to_folder_v1_convai_agent_testing_bulk_move_post
object
2 properties 1 required
GetPhoneNumberExotelResponseModel
object
7 properties 3 required
WhatsAppTemplateBodyComponentParams
object
2 properties 1 required
ConversationDeletionSettings
object
6 properties
ToolsResponseModel
object
3 properties 2 required
RagRetrievalInfo
object
5 properties 4 required
AgentDeploymentResponse
object
1 property
WidgetLanguagePreset
object
6 properties
CustomGuardrailConfig
object
Single custom guardrail configuration
9 properties 2 required
ASTGreaterThanOrEqualsOperatorNode-Output
object
3 properties 3 required
AgentSimulatedChatTestResponseModel
object
2 properties 2 required
MCPToolConfigOverrideUpdateRequestModel
object
11 properties
ASTSubtractionOperatorNode-Output
object
3 properties 3 required
MCPToolAddApprovalRequestModel
object
Request model for adding approval for a single MCP tool.
4 properties 2 required
DeleteProductParams
object
1 property
Position-Input
object
2 properties
VADConfig
object
1 property
ASTDivisionOperatorNode-Input
object
3 properties 2 required
DynamicVariableInternalValueType
PrivacyConfig-Input
object
7 properties
ConversationalConfigAPIModelWorkflowOverride-Input
object
7 properties
WorkflowResultConditionModel-Input
object
3 properties 1 required
MCPToolApprovalPolicy
string
Defines the tool-level approval policy.
CheckServiceAvailabilityParams
object
1 property
TurnConfig
object
14 properties
EndProcedureToolConfig
object
2 properties
ConversationFeedbackType
string
LLMInputOutputTokensUsage
object
4 properties
ArrayJsonSchemaProperty-Output
object
6 properties
BuiltInTools-Output
object
System tools a conversational agent can be given. Deliberately not named ConversationalBuiltInTools: BuiltInToolsInput and BuiltInToolsOutput are part of the p…
7 properties
SoftTimeoutConfigOverride
object
2 properties
ApiIntegrationWebhookToolConfig-Input
object
18 properties 4 required
AgentCallLimits
object
3 properties
CreateTwilioPhoneNumberRequest
object
11 properties 4 required
SearchStrategy
string
Body_Create_text_document_v1_convai_knowledge_base_text_post
object
3 properties 1 required
GuardrailExecutionMode
string
BatchCallWhatsAppParams
object
3 properties 2 required
RAGIndexRequestModel
object
1 property 1 required
SMBToolConfig
object
SMB tool configuration that wraps SMB tool parameters.
15 properties 2 required
UnitTestToolCallParameter
object
2 properties 2 required
SetBookingSlugParams
object
1 property
WorkflowUnconditionalModel-Output
object
2 properties 2 required
BackgroundSoundConfigWorkflowOverride
object
4 properties
TransferToNumberResultErrorModel
object
4 properties 1 required
ModerationGuardrail-Output
object
2 properties
GetConversationSummaryResponseModel
object
10 properties 5 required
PlatformCategoryUsage
object
Accumulated charge for a single :class:PlatformCategory.
3 properties
DeleteHolidayParams
object
1 property
TTSConversationalConfigWorkflowOverride-Input
object
14 properties
BuiltInToolsWorkflowOverride-Input
object
7 properties
ListHolidaysParams
object
1 property
DependentUnknownMCPServerIdentifier
object
2 properties 1 required
ConfigEntityType
string
Entity types for the API configuration. This enum contains all valid entity type configurations that users can specify: - Parent types (e.g., "name", "financia…
WidgetConfig-Output
object
49 properties
AgentDeploymentRequest
object
1 property 1 required
GetKnowledgeBaseURLResponseModel
object
12 properties 8 required
ASTAndOperatorNode-Input
object
2 properties 1 required
AsyncConversationMetadata
object
Metadata for async conversation delivery (Zendesk, Slack, etc.).
9 properties 4 required
DashboardCriteriaChartModel
object
3 properties 2 required
ContentGuardrail-Output
object
3 properties
CreateClientParams
object
Create a new client in the system.
1 property
CreateConversationTagRequestModel
object
2 properties 1 required
AgentWorkspaceOverrides-Input
object
2 properties
ContentConfig
object
7 properties
AgentBranchResponse
object
12 properties 7 required
SIPTrunkOutboundCallResponse
object
4 properties 4 required
AlertingWebhookNotifierResponse
object
2 properties 1 required
CreatePhoneNumberResponseModel
object
1 property 1 required
Body_Simulates_a_conversation__Stream__v1_convai_agents__agent_id__simulate_conversation_stream_post
object
3 properties 1 required
MCPToolApprovalHash
object
Model for storing tool approval hashes for per-tool approval.
3 properties 2 required
GetKnowledgeBaseDependentAgentsResponseModel
object
4 properties 2 required
WorkflowToolNestedToolsStepModel-Input
object
6 properties 5 required
MCPServerConfig-Input
object
20 properties 2 required
ConversationInitiationClientDataWebhook
object
2 properties 2 required
GetPhoneNumberTwilioResponseModel
object
7 properties 3 required
ConversationConfigClientOverrideConfig-Output
object
5 properties
GetPhoneNumberOutboundSIPTrunkConfigResponseModel
object
SIP Trunk configuration details for a phone number
9 properties 4 required
TestToolResultModel
object
3 properties
FrustratedConversationRef
object
6 properties 6 required
ConversationConfig-Output
object
9 properties
GetClientAppointmentsParams
object
2 properties
CreateStaffParams
object
Create a new staff member in the system.
1 property
BranchProtectionStatus
string
WhatsAppTemplateLocationParamDetails
object
4 properties 4 required
GetBookingSlugStatusParams
object
1 property
AlertingIntegrationNotifier
MCPServerResponseModel
object
Response model representing an MCP Server configuration.
5 properties 3 required
KnowledgeBaseBulkDeleteSuccessfulResponseModel
object
2 properties 2 required
WhatsAppTemplateDocumentParam
object
2 properties 1 required
ConvAIWebhooks
object
4 properties
WhatsAppTemplateDocumentParamDetails
object
2 properties 1 required
PydanticPronunciationDictionaryVersionLocator
object
A locator for other documents to be able to reference a specific dictionary and it's version. This is a pydantic version of PronunciationDictionaryVersionLocat…
2 properties 2 required
ASRConversationalConfigOverride
object
1 property
WidgetTextContents
object
50 properties
WorkflowStartNodeModel-Output
object
3 properties 3 required
ConversationTurnMetrics
object
4 properties
ListMCPToolsResponseModel
object
Response model for testing tools available on an MCP server.
3 properties 2 required
BuiltInToolsWorkflowOverride-Output
object
7 properties
ConversationConfigWorkflowOverride-Output
object
9 properties
ASTNumberNode-Output
object
2 properties 2 required
PromptAgentAPIModelWorkflowOverride-Input
object
20 properties
ConversationSignedUrlResponseModel
object
1 property 1 required
Body_Create_a_new_branch_v1_convai_agents__agent_id__branches_post
object
7 properties 3 required
FileInputConfig
object
3 properties
WidgetFeedbackMode
string
PromptAgentAPIModel-Output
object
20 properties
ListStaffParams
object
2 properties
WorkflowToolNodeModel-Output
object
4 properties 4 required
EndProcedureToolResultErrorModel
object
4 properties 2 required
ASTLessThanOperatorNode-Output
object
3 properties 3 required
GetKnowledgeBaseTextResponseModel
object
10 properties 7 required
ConstantSchemaOverride
object
2 properties 1 required
AgentVersionParents
object
6 properties
ConversationHistoryTranscriptToolCallApiIntegrationWebhookDetails-Output
object
5 properties 5 required
Body_Update_agent_branch_v1_convai_agents__agent_id__branches__branch_id__patch
object
3 properties
BehaviorOverride
object
3 properties
LLMTokensCategoryUsage
object
2 properties
KnowledgeBaseDocumentMetadataResponseModel
object
3 properties 3 required
TwilioMachineDetectionMode
string
Which Twilio answering-machine-detection (AMD) mode to request for a call. enable returns a verdict as soon as Twilio can tell a human from a machine. detectme…
ListAssetsParams
object
2 properties
ASTLessThanOrEqualsOperatorNode-Output
object
3 properties 3 required
TurnEagerness
string
Agent's eagerness to respond. Higher values make agent wait for higher turn probability.
ASRConversationalConfigOverrideConfig
object
1 property
AnalysisRunningTotal
object
Cumulative LLM cost of running post-call analysis on this conversation.
5 properties
ScopedAnalysisResult
object
7 properties 3 required
GetKnowledgeBaseSummaryTextResponseModel
object
9 properties 7 required
ConversationFeedbackRequestModel
object
1 property
GetSIPLogMessagesResponse
object
3 properties 1 required
TurnMode
string
GuardrailsV1-Output
object
6 properties
ToolMockConfig
object
2 properties
UpdateClientParams
object
Update an existing client's information.
1 property
PhoneNumberTransferDestination
object
2 properties 1 required
AddKnowledgeBaseResponseModel
object
3 properties 2 required
SystemToolConfig-Input
object
A system tool is a tool that is used to call a system method in the server
13 properties 2 required
RegisterForGroupSessionParams
object
Register a client for a scheduled group session.
1 property
EmbeddingModelEnum
string
ApiIntegrationWebhookToolConfig-Output
object
18 properties 18 required
WhatsAppTemplateHeaderComponentParams
object
2 properties 1 required
ConversationReasoningModel
object
2 properties
ConversationHistoryTranscriptWorkflowToolsResultCommonModel-Input
object
12 properties 6 required
EntryBehavior
string
AgentTopicResponseModel
object
9 properties 4 required
GetClientByPhoneParams
object
Look up a client by their exact phone number.
1 property
AgentAnalysisItems-Output
object
2 properties
AgentConfigAPIModel-Output
object
8 properties
ExternalFolderSyncInfo
object
Metadata for a KB folder that mirrors an external source folder.
6 properties 3 required
KbExternalSyncJob
object
14 properties 7 required
ASTConditionalOperatorNode-Output
object
4 properties 4 required
ListAgentRulesParams
object
1 property
DashboardCallSuccessChartModel
object
2 properties 1 required
StartProcedureToolErrorStatus
string
BackupLLMDisabled
object
1 property
Body_Make_an_outbound_call_via_WhatsApp_v1_convai_whatsapp_outbound_call_post
object
6 properties 5 required
GetWorkspaceSecretsResponseModel
object
2 properties 1 required
PromptAgentAPIModelOverride-Output
object
5 properties
OutboundCallRecipientResponseModel
object
8 properties 5 required
WidgetTextContentsTranslation
object
2 properties
ConversationInitiationClientDataRequest-Output
object
9 properties
DeleteAgentHoldAudioResponseModel
object
1 property 1 required
KnowledgeBaseRagToolConfig
object
1 property
PhoneNumberDynamicVariableTransferDestination
object
2 properties 1 required
AgentPlatformSettingsRequestModel
object
21 properties
ConversationInitiationClientDataRequest-Input
object
9 properties
LLMListResponseModel
object
2 properties 2 required
ProcedureValidationError
object
2 properties 2 required
ToolExecutionMode
string
EvaluationSettings-Output
object
Settings to evaluate an agent's performance. Agents are evaluated against a set of criteria, with success being defined as meeting some combination of those cr…
1 property
Body_Update_file_document_v1_convai_knowledge_base__documentation_id__update_file_patch
object
1 property 1 required
LanguagePreset-Input
object
3 properties 1 required
EndCallToolConfig
object
1 property
MessageSearchSortBy
string
ListResponse_AgentBranchSummary_
object
2 properties 1 required
SearchClientsParams
object
Search for clients by name, phone number, or email.
1 property
OutboundSIPTrunkConfigRequestModel
object
7 properties 1 required
ToolType
string
SpellingPatience
string
Controls if the agent should be more patient when user is spelling numbers and named entities.
RAGIndexOverviewResponseModel
object
3 properties 3 required
WidgetPlacement
string
ASTEqualsOperatorNode-Output
object
3 properties 3 required
MergePreviewResponseModel
object
18 properties 4 required
AgentConfigOverride-Output
object
4 properties
MCPToolConfigOverrideCreateRequestModel
object
12 properties 1 required
CreateStringEnvironmentVariableRequest
object
3 properties 3 required
Body_Handle_an_outbound_call_via_Exotel_v1_convai_exotel_outbound_call_post
object
5 properties 3 required
PostDialDigitsStatic
object
2 properties 1 required
RegexParameterEvaluationStrategy
object
2 properties 2 required
GetToolDependentAgentsResponseModel
object
4 properties 2 required
AlertingPagerDutyNotifier
object
3 properties 1 required
CustomGuardrail-Output
object
Container for custom guardrails, matching ModerationGuardrail pattern
1 property
WorkflowToolResponseModel-Output
object
A common model for workflow tool responses.
1 property
WidgetConfig-Input
object
49 properties
EnvironmentAuthConnectionLocator
object
References an environment variable of type 'authconnection' by label. At runtime, resolves to the auth connection for the current environment, falling back to…
1 property 1 required
WorkflowEndNodeModel-Output
object
3 properties 3 required
CompileProceduresResponseModel
object
1 property 1 required
CustomLLMAPIType
string
Body_Handle_an_outbound_call_via_Twilio_v1_convai_twilio_outbound_call_post
object
6 properties 3 required
ConversationConfigWorkflowOverride-Input
object
9 properties
VADConfigWorkflowOverride
object
1 property
ConvAIWorkspaceStoredSecretConfig
object
4 properties 4 required
KnowledgeBaseDeletedResponseModel
object
1 property 1 required
GetKnowledgeBaseSummaryFileResponseModel
object
13 properties 7 required
ASRProvider
string
ResponseFilterMode
string
Controls how tool responses are filtered before being visible to the agent.
CreateLocationParams
object
1 property
ListClientInteractionsParams
object
1 property
WorkflowPhoneNumberNodeModel-Output
object
9 properties 9 required
PostWorkspaceSecretRequest
object
3 properties 3 required
Body_Submit_a_batch_call_request__v1_convai_batch_calling_submit_post
object
11 properties 3 required
ToolAnnotations
object
Additional properties describing a Tool to clients. NOTE: all properties in ToolAnnotations are hints. They are not guaranteed to provide a faithful descriptio…
5 properties
LanguageDetectionToolConfig
object
2 properties
BatchCallRecipientStatus
string
ChatSourceMedium
string
OptInSmsReminderParams
object
1 property
CompileProceduresValidationErrorResponseModel
object
1 property 1 required
LLMUsage-Output
object
1 property
RequiredConstraint
object
A set of fields that must all be present to satisfy this constraint.
1 property 1 required
WebhookTranscriptFormat
string
LLMDeprecationInfoModel
object
8 properties 2 required
ExternalSyncJobType
string
TransferBranchInfoDefaultingToMain
object
2 properties 2 required
CreateOrderParams
object
1 property
PostDialDigitsDynamicVariable
object
2 properties 1 required
TTSConversationalConfigOverride
object
7 properties
ConversationProduct
string
Which product surface owns this agent document.
CrawlStatus
string
AgentConfigOverride-Input
object
4 properties
Body_Merge_a_branch_into_a_target_branch_v1_convai_agents__agent_id__branches__source_branch_id__merge_post
object
2 properties
ToolResponseModel
object
5 properties 4 required
DynamicVariableAssignment
object
Configuration for extracting values from tool responses and assigning them to dynamic variables.
5 properties 2 required
ASRConversationalConfigWorkflowOverride
object
4 properties
CustomSIPHeaderWithDynamicVariable
object
Custom SIP header for phone transfers with a dynamic variable reference. The value is a variable name that will be resolved at runtime. Value is not validated…
3 properties 3 required
MCPToolConfig-Output
object
An MCP tool configuration that can be used to call MCP servers
22 properties 7 required
AgentMetadataResponseModel
object
2 properties 2 required
TransferToNumberResultSipSuccessModel
object
5 properties 1 required
ConversationHistoryBatchCallModel
object
3 properties 2 required
ConversationalConfigAPIModel-Output
object
7 properties
UpdateCalendarEventParams
object
1 property
DependentAvailableToolIdentifier
object
5 properties 4 required
UpdateGroupSessionSeatsParams
object
Change the seat count of an existing group session registration.
1 property
SecretDependencyType
string
DeleteAssetParams
object
1 property
PatchConversationTagRequestModel
object
2 properties
UpdateProductParams
object
1 property
UpdateTransferRuleParams
object
2 properties
ConversationHistoryRedactionConfig
object
2 properties
SIPTrunkTransportEnum
string
PhoneNumberTransfer
object
8 properties 2 required
Body_Post_Agent_hold_audio_v1_convai_agents__agent_id__hold_audio_post
object
1 property 1 required
FeatureStatusCommonModel
object
2 properties
TelephonyCallConfig-Input
object
3 properties
CancelOrderParams
object
1 property
ConversationSummaryResponseModel
object
23 properties 7 required
ConversationInitiationSourceInfo
object
Information about the source of conversation initiation
2 properties
GetLiveCountResponse
object
1 property 1 required
ASTDynamicVariableNode-Output
object
2 properties 2 required
KnowledgeBaseRagToolResultModel
object
5 properties
SuggestedAudioTag
object
2 properties 1 required
CreateExotelPhoneNumberRequest
object
12 properties 7 required
ASTAdditionOperatorNode-Input
object
3 properties 2 required
ASTOrOperatorNode-Input
object
2 properties 1 required
DependentAvailableMCPServerIdentifier
object
5 properties 4 required
UpdateAssetParams
object
1 property
MCPServersResponseModel
object
Response model for a list of MCP Server configurations.
1 property 1 required
SortDirection
string
NumericDistributionAggregate
object
4 properties
AgentConfigAPIModelWorkflowOverride-Input
object
8 properties
UpdatePhoneNumberRequest
object
8 properties
EffectsSpec-Input
object
Filter preset, distance (proximity EQ), and environment (convolution reverb).
6 properties
LanguageDetectionToolResultModel
object
4 properties
MCPToolConfig-Input
object
An MCP tool configuration that can be used to call MCP servers
22 properties 7 required
LiteralJsonSchemaProperty
object
Schema property for literal JSON types. IMPORTANT: Only ONE of the following fields can be set: description (LLM provides value), dynamicvariable (value from v…
9 properties 1 required
GetBookingPageSettingsParams
object
1 property
AgentPlatformSettingsResponseModel
object
22 properties
AnalysisType
string
Body_Bulk_delete_knowledge_base_documents_v1_convai_knowledge_base_bulk_delete_post
object
2 properties 1 required
Body_Create_Agent_v1_convai_agents_create_post
object
5 properties 1 required
TransferToAgentToolConfig-Input
object
2 properties 1 required
WidgetEndFeedbackType
string
UpdateLocationParams
object
1 property
AgentKnowledgeBaseRagQueryResponseModel
object
2 properties 2 required
ASTBooleanNode-Output
object
2 properties 2 required
UpdateWhatsAppAccountRequest
object
4 properties
EvaluationSuccessResult
string
TwilioRegionId
string
Valid Twilio region IDs.
ConversationHistoryTranscriptSystemToolResultCommonModel-Output
object
12 properties 6 required
LLMSchemaOverride
object
2 properties
ConversationHistoryMultivoiceMessageModel
object
Represents a message from a multi-voice agent.
1 property 1 required
EnvironmentVariableSecretValue
object
1 property 1 required
RetryTriggerAction
object
2 properties
AlertingSlackNotifier
object
4 properties 2 required
SIPMediaEncryptionEnum
string
ContentGuardrail-Input
object
3 properties
RegionConfigRequest
object
3 properties 3 required
EnvironmentVariableSecretValueRequest
object
1 property 1 required
ListCustomerFacingAgentsParams
object
List every customer-facing agent on the workspace. The assistant uses this whenever it needs to act on a specific customer-facing agent (rules, config edits, e…
1 property
GetAgentTopicsResponseModel
object
6 properties 3 required
GetKnowledgeBaseSummaryURLResponseModel
object
11 properties 8 required
DeleteServiceParams
object
Delete an existing service from the system.
1 property
AlertingIntegrationNotifierResponse
URLAvatar
object
2 properties
Icon
object
An optionally-sized icon for display in a user interface (2025-11-25+).
4 properties 1 required
ExactParameterEvaluationStrategy
object
2 properties 2 required
ResponseFilter
object
Configuration for filtering tool responses before they are visible to the agent.
3 properties
AnalysisScope
string
ClientToolConfig-Output
object
A client tool is one that sends an event to the user's client to trigger something client side
16 properties 2 required
PlayDTMFResultErrorModel
object
4 properties 1 required
UpdateCustomerFacingConfigParams
object
1 property
WorkflowToolEdgeStepModel
object
4 properties 3 required
Body_Register_a_Twilio_call_and_return_TwiML_v1_convai_twilio_register_call_post
object
5 properties 3 required
ASTEqualsOperatorNode-Input
object
3 properties 2 required
ListWhatsAppAccountsResponse
object
1 property 1 required
Body_Handle_an_outbound_call_via_SIP_trunk_v1_convai_sip_trunk_outbound_call_post
object
5 properties 3 required
ConversationHistoryElevenAssistantCommonModel
object
1 property
AgentTrustContext
string
The trust context in which the agent operates. UNKNOWN: not yet classified (existing agents created before this feature). LOW: serves untrusted external partic…
ConversationChargingCommonModel
object
15 properties
TokenResponseModel
object
2 properties 2 required
TelephonyProvider
string
ModerationConfig
object
11 properties
UsersSortBy
string
MCPToolConfigOverride-Input
object
12 properties 1 required
FileRefreshStatus
object
In-flight/last refresh state for an externally-synced KB file.
6 properties
ExotelApiSubdomain
string
AuthorizationMethod
string
BatchCallDetailedResponse
object
Detailed response model for a batch call including all recipients.
22 properties 22 required
Body_Create_agent_test_folder_v1_convai_agent_testing_folders_post
object
2 properties 1 required
EnvironmentVariableResponse
object
8 properties 7 required
LLMParameterEvaluationStrategy
object
2 properties 2 required
MatchAnythingParameterEvaluationStrategy
object
1 property 1 required
CriteriaScoringMode
string
EnvironmentVariableAuthConnectionValueRequest
object
1 property 1 required
Body_Create_agent_draft_v1_convai_agents__agent_id__drafts_post
object
5 properties 4 required
ArrayJsonSchemaProperty-Input
object
7 properties
ConversationHistoryTranscriptFileInputResponseModel
object
4 properties 4 required
PromptAgentAPIModelOverride-Input
object
5 properties
SkipTurnToolConfig
object
Allows the agent to explicitly skip its turn. This tool should be invoked by the LLM when the user indicates they would like to think or take a short pause bef…
1 property
GetAnalyticsSummaryParams
object
Get a summary of key business analytics for a time period.
1 property
EndProcedureToolErrorStatus
string
AnalysisRunSnapshot
object
LLM cost of the most recent post-call analysis pass on this conversation.
4 properties
ASTOrOperatorNode-Output
object
2 properties 2 required
RAGIndexStatus
string
CreateServiceParams
object
Create a new service (classic, rental, or group) in the system.
1 property
CustomGuardrail-Input
object
Container for custom guardrails, matching ModerationGuardrail pattern
1 property
ExternalFileSyncInfo
object
Tracks the link back to the original file in an external source.
7 properties 6 required
ConversationHistoryAnalysisCommonModel
object
9 properties 2 required
OrbAvatar
object
3 properties
KnowledgeBaseContentSearchResult
object
3 properties 2 required
AgentVersionMetadata
object
8 properties 7 required
WorkflowToolLocator
object
2 properties 1 required
ScheduleGroupSessionParams
object
Schedule a single instance of a group service. The session's duration is derived from the parent service so the assistant only has to pin start time, the (opti…
1 property
CustomGuardrailsConfig-Input
object
Config container for custom guardrails list
1 property
ConversationHistoryTranscriptToolCallWebhookDetails
object
7 properties 2 required
TelephonyDirection
string
ConversationHistoryTranscriptApiIntegrationWebhookToolsResultCommonModel-Output
object
14 properties 14 required
ValidationError
object
3 properties 3 required
LLM
string
TTSConversationalModel
string
LLMUsageCalculatorPublicRequestModel
object
3 properties 3 required
TriggerUserVerificationParams
object
1 property
AssignConversationTagsRequestModel
object
1 property 1 required
LLMUsageCalculatorRequestModel
object
3 properties
ConversationalConfigAPIModel-Input
object
7 properties
ToolResponseMockConfig-Input
object
3 properties 1 required
AllowlistItem
object
1 property 1 required
ProcedureType
string
MCPServerConfigUpdateRequestModel
object
Unified request model for updating MCP Server configuration.
14 properties
BackgroundSoundPresetId
string
Predefined background sound preset identifiers.
PrivacyConfig-Output
object
7 properties
ConversationInitiationClientDataInternal
object
11 properties
ASTBooleanNode-Input
object
2 properties 1 required
GetConvAIDashboardSettingsResponseModel
object
1 property
TopicMetricsAggregate
object
3 properties
TransferBranchInfoTrafficSplit
object
3 properties 3 required
ListResponseMeta
object
3 properties
BackupLLMDefault
object
1 property
ConversationalConfigAPIModelWorkflowOverride-Output
object
7 properties
ASTDivisionOperatorNode-Output
object
3 properties 3 required
PostAgentHoldAudioResponseModel
object
2 properties 2 required
ValidateUserVerificationCodeParams
object
1 property
AttachedSystemDataCollectionRef
object
3 properties 2 required
ConversationConfigOverride
object
2 properties
AgentAnalysisItems-Input
object
2 properties
ConversationHistoryTranscriptToolCallClientDetails
object
2 properties 1 required
Body_Update_agent_test_folder_v1_convai_agent_testing_folders__folder_id__patch
object
1 property 1 required
ProcedureVersionRef
object
2 properties 2 required
StartProcedureToolResultSuccessModel
object
7 properties 2 required
MockingStrategy
string
TopicDiscoverySettings
object
Per-agent topic-discovery configuration. Cadence and analysis window are managed internally; this only exposes the customer-facing on/off toggle.
ContentThresholdGuardrail
object
2 properties
CreateAgentRuleParams
object
1 property
RAGDocumentIndexResponseModel
object
5 properties 5 required
WorkflowLLMConditionModel-Input
object
3 properties 1 required
WidgetEndFeedbackConfig
object
1 property
AgentDeploymentPercentageStrategy
object
2 properties 1 required
CreateProductQuoteRequestParams
object
1 property
SubmitBusinessInfoParams
object
Finalize the onboarding interview: create a text knowledge source and mark done.
1 property
CreateClientInteractionParams
object
1 property
DynamicVariablesConfigWorkflowOverride
object
1 property
LLMUsage-Input
object
1 property
BatchCallResponse
object
21 properties 21 required
TransferToAgentToolResultSuccessModel-Output
object
11 properties 3 required
EnvironmentVariablesListResponse
object
3 properties 2 required
AnalysisProperty
object
Data collection property with optional per-item LLM override for post-call analysis. TODO: migrate to composition (valueschema: LiteralJsonSchemaProperty + llm…
11 properties 1 required
SendCustomEmailParams
object
1 property
WorkflowToolNodeModel-Input
object
4 properties
ReportKnowledgeGapParams
object
1 property
LivekitStackType
string
ConversationHistoryTranscriptToolCallMCPDetails
object
9 properties 4 required
WorkflowOverrideAgentNodeModel-Output
object
9 properties 9 required
WebhookToolConfig-Input
object
A webhook tool is a tool that calls an external webhook from our server
17 properties 3 required
AgentDefinitionSource
string
TwilioOutboundCallResponse
object
4 properties 4 required
TTSModelFamily
string
ConvAIStoredSecretDependencies
object
8 properties 3 required
ConversationASRUsageModel
object
Aggregated ASR usage for a conversation (analytics-only, not billing).
3 properties
TTSConversationalConfig-Input
object
14 properties
ListTransferRulesParams
object
1 property
EnvironmentVariableAuthConnectionValue
object
1 property 1 required
CreateProcedureRequestModel
object
5 properties
ConversationHistoryTranscriptToolCallApiIntegrationWebhookDetails-Input
object
5 properties 1 required
GetAgentLinkResponseModel
object
2 properties 1 required
WhatsAppOutboundMessageResponse
object
1 property 1 required
AutoSyncInfo
object
4 properties
WorkflowFeaturesUsageCommonModel
object
5 properties
ConversationHistoryExotelPhoneCallModel
object
7 properties 6 required
KnowledgeBaseSummaryBatchSuccessfulResponseModel
object
2 properties 2 required
GetConversationResponseModel
object
20 properties 9 required
ListGroupSessionsParams
object
List scheduled group sessions for a group service in a date range. Group services are scheduled in advance (e.g. yoga classes, workshops) and callers register…
1 property
ASTNullNode-Output
object
1 property 1 required
ASTStringNode-Input
object
2 properties 1 required
CreateSecretEnvironmentVariableRequest
object
3 properties 3 required
DynamicVariablesConfig
object
1 property
ASTLLMNode-Input
CancelGroupSessionRegistrationParams
object
Cancel a single client's registration for a group session.
1 property
DynamicVariableSchemaOverride
object
2 properties 1 required
SecretDependencyResourceType
string
UserFeedbackScore
string
AllowedValues
object
1 property 1 required
AgentConfigAPIModel-Input
object
8 properties
UpdateBusinessInfoParams
object
1 property
ConversationConfigClientOverrideConfig-Input
object
5 properties
ToolSortBy
string
DependentAvailableAgentIdentifier
object
6 properties 4 required
ConversationTokenPurpose
string
AttachedTestModel
object
2 properties 1 required
AgentSummaryBatchSuccessfulResponseModel
object
2 properties 2 required
TopicEvaluationCriteriaAggregate
object
4 properties 1 required
CustomSIPHeader
object
Custom SIP header for phone transfers with a static (validated) value.
3 properties 2 required
AlertingMonitorConfig
object
7 properties
WebhookToolApiSchemaConfig-Output
object
11 properties 1 required
WebhookEventType
string
ToolInterruptionMode
string
SMSConversationInfo
object
4 properties 2 required
WorkflowToolNestedToolsStepModel-Output
object
6 properties 5 required
MCPServerConfig-Output
object
20 properties 2 required
BatchCallStatus
string
ConversationHistoryTranscriptToolCallCommonModel-Input
object
6 properties 4 required
GetOrderByConfirmationNumberParams
object
1 property
ExotelOutboundCallResponse
object
4 properties 4 required
ConversationVoiceUsageModel
object
2 properties 1 required
WhatsAppTemplateLocationParam
object
2 properties 1 required
ConversationConfigClientOverride-Output
object
5 properties
WorkflowLLMConditionModel-Output
object
3 properties 3 required
WorkflowEdgeModel-Input
object
4 properties 2 required
ASTMultiplicationOperatorNode-Output
object
3 properties 3 required
WorkflowUnconditionalModel-Input
object
2 properties
RegionalProcessingSurchargeInfo
object
1 property 1 required
DummyToolResultModel
object
1 property
ConversationSummaryMessageModel
object
2 properties 2 required
SentimentAggregate
object
12 properties 12 required
ConvAIUserSecretDBModel
object
User-specific secret model that are not shared with other users in a workspace.
4 properties 4 required
DeleteAgentRuleParams
object
1 property
ASTConditionalOperatorNode-Input
object
4 properties 3 required
GetKnowledgeBaseFolderResponseModel
object
14 properties 8 required
Verbosity
string
TurnConfigOverrideConfig
object
1 property
ConversationTokenResponseModel
object
6 properties 3 required
WorkflowStandaloneAgentNodeModel-Output
object
9 properties 9 required
SearchHighlightSegment
object
2 properties 2 required
GetAgentResponseModel
object
15 properties 4 required
PatchConvAIDashboardSettingsRequest
object
1 property
HTTPValidationError
object
1 property
ConversationHistoryTranscriptToolCallCommonModel-Output
object
6 properties 4 required
DeleteClientInteractionParams
object
1 property
GetClientOrdersParams
object
2 properties
ApiIntegrationWebhookOverrides
object
4 properties
DocumentUsageModeEnum
string
ASTGreaterThanOperatorNode-Input
object
3 properties 2 required
WidgetLanguagePresetResponse
object
5 properties
ConversationHistoryTranscriptWorkflowToolsResultCommonModel-Output
object
12 properties 6 required
SIPLogMessageDirection
string
ConversationHistoryErrorCommonModel
object
2 properties 1 required
ASRQuality
string
ConversationHistoryMetadataCommonModel
object
30 properties 3 required
Body_Create_file_document_v1_convai_knowledge_base_file_post
object
3 properties 1 required
WidgetTermsTranslation
object
2 properties 2 required
WorkspaceBatchCallsResponse
object
3 properties 1 required
KnowledgeBaseDocumentChunksResponseModel
object
2 properties 1 required
StartProcedureToolConfig
object
2 properties
AgentQueueingConfig
object
3 properties
WorkflowPhoneNumberNodeModel-Input
object
9 properties 1 required
WebhookToolApiSchemaConfig-Input
object
11 properties 1 required
SoftTimeoutConfig
object
Configuration for soft timeout functionality during LLM response generation.
8 properties
ProcedureDraftRef
object
2 properties 1 required
IntegrationType
string
AuthSettings
object
4 properties
Body_Add_to_knowledge_base_v1_convai_knowledge_base_post
object
3 properties
ToolCallSoundBehavior
string
Determines how the tool call sound should be played.
ConvAIDynamicVariable
object
Used to reference a dynamic variable.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elevenlabs-agents-platform-api-openapi.yml Raw ↑

Other APIs ElevenLabs publishes across the network.

elevenlabs Agents API
AE Profile APIs.io
elevenlabs Audio Isolation API
AE Profile APIs.io
elevenlabs Audio Native API
AE Profile APIs.io
elevenlabs Conversations API
AE Profile APIs.io
elevenlabs Dubbing API
AE Profile APIs.io
elevenlabs Dubbing Resources API
AE Profile APIs.io
elevenlabs Instant Voice Cloning API
AE Profile APIs.io
elevenlabs Knowledge Base API
AE Profile APIs.io
elevenlabs Music Generation API
AE Profile APIs.io
elevenlabs Professional Voice Cloning API
AE Profile APIs.io
elevenlabs Speech to Speech API
AE Profile APIs.io
elevenlabs Speech to Text API
AE Profile APIs.io
#Agents Platform
← Back to E APIs
API Details
ID
elevenlabs:elevenlabs-agents-platform-api
Base URL
https://api.elevenlabs.io
Docs
https://elevenlabs.io/docs/api-reference/introduction
Provider
ElevenLabs
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=elevenlabs-agents-platform-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/elevenlabs-agents-platform-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of ElevenLabs Agents Platform API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.