Skip to main content
Server path: /elevenlabs-agents | Type: Application | PCID required: Yes

Tools

ToolDescription
elevenlabs_agents_create_agent_routeCreate Agent
elevenlabs_agents_create_phone_number_routeImport Phone Number
elevenlabs_agents_create_text_document_routeCreate Text Document
elevenlabs_agents_delete_agent_routeDelete Agent
elevenlabs_agents_delete_conversation_routeDelete Conversation
elevenlabs_agents_delete_knowledge_base_documentDelete Knowledge Base Document Or Folder
elevenlabs_agents_delete_phone_number_routeDelete Phone Number
elevenlabs_agents_duplicate_agent_routeDuplicate Agent
elevenlabs_agents_get_agent_link_routeGet Shareable Agent Link
elevenlabs_agents_get_agent_routeGet Agent
elevenlabs_agents_get_agent_summaries_routeGet Agent Summaries
elevenlabs_agents_get_agent_widget_routeGet Agent Widget Config
elevenlabs_agents_get_agents_routeList Agents
elevenlabs_agents_get_conversation_audio_routeGet Conversation Audio
elevenlabs_agents_get_conversation_histories_routeGet Conversations
elevenlabs_agents_get_conversation_history_routeGet Conversation Details
elevenlabs_agents_get_documentation_from_knowledge_baseGet Documentation From Knowledge Base
elevenlabs_agents_get_knowledge_base_list_routeGet Knowledge Base List
elevenlabs_agents_get_phone_number_routeGet Phone Number
elevenlabs_agents_list_phone_numbers_routeList Phone Numbers
elevenlabs_agents_patch_agent_settings_routePatches An Agent Settings
elevenlabs_agents_post_conversation_feedback_routeSend Conversation Feedback
elevenlabs_agents_run_conversation_analysisRun Conversation Analysis
elevenlabs_agents_text_search_conversation_messages_routeText Search Conversation Messages

elevenlabs_agents_create_agent_route

Create Agent Parameters:
ParameterTypeRequiredDefaultDescription
enable_versioningbooleanNoEnable versioning for the agent
conversation_configobjectYesConversation Config
nameobjectNoA name to make the agent easier to find
platform_settingsobjectNoPlatform settings for the agent are all settings that aren’t related to the conversation orchestration and content.
tagsobjectNoTags to help classify and filter the agent
workflowobjectNoThe workflow value

elevenlabs_agents_create_phone_number_route

Import Phone Number Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesCreate Phone Request Information

elevenlabs_agents_create_text_document_route

Create Text Document Parameters:
ParameterTypeRequiredDefaultDescription
nameobjectNoA custom, human-readable name for the document.
parent_folder_idobjectNoIf set, the created document or folder will be placed inside the given folder.
textstringYesText content to be added to the knowledge base.

elevenlabs_agents_delete_agent_route

Delete Agent Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesThe id of an agent. This is returned on agent creation.

elevenlabs_agents_delete_conversation_route

Delete Conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesThe id of the conversation you’re taking the action on.

elevenlabs_agents_delete_knowledge_base_document

Delete Knowledge Base Document Or Folder Parameters:
ParameterTypeRequiredDefaultDescription
documentation_idstringYesThe id of a document from the knowledge base. This is returned on document addition.
forcebooleanNoIf set to true, the document or folder will be deleted regardless of whether it is used by any agents and it will be removed from the dependent agents. For non-empty folders, this will also delete all child documents and folders.

elevenlabs_agents_delete_phone_number_route

Delete Phone Number Parameters:
ParameterTypeRequiredDefaultDescription
phone_number_idstringYesThe id of an agent. This is returned on agent creation.

elevenlabs_agents_duplicate_agent_route

Duplicate Agent Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesThe id of an agent. This is returned on agent creation.
nameobjectNoA name to make the agent easier to find

Get Shareable Agent Link Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesThe id of an agent. This is returned on agent creation.

elevenlabs_agents_get_agent_route

Get Agent Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesThe id of an agent. This is returned on agent creation.
version_idobjectNoThe ID of the agent version to use
branch_idobjectNoThe ID of the branch to use

