Get agent

GET

/v1/convai/agents/:agent_id

GET

/v1/convai/agents/:agent_id

1 curl https://api.elevenlabs.io/v1/convai/agents/agent_id

Try it

200getExample

1 {
2   "agent_id": "J3Pbu5gP6NNKBscdCdwB",
3   "name": "My Agent",
4   "conversation_config": {
5     "asr": {
6       "quality": "high",
7       "provider": "elevenlabs",
8       "user_input_audio_format": "pcm_8000",
9       "keywords": [
10         "foo"
11       ]
12     },
13     "turn": {
14       "turn_timeout": 7,
15       "silence_end_call_timeout": -1,
16       "mode": "silence"
17     },
18     "tts": {
19       "model_id": "eleven_turbo_v2",
20       "voice_id": "cjVigY5qzO86Huf0OWal",
21       "supported_voices": [
22         {
23           "label": "foo",
24           "voice_id": "foo",
25           "description": "foo",
26           "language": "foo",
27           "model_family": "turbo",
28           "optimize_streaming_latency": 0,
29           "stability": 42,
30           "speed": 42,
31           "similarity_boost": 42
32         }
33       ],
34       "agent_output_audio_format": "pcm_8000",
35       "optimize_streaming_latency": 0,
36       "stability": 0.5,
37       "speed": 1,
38       "similarity_boost": 0.8,
39       "pronunciation_dictionary_locators": [
40         {
41           "pronunciation_dictionary_id": "foo",
42           "version_id": "foo"
43         }
44       ]
45     },
46     "conversation": {
47       "text_only": false,
48       "max_duration_seconds": 600,
49       "client_events": [
50         "conversation_initiation_metadata"
51       ]
52     },
53     "language_presets": {},
54     "agent": {
55       "first_message": "",
56       "language": "en",
57       "dynamic_variables": {
58         "dynamic_variable_placeholders": {}
59       },
60       "prompt": {
61         "prompt": "",
62         "llm": "gpt-4o-mini",
63         "temperature": 0,
64         "max_tokens": -1,
65         "tools": [
66           {
67             "id": "",
68             "name": "foo",
69             "description": "foo",
70             "response_timeout_secs": 20,
71             "type": "webhook",
72             "api_schema": {
73               "url": "foo",
74               "method": "GET",
75               "path_params_schema": {},
76               "query_params_schema": {
77                 "properties": {},
78                 "required": [
79                   "foo"
80                 ]
81               },
82               "request_body_schema": {
83                 "type": "object",
84                 "required": [
85                   "foo"
86                 ],
87                 "description": "",
88                 "properties": {}
89               },
90               "request_headers": {}
91             },
92             "dynamic_variables": {
93               "dynamic_variable_placeholders": {}
94             }
95           }
96         ],
97         "tool_ids": [
98           "foo"
99         ],
100         "mcp_server_ids": [
101           "foo"
102         ],
103         "native_mcp_server_ids": [
104           "foo"
105         ],
106         "knowledge_base": [
107           {
108             "type": "file",
109             "name": "foo",
110             "id": "foo",
111             "usage_mode": "prompt"
112           }
113         ],
114         "custom_llm": {
115           "url": "foo",
116           "model_id": "foo",
117           "api_key": {
118             "secret_id": "foo"
119           },
120           "request_headers": {}
121         },
122         "ignore_default_personality": true,
123         "rag": {
124           "enabled": false,
125           "embedding_model": "e5_mistral_7b_instruct",
126           "max_vector_distance": 0.6,
127           "max_documents_length": 50000,
128           "max_retrieved_rag_chunks_count": 20
129         }
130       }
131     }
132   },
133   "metadata": {
134     "created_at_unix_secs": 42
135   }
136 }

Retrieve config for an agent

Path parameters

agent_idstringRequired

The id of an agent. This is returned on agent creation.

Response

Successful Response

agent_idstring

The ID of the agent

namestring

The name of the agent

conversation_configobject

The conversation configuration of the agent

metadataobject

The metadata of the agent

platform_settingsobject or null

The platform settings of the agent

phone_numberslist of objects or null

The phone numbers of the agent

access_infoobject or null

The access information of the agent for the user

tagslist of strings or null

Agent tags used to categorize the agent

Get agent

Path parameters

Headers

Response

Errors