> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# elevenlabs-agents
> ElevenLabs Agents - create and manage conversational AI agents, conversations, and knowledge bases
**Server path:** `/elevenlabs-agents` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
| [`elevenlabs_agents_create_agent_route`](#elevenlabs_agents_create_agent_route) | Create Agent |
| [`elevenlabs_agents_create_phone_number_route`](#elevenlabs_agents_create_phone_number_route) | Import Phone Number |
| [`elevenlabs_agents_create_text_document_route`](#elevenlabs_agents_create_text_document_route) | Create Text Document |
| [`elevenlabs_agents_delete_agent_route`](#elevenlabs_agents_delete_agent_route) | Delete Agent |
| [`elevenlabs_agents_delete_conversation_route`](#elevenlabs_agents_delete_conversation_route) | Delete Conversation |
| [`elevenlabs_agents_delete_knowledge_base_document`](#elevenlabs_agents_delete_knowledge_base_document) | Delete Knowledge Base Document Or Folder |
| [`elevenlabs_agents_delete_phone_number_route`](#elevenlabs_agents_delete_phone_number_route) | Delete Phone Number |
| [`elevenlabs_agents_duplicate_agent_route`](#elevenlabs_agents_duplicate_agent_route) | Duplicate Agent |
| [`elevenlabs_agents_get_agent_link_route`](#elevenlabs_agents_get_agent_link_route) | Get Shareable Agent Link |
| [`elevenlabs_agents_get_agent_route`](#elevenlabs_agents_get_agent_route) | Get Agent |
| [`elevenlabs_agents_get_agent_summaries_route`](#elevenlabs_agents_get_agent_summaries_route) | Get Agent Summaries |
| [`elevenlabs_agents_get_agent_widget_route`](#elevenlabs_agents_get_agent_widget_route) | Get Agent Widget Config |
| [`elevenlabs_agents_get_agents_route`](#elevenlabs_agents_get_agents_route) | List Agents |
| [`elevenlabs_agents_get_conversation_audio_route`](#elevenlabs_agents_get_conversation_audio_route) | Get Conversation Audio |
| [`elevenlabs_agents_get_conversation_histories_route`](#elevenlabs_agents_get_conversation_histories_route) | Get Conversations |
| [`elevenlabs_agents_get_conversation_history_route`](#elevenlabs_agents_get_conversation_history_route) | Get Conversation Details |
| [`elevenlabs_agents_get_documentation_from_knowledge_base`](#elevenlabs_agents_get_documentation_from_knowledge_base) | Get Documentation From Knowledge Base |
| [`elevenlabs_agents_get_knowledge_base_list_route`](#elevenlabs_agents_get_knowledge_base_list_route) | Get Knowledge Base List |
| [`elevenlabs_agents_get_phone_number_route`](#elevenlabs_agents_get_phone_number_route) | Get Phone Number |
| [`elevenlabs_agents_list_phone_numbers_route`](#elevenlabs_agents_list_phone_numbers_route) | List Phone Numbers |
| [`elevenlabs_agents_patch_agent_settings_route`](#elevenlabs_agents_patch_agent_settings_route) | Patches An Agent Settings |
| [`elevenlabs_agents_post_conversation_feedback_route`](#elevenlabs_agents_post_conversation_feedback_route) | Send Conversation Feedback |
| [`elevenlabs_agents_run_conversation_analysis`](#elevenlabs_agents_run_conversation_analysis) | Run Conversation Analysis |
| [`elevenlabs_agents_text_search_conversation_messages_route`](#elevenlabs_agents_text_search_conversation_messages_route) | Text Search Conversation Messages |
***
## elevenlabs\_agents\_create\_agent\_route
Create Agent
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
| `enable_versioning` | boolean | No | — | Enable versioning for the agent |
| `conversation_config` | object | Yes | — | Conversation Config |
| `name` | string | No | — | A name to make the agent easier to find |
| `platform_settings` | object | No | — | Platform settings for the agent are all settings that aren't related to the conversation orchestration and content. |
| `tags` | string\[] | No | — | Tags to help classify and filter the agent |
| `workflow` | object | No | — | The workflow value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"enable_versioning": {
"type": "boolean",
"description": "Enable versioning for the agent"
},
"conversation_config": {
"type": "object",
"description": "Conversation Config",
"properties": {
"asr": {
"type": "object",
"description": "The asr value"
},
"turn": {
"type": "object",
"description": "The turn value"
},
"tts": {
"type": "object",
"description": "The tts value"
},
"conversation": {
"type": "object",
"description": "The conversation value"
},
"language_presets": {
"type": "object",
"description": "Language presets for conversations"
},
"vad": {
"type": "object",
"description": "The vad value"
},
"agent": {
"type": "object",
"description": "The agent value"
}
}
},
"name": {
"type": "string",
"description": "A name to make the agent easier to find"
},
"platform_settings": {
"type": "object",
"description": "Platform settings for the agent are all settings that aren't related to the conversation orchestration and content.",
"properties": {
"evaluation": {
"type": "object",
"description": "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 criteria."
},
"widget": {
"type": "object",
"description": "The widget value"
},
"data_collection": {
"type": "object",
"description": "Data collection settings"
},
"data_collection_scopes": {
"type": "object",
"description": "Scope per data collection item ID. Missing keys default to conversation scope."
},
"overrides": {
"type": "object",
"description": "The overrides value"
},
"workspace_overrides": {
"type": "object",
"description": "Workspace Overrides"
},
"testing": {
"type": "object",
"description": "Settings for agent testing configuration."
},
"archived": {
"type": "boolean",
"description": "Whether the agent is archived"
},
"guardrails": {
"type": "object",
"description": "The guardrails value"
},
"summary_language": {
"type": "string",
"description": "Language for all conversation analysis outputs (summaries, titles, evaluation rationales, data collection rationales). If not set, the language will be inferred from the conversation. Must be one of the supported conversation languages."
},
"auth": {
"type": "object",
"description": "The auth value"
},
"call_limits": {
"type": "object",
"description": "Call Limits"
},
"privacy": {
"type": "object",
"description": "The privacy value"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to help classify and filter the agent"
},
"workflow": {
"type": "object",
"description": "The workflow value",
"properties": {
"edges": {
"type": "object",
"description": "The edges value"
},
"nodes": {
"type": "object",
"description": "The nodes value"
},
"prevent_subagent_loops": {
"type": "boolean",
"description": "Whether to prevent loops in the workflow execution."
}
}
}
},
"required": [
"PCID",
"conversation_config"
]
}
```
***
## elevenlabs\_agents\_create\_phone\_number\_route
Import Phone Number
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------- |
| `body` | object | Yes | — | Create Phone Request Information |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"description": "Create Phone Request Information"
}
},
"required": [
"PCID",
"body"
]
}
```
***
## elevenlabs\_agents\_create\_text\_document\_route
Create Text Document
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------ |
| `name` | string | No | — | A custom, human-readable name for the document. |
| `parent_folder_id` | string | No | — | If set, the created document or folder will be placed inside the given folder. |
| `text` | string | Yes | — | Text content to be added to the knowledge base. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "A custom, human-readable name for the document."
},
"parent_folder_id": {
"type": "string",
"description": "If set, the created document or folder will be placed inside the given folder."
},
"text": {
"type": "string",
"description": "Text content to be added to the knowledge base."
}
},
"required": [
"PCID",
"text"
]
}
```
***
## elevenlabs\_agents\_delete\_agent\_route
Delete Agent
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------- |
| `agent_id` | string | Yes | — | The id of an agent. This is returned on agent creation. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agent_id": {
"type": "string",
"description": "The id of an agent. This is returned on agent creation."
}
},
"required": [
"PCID",
"agent_id"
]
}
```
***
## elevenlabs\_agents\_delete\_conversation\_route
Delete Conversation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------- |
| `conversation_id` | string | Yes | — | The id of the conversation you're taking the action on. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversation_id": {
"type": "string",
"description": "The id of the conversation you're taking the action on."
}
},
"required": [
"PCID",
"conversation_id"
]
}
```
***
## elevenlabs\_agents\_delete\_knowledge\_base\_document
Delete Knowledge Base Document Or Folder
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `documentation_id` | string | Yes | — | The id of a document from the knowledge base. This is returned on document addition. |
| `force` | boolean | No | — | If 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentation_id": {
"type": "string",
"description": "The id of a document from the knowledge base. This is returned on document addition."
},
"force": {
"type": "boolean",
"description": "If 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."
}
},
"required": [
"PCID",
"documentation_id"
]
}
```
***
## elevenlabs\_agents\_delete\_phone\_number\_route
Delete Phone Number
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------- |
| `phone_number_id` | string | Yes | — | The id of an agent. This is returned on agent creation. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"phone_number_id": {
"type": "string",
"description": "The id of an agent. This is returned on agent creation."
}
},
"required": [
"PCID",
"phone_number_id"
]
}
```
***
## elevenlabs\_agents\_duplicate\_agent\_route
Duplicate Agent
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------- |
| `agent_id` | string | Yes | — | The id of an agent. This is returned on agent creation. |
| `name` | string | No | — | A name to make the agent easier to find |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agent_id": {
"type": "string",
"description": "The id of an agent. This is returned on agent creation."
},
"name": {
"type": "string",
"description": "A name to make the agent easier to find"
}
},
"required": [
"PCID",
"agent_id"
]
}
```
***
## elevenlabs\_agents\_get\_agent\_link\_route
Get Shareable Agent Link
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------- |
| `agent_id` | string | Yes | — | The id of an agent. This is returned on agent creation. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agent_id": {
"type": "string",
"description": "The id of an agent. This is returned on agent creation."
}
},
"required": [
"PCID",
"agent_id"
]
}
```
***
## elevenlabs\_agents\_get\_agent\_route
Get Agent
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------------------------------------------------- |
| `agent_id` | string | Yes | — | The id of an agent. This is returned on agent creation. |
| `version_id` | string | No | — | The ID of the agent version to use |
| `branch_id` | string | No | — | The ID of the branch to use |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agent_id": {
"type": "string",
"description": "The id of an agent. This is returned on agent creation."
},
"version_id": {
"type": "string",
"description": "The ID of the agent version to use"
},
"branch_id": {
"type": "string",
"description": "The ID of the branch to use"
}
},
"required": [
"PCID",
"agent_id"
]
}
```
***
## elevenlabs\_agents\_get\_agent\_summaries\_route
Get Agent Summaries
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | --------- | -------- | ------- | ---------------------------------------- |
| `agent_ids` | string\[] | Yes | — | List of agent IDs to fetch summaries for |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agent_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of agent IDs to fetch summaries for"
}
},
"required": [
"PCID",
"agent_ids"
]
}
```
***
## elevenlabs\_agents\_get\_agent\_widget\_route
Get Agent Widget Config
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `agent_id` | string | Yes | — | The id of an agent. This is returned on agent creation. |
| `conversation_signature` | string | No | — | An 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agent_id": {
"type": "string",
"description": "The id of an agent. This is returned on agent creation."
},
"conversation_signature": {
"type": "string",
"description": "An 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"
}
},
"required": [
"PCID",
"agent_id"
]
}
```
***
## elevenlabs\_agents\_get\_agents\_route
List Agents
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page_size` | integer | No | — | How many Agents to return at maximum. Can not exceed 100, defaults to 30. |
| `search` | string | No | — | Search by agents name. |
| `archived` | boolean | No | — | Filter agents by archived status |
| `show_only_owned_agents` | boolean | No | — | If 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_id` | string | No | — | Filter 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_direction` | string | No | — | The direction to sort the results |
| `sort_by` | string | No | — | The field to sort the results by |
| `cursor` | string | No | — | Used for fetching next page. Cursor is returned in the response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page_size": {
"type": "integer",
"description": "How many Agents to return at maximum. Can not exceed 100, defaults to 30."
},
"search": {
"type": "string",
"description": "Search by agents name."
},
"archived": {
"type": "boolean",
"description": "Filter agents by archived status"
},
"show_only_owned_agents": {
"type": "boolean",
"description": "If 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_id": {
"type": "string",
"description": "Filter 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_direction": {
"type": "string",
"description": "The direction to sort the results",
"enum": [
"asc",
"desc"
]
},
"sort_by": {
"type": "string",
"description": "The field to sort the results by",
"enum": [
"name",
"created_at",
"call_count_7d"
]
},
"cursor": {
"type": "string",
"description": "Used for fetching next page. Cursor is returned in the response."
}
},
"required": [
"PCID"
]
}
```
***
## elevenlabs\_agents\_get\_conversation\_audio\_route
Get Conversation Audio
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------- |
| `conversation_id` | string | Yes | — | The id of the conversation you're taking the action on. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversation_id": {
"type": "string",
"description": "The id of the conversation you're taking the action on."
}
},
"required": [
"PCID",
"conversation_id"
]
}
```
***
## elevenlabs\_agents\_get\_conversation\_histories\_route
Get Conversations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | Used for fetching next page. Cursor is returned in the response. |
| `agent_id` | string | No | — | The id of the agent you're taking the action on. |
| `call_successful` | string | No | — | The result of the success evaluation |
| `call_start_before_unix` | integer | No | — | Unix timestamp (in seconds) to filter conversations up to this start date. |
| `call_start_after_unix` | integer | No | — | Unix timestamp (in seconds) to filter conversations after to this start date. |
| `call_duration_min_secs` | integer | No | — | Minimum call duration in seconds. |
| `call_duration_max_secs` | integer | No | — | Maximum call duration in seconds. |
| `rating_max` | integer | No | — | Maximum overall rating (1-5). |
| `rating_min` | integer | No | — | Minimum overall rating (1-5). |
| `has_feedback_comment` | boolean | No | — | Filter conversations with user feedback comments. |
| `user_id` | string | No | — | Filter conversations by the user ID who initiated them. |
| `evaluation_params` | string\[] | No | — | Evaluation filters. Repeat param. Format: criteria\_id:result. Example: eval=value\_framing:success |
| `data_collection_params` | string\[] | No | — | Data 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_names` | string\[] | No | — | Filter conversations by tool names used during the call. |
| `tool_names_successful` | string\[] | No | — | Filter conversations by tool names that had successful calls. |
| `tool_names_errored` | string\[] | No | — | Filter conversations by tool names that had errored calls. |
| `main_languages` | string\[] | No | — | Filter conversations by detected main language (language code). |
| `page_size` | integer | No | — | How many conversations to return at maximum. Can not exceed 100, defaults to 30. |
| `summary_mode` | string | No | — | Whether to include transcript summaries in the response. |
| `search` | string | No | — | Full-text or fuzzy search over transcript messages |
| `conversation_initiation_source` | string | No | — | Enum representing the possible sources for conversation initiation. |
| `branch_id` | string | No | — | Filter conversations by branch ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "Used for fetching next page. Cursor is returned in the response."
},
"agent_id": {
"type": "string",
"description": "The id of the agent you're taking the action on."
},
"call_successful": {
"type": "string",
"description": "The result of the success evaluation",
"enum": [
"success",
"failure",
"unknown"
]
},
"call_start_before_unix": {
"type": "integer",
"description": "Unix timestamp (in seconds) to filter conversations up to this start date."
},
"call_start_after_unix": {
"type": "integer",
"description": "Unix timestamp (in seconds) to filter conversations after to this start date."
},
"call_duration_min_secs": {
"type": "integer",
"description": "Minimum call duration in seconds."
},
"call_duration_max_secs": {
"type": "integer",
"description": "Maximum call duration in seconds."
},
"rating_max": {
"type": "integer",
"description": "Maximum overall rating (1-5)."
},
"rating_min": {
"type": "integer",
"description": "Minimum overall rating (1-5)."
},
"has_feedback_comment": {
"type": "boolean",
"description": "Filter conversations with user feedback comments."
},
"user_id": {
"type": "string",
"description": "Filter conversations by the user ID who initiated them."
},
"evaluation_params": {
"type": "array",
"items": {
"type": "string"
},
"description": "Evaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success"
},
"data_collection_params": {
"type": "array",
"items": {
"type": "string"
},
"description": "Data 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_names": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter conversations by tool names used during the call."
},
"tool_names_successful": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter conversations by tool names that had successful calls."
},
"tool_names_errored": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter conversations by tool names that had errored calls."
},
"main_languages": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter conversations by detected main language (language code)."
},
"page_size": {
"type": "integer",
"description": "How many conversations to return at maximum. Can not exceed 100, defaults to 30."
},
"summary_mode": {
"type": "string",
"description": "Whether to include transcript summaries in the response.",
"enum": [
"exclude",
"include"
]
},
"search": {
"type": "string",
"description": "Full-text or fuzzy search over transcript messages"
},
"conversation_initiation_source": {
"type": "string",
"description": "Enum representing the possible sources for conversation initiation.",
"enum": [
"unknown",
"android_sdk",
"node_js_sdk",
"react_native_sdk",
"react_sdk",
"js_sdk",
"python_sdk",
"widget",
"sip_trunk",
"twilio",
"genesys",
"swift_sdk",
"whatsapp",
"flutter_sdk",
"zendesk_integration",
"slack_integration",
"template_preview"
]
},
"branch_id": {
"type": "string",
"description": "Filter conversations by branch ID."
}
},
"required": [
"PCID"
]
}
```
***
## elevenlabs\_agents\_get\_conversation\_history\_route
Get Conversation Details
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------- |
| `conversation_id` | string | Yes | — | The id of the conversation you're taking the action on. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversation_id": {
"type": "string",
"description": "The id of the conversation you're taking the action on."
}
},
"required": [
"PCID",
"conversation_id"
]
}
```
***
## elevenlabs\_agents\_get\_documentation\_from\_knowledge\_base
Get Documentation From Knowledge Base
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------ |
| `documentation_id` | string | Yes | — | The id of a document from the knowledge base. This is returned on document addition. |
| `agent_id` | string | No | — | Agent Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"documentation_id": {
"type": "string",
"description": "The id of a document from the knowledge base. This is returned on document addition."
},
"agent_id": {
"type": "string",
"description": "Agent Id"
}
},
"required": [
"PCID",
"documentation_id"
]
}
```
***
## elevenlabs\_agents\_get\_knowledge\_base\_list\_route
Get Knowledge Base List
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page_size` | integer | No | — | How many documents to return at maximum. Can not exceed 100, defaults to 30. |
| `search` | string | No | — | If specified, the endpoint returns only such knowledge base documents whose names start with this string. |
| `show_only_owned_documents` | boolean | No | — | If 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_id` | string | No | — | Filter 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. |
| `types` | string\[] | No | — | If present, the endpoint will return only documents of the given types. |
| `parent_folder_id` | string | No | — | If set, the endpoint will return only documents that are direct children of the given folder. |
| `ancestor_folder_id` | string | No | — | If set, the endpoint will return only documents that are descendants of the given folder. |
| `folders_first` | boolean | No | — | Whether folders should be returned first in the list of documents. |
| `sort_direction` | string | No | — | The direction to sort the results |
| `sort_by` | string | No | — | The field to sort the results by |
| `cursor` | string | No | — | Used for fetching next page. Cursor is returned in the response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page_size": {
"type": "integer",
"description": "How many documents to return at maximum. Can not exceed 100, defaults to 30."
},
"search": {
"type": "string",
"description": "If specified, the endpoint returns only such knowledge base documents whose names start with this string."
},
"show_only_owned_documents": {
"type": "boolean",
"description": "If 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_id": {
"type": "string",
"description": "Filter 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."
},
"types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"file",
"url",
"text",
"folder"
]
},
"description": "If present, the endpoint will return only documents of the given types."
},
"parent_folder_id": {
"type": "string",
"description": "If set, the endpoint will return only documents that are direct children of the given folder."
},
"ancestor_folder_id": {
"type": "string",
"description": "If set, the endpoint will return only documents that are descendants of the given folder."
},
"folders_first": {
"type": "boolean",
"description": "Whether folders should be returned first in the list of documents."
},
"sort_direction": {
"type": "string",
"description": "The direction to sort the results",
"enum": [
"asc",
"desc"
]
},
"sort_by": {
"type": "string",
"description": "The field to sort the results by",
"enum": [
"name",
"created_at",
"updated_at",
"size"
]
},
"cursor": {
"type": "string",
"description": "Used for fetching next page. Cursor is returned in the response."
}
},
"required": [
"PCID"
]
}
```
***
## elevenlabs\_agents\_get\_phone\_number\_route
Get Phone Number
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------- |
| `phone_number_id` | string | Yes | — | The id of an agent. This is returned on agent creation. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"phone_number_id": {
"type": "string",
"description": "The id of an agent. This is returned on agent creation."
}
},
"required": [
"PCID",
"phone_number_id"
]
}
```
***
## elevenlabs\_agents\_list\_phone\_numbers\_route
List Phone Numbers
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## elevenlabs\_agents\_patch\_agent\_settings\_route
Patches An Agent Settings
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
| `agent_id` | string | Yes | — | The id of an agent. This is returned on agent creation. |
| `enable_versioning_if_not_enabled` | boolean | No | — | Enable versioning for the agent, if not already enabled |
| `branch_id` | string | No | — | The ID of the branch to use |
| `conversation_config` | object | No | — | Conversation configuration for an agent |
| `name` | string | No | — | A name to make the agent easier to find |
| `platform_settings` | object | No | — | Platform settings for the agent are all settings that aren't related to the conversation orchestration and content. |
| `tags` | string\[] | No | — | Tags to help classify and filter the agent |
| `version_description` | string | No | — | Description for this version when publishing changes (only applicable for versioned agents) |
| `workflow` | object | No | — | The workflow value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agent_id": {
"type": "string",
"description": "The id of an agent. This is returned on agent creation."
},
"enable_versioning_if_not_enabled": {
"type": "boolean",
"description": "Enable versioning for the agent, if not already enabled"
},
"branch_id": {
"type": "string",
"description": "The ID of the branch to use"
},
"conversation_config": {
"type": "object",
"description": "Conversation configuration for an agent"
},
"name": {
"type": "string",
"description": "A name to make the agent easier to find"
},
"platform_settings": {
"type": "object",
"description": "Platform settings for the agent are all settings that aren't related to the conversation orchestration and content."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to help classify and filter the agent"
},
"version_description": {
"type": "string",
"description": "Description for this version when publishing changes (only applicable for versioned agents)"
},
"workflow": {
"type": "object",
"description": "The workflow value",
"properties": {
"edges": {
"type": "object",
"description": "The edges value"
},
"nodes": {
"type": "object",
"description": "The nodes value"
},
"prevent_subagent_loops": {
"type": "boolean",
"description": "Whether to prevent loops in the workflow execution."
}
}
}
},
"required": [
"PCID",
"agent_id"
]
}
```
***
## elevenlabs\_agents\_post\_conversation\_feedback\_route
Send Conversation Feedback
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------- |
| `conversation_id` | string | Yes | — | The id of the conversation you're taking the action on. |
| `feedback` | string | No | — | Either 'like' or 'dislike' to indicate the feedback for the conversation. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversation_id": {
"type": "string",
"description": "The id of the conversation you're taking the action on."
},
"feedback": {
"type": "string",
"description": "Either 'like' or 'dislike' to indicate the feedback for the conversation.",
"enum": [
"like",
"dislike"
]
}
},
"required": [
"PCID",
"conversation_id"
]
}
```
***
## elevenlabs\_agents\_run\_conversation\_analysis
Run Conversation Analysis
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ---------------------- |
| `conversation_id` | string | Yes | — | ID of the conversation |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversation_id": {
"type": "string",
"description": "ID of the conversation"
}
},
"required": [
"PCID",
"conversation_id"
]
}
```
***
## elevenlabs\_agents\_text\_search\_conversation\_messages\_route
Text Search Conversation Messages
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `text_query` | string | Yes | — | The search query text for full-text and fuzzy matching |
| `agent_id` | string | No | — | The id of the agent you're taking the action on. |
| `call_successful` | string | No | — | The result of the success evaluation |
| `call_start_before_unix` | integer | No | — | Unix timestamp (in seconds) to filter conversations up to this start date. |
| `call_start_after_unix` | integer | No | — | Unix timestamp (in seconds) to filter conversations after to this start date. |
| `call_duration_min_secs` | integer | No | — | Minimum call duration in seconds. |
| `call_duration_max_secs` | integer | No | — | Maximum call duration in seconds. |
| `rating_max` | integer | No | — | Maximum overall rating (1-5). |
| `rating_min` | integer | No | — | Minimum overall rating (1-5). |
| `has_feedback_comment` | boolean | No | — | Filter conversations with user feedback comments. |
| `user_id` | string | No | — | Filter conversations by the user ID who initiated them. |
| `evaluation_params` | string\[] | No | — | Evaluation filters. Repeat param. Format: criteria\_id:result. Example: eval=value\_framing:success |
| `data_collection_params` | string\[] | No | — | Data 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_names` | string\[] | No | — | Filter conversations by tool names used during the call. |
| `tool_names_successful` | string\[] | No | — | Filter conversations by tool names that had successful calls. |
| `tool_names_errored` | string\[] | No | — | Filter conversations by tool names that had errored calls. |
| `main_languages` | string\[] | No | — | Filter conversations by detected main language (language code). |
| `page_size` | integer | No | — | Number of results per page. Max 50. |
| `summary_mode` | string | No | — | Whether to include transcript summaries in the response. |
| `conversation_initiation_source` | string | No | — | Enum representing the possible sources for conversation initiation. |
| `branch_id` | string | No | — | Filter conversations by branch ID. |
| `sort_by` | string | No | — | Sort order for search results. 'search\_score' sorts by search score, 'created\_at' sorts by conversation start time. |
| `cursor` | string | No | — | Used for fetching next page. Cursor is returned in the response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"text_query": {
"type": "string",
"description": "The search query text for full-text and fuzzy matching"
},
"agent_id": {
"type": "string",
"description": "The id of the agent you're taking the action on."
},
"call_successful": {
"type": "string",
"description": "The result of the success evaluation",
"enum": [
"success",
"failure",
"unknown"
]
},
"call_start_before_unix": {
"type": "integer",
"description": "Unix timestamp (in seconds) to filter conversations up to this start date."
},
"call_start_after_unix": {
"type": "integer",
"description": "Unix timestamp (in seconds) to filter conversations after to this start date."
},
"call_duration_min_secs": {
"type": "integer",
"description": "Minimum call duration in seconds."
},
"call_duration_max_secs": {
"type": "integer",
"description": "Maximum call duration in seconds."
},
"rating_max": {
"type": "integer",
"description": "Maximum overall rating (1-5)."
},
"rating_min": {
"type": "integer",
"description": "Minimum overall rating (1-5)."
},
"has_feedback_comment": {
"type": "boolean",
"description": "Filter conversations with user feedback comments."
},
"user_id": {
"type": "string",
"description": "Filter conversations by the user ID who initiated them."
},
"evaluation_params": {
"type": "array",
"items": {
"type": "string"
},
"description": "Evaluation filters. Repeat param. Format: criteria_id:result. Example: eval=value_framing:success"
},
"data_collection_params": {
"type": "array",
"items": {
"type": "string"
},
"description": "Data 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_names": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter conversations by tool names used during the call."
},
"tool_names_successful": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter conversations by tool names that had successful calls."
},
"tool_names_errored": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter conversations by tool names that had errored calls."
},
"main_languages": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter conversations by detected main language (language code)."
},
"page_size": {
"type": "integer",
"description": "Number of results per page. Max 50."
},
"summary_mode": {
"type": "string",
"description": "Whether to include transcript summaries in the response.",
"enum": [
"exclude",
"include"
]
},
"conversation_initiation_source": {
"type": "string",
"description": "Enum representing the possible sources for conversation initiation.",
"enum": [
"unknown",
"android_sdk",
"node_js_sdk",
"react_native_sdk",
"react_sdk",
"js_sdk",
"python_sdk",
"widget",
"sip_trunk",
"twilio",
"genesys",
"swift_sdk",
"whatsapp",
"flutter_sdk",
"zendesk_integration",
"slack_integration",
"template_preview"
]
},
"branch_id": {
"type": "string",
"description": "Filter conversations by branch ID."
},
"sort_by": {
"type": "string",
"description": "Sort order for search results. 'search_score' sorts by search score, 'created_at' sorts by conversation start time.",
"enum": [
"search_score",
"created_at"
]
},
"cursor": {
"type": "string",
"description": "Used for fetching next page. Cursor is returned in the response."
}
},
"required": [
"PCID",
"text_query"
]
}
```