elevenlabs_agents_get_agent_summaries_route

Get Agent Summaries Parameters:
ParameterTypeRequiredDefaultDescription
agent_idsany[]YesList of agent IDs to fetch summaries for

elevenlabs_agents_get_agent_widget_route

Get Agent Widget Config Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesThe id of an agent. This is returned on agent creation.
conversation_signatureobjectNoAn expiring token that enables a websocket conversation to start. These can be generated for an agent using the /v1/convai/conversation/get-signed-url endpoint

elevenlabs_agents_get_agents_route

List Agents Parameters:
ParameterTypeRequiredDefaultDescription
page_sizeintegerNoHow many Agents to return at maximum. Can not exceed 100, defaults to 30.
searchobjectNoSearch by agents name.
archivedobjectNoFilter agents by archived status
show_only_owned_agentsbooleanNoIf set to true, the endpoint will omit any agents that were shared with you by someone else and include only the ones you own. Deprecated: use created_by_user_id instead.
created_by_user_idobjectNoFilter agents by creator user ID. When set, only agents created by this user are returned. Takes precedence over show_only_owned_agents. Use ‘@me’ to refer to the authenticated user.
sort_directionstringNoThe direction to sort the results
sort_byobjectNoThe field to sort the results by
cursorobjectNoUsed for fetching next page. Cursor is returned in the response.

elevenlabs_agents_get_conversation_audio_route

Get Conversation Audio Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesThe id of the conversation you’re taking the action on.

elevenlabs_agents_get_conversation_histories_route

Get Conversations Parameters:
ParameterTypeRequiredDefaultDescription
cursorobjectNoUsed for fetching next page. Cursor is returned in the response.
agent_idobjectNoThe id of the agent you’re taking the action on.
call_successfulobjectNoThe result of the success evaluation
call_start_before_unixobjectNoUnix timestamp (in seconds) to filter conversations up to this start date.
call_start_after_unixobjectNoUnix timestamp (in seconds) to filter conversations after to this start date.
call_duration_min_secsobjectNoMinimum call duration in seconds.
call_duration_max_secsobjectNoMaximum call duration in seconds.
rating_maxobjectNoMaximum overall rating (1-5).
rating_minobjectNoMinimum overall rating (1-5).
has_feedback_commentobjectNoFilter conversations with user feedback comments.
user_idobjectNoFilter conversations by the user ID who initiated them.
evaluation_paramsobjectNoEvaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success
data_collection_paramsobjectNoData collection filters. Repeat param. Format: id:op:value where op is one of eq|neq|gt|gte|lt|lte|in|exists|missing. For in, pipe-delimit values.
tool_namesobjectNoFilter conversations by tool names used during the call.
tool_names_successfulobjectNoFilter conversations by tool names that had successful calls.
tool_names_erroredobjectNoFilter conversations by tool names that had errored calls.
main_languagesobjectNoFilter conversations by detected main language (language code).
page_sizeintegerNoHow many conversations to return at maximum. Can not exceed 100, defaults to 30.
summary_modestringNoWhether to include transcript summaries in the response.
searchobjectNoFull-text or fuzzy search over transcript messages
conversation_initiation_sourceobjectNoConversation Initiation Source
branch_idobjectNoFilter conversations by branch ID.

elevenlabs_agents_get_conversation_history_route

Get Conversation Details Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesThe id of the conversation you’re taking the action on.

elevenlabs_agents_get_documentation_from_knowledge_base

Get Documentation From Knowledge Base Parameters:
ParameterTypeRequiredDefaultDescription
documentation_idstringYesThe id of a document from the knowledge base. This is returned on document addition.
agent_idstringNoAgent Id

elevenlabs_agents_get_knowledge_base_list_route

Get Knowledge Base List Parameters:
ParameterTypeRequiredDefaultDescription
page_sizeintegerNoHow many documents to return at maximum. Can not exceed 100, defaults to 30.
searchobjectNoIf specified, the endpoint returns only such knowledge base documents whose names start with this string.
show_only_owned_documentsbooleanNoIf set to true, the endpoint will return only documents owned by you (and not shared from somebody else). Deprecated: use created_by_user_id instead.
created_by_user_idobjectNoFilter documents by creator user ID. When set, only documents created by this user are returned. Takes precedence over show_only_owned_documents. Use ‘@me’ to refer to the authenticated user.
typesobjectNoIf present, the endpoint will return only documents of the given types.
parent_folder_idobjectNoIf set, the endpoint will return only documents that are direct children of the given folder.
ancestor_folder_idobjectNoIf set, the endpoint will return only documents that are descendants of the given folder.
folders_firstbooleanNoWhether folders should be returned first in the list of documents.
sort_directionstringNoThe direction to sort the results
sort_byobjectNoThe field to sort the results by
cursorobjectNoUsed for fetching next page. Cursor is returned in the response.

elevenlabs_agents_get_phone_number_route

Get Phone Number Parameters:
ParameterTypeRequiredDefaultDescription
phone_number_idstringYesThe id of an agent. This is returned on agent creation.

elevenlabs_agents_list_phone_numbers_route

List Phone Numbers

elevenlabs_agents_patch_agent_settings_route

Patches An Agent Settings Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesThe id of an agent. This is returned on agent creation.
enable_versioning_if_not_enabledbooleanNoEnable versioning for the agent, if not already enabled
branch_idobjectNoThe ID of the branch to use
conversation_configobjectNoConversation configuration for an agent
nameobjectNoA name to make the agent easier to find
platform_settingsobjectNoPlatform settings for the agent are all settings that aren’t related to the conversation orchestration and content.
tagsobjectNoTags to help classify and filter the agent
version_descriptionobjectNoDescription for this version when publishing changes (only applicable for versioned agents)
workflowobjectNoThe workflow value

elevenlabs_agents_post_conversation_feedback_route

Send Conversation Feedback Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesThe id of the conversation you’re taking the action on.
feedbackobjectNoEither ‘like’ or ‘dislike’ to indicate the feedback for the conversation.

elevenlabs_agents_run_conversation_analysis

Run Conversation Analysis Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesID of the conversation

elevenlabs_agents_text_search_conversation_messages_route

Text Search Conversation Messages Parameters:
ParameterTypeRequiredDefaultDescription
text_querystringYesThe search query text for full-text and fuzzy matching
agent_idobjectNoThe id of the agent you’re taking the action on.
call_successfulobjectNoThe result of the success evaluation
call_start_before_unixobjectNoUnix timestamp (in seconds) to filter conversations up to this start date.
call_start_after_unixobjectNoUnix timestamp (in seconds) to filter conversations after to this start date.
call_duration_min_secsobjectNoMinimum call duration in seconds.
call_duration_max_secsobjectNoMaximum call duration in seconds.
rating_maxobjectNoMaximum overall rating (1-5).
rating_minobjectNoMinimum overall rating (1-5).
has_feedback_commentobjectNoFilter conversations with user feedback comments.
user_idobjectNoFilter conversations by the user ID who initiated them.
evaluation_paramsobjectNoEvaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success
data_collection_paramsobjectNoData collection filters. Repeat param. Format: id:op:value where op is one of eq|neq|gt|gte|lt|lte|in|exists|missing. For in, pipe-delimit values.
tool_namesobjectNoFilter conversations by tool names used during the call.
tool_names_successfulobjectNoFilter conversations by tool names that had successful calls.
tool_names_erroredobjectNoFilter conversations by tool names that had errored calls.
main_languagesobjectNoFilter conversations by detected main language (language code).
page_sizeintegerNoNumber of results per page. Max 50.
summary_modestringNoWhether to include transcript summaries in the response.
conversation_initiation_sourceobjectNoConversation Initiation Source
branch_idobjectNoFilter conversations by branch ID.
sort_bystringNoSort order for search results. ‘search_score’ sorts by search score, ‘created_at’ sorts by conversation start time.
cursorobjectNoUsed for fetching next page. Cursor is returned in the response.