Get tool

GET

/v1/convai/tools/:tool_id

GET

/v1/convai/tools/:tool_id

$ curl -G https://api.elevenlabs.io/v1/convai/tools/tool_id \
>      -d environment=environment

1 {
2   "id": "id",
3   "tool_config": {
4     "type": "client",
5     "description": "description",
6     "name": "name",
7     "assignments": [
8       {
9         "dynamic_variable": "user_name",
10         "value_path": "user.name",
11         "source": "response",
12         "sanitize": false,
13         "preserve_native_type": false
14       }
15     ],
16     "dynamic_variables": {
17       "dynamic_variable_placeholders": {
18         "user_name": "John Doe"
19       }
20     },
21     "execution_mode": "immediate",
22     "expects_response": false,
23     "interruption_mode": "allow",
24     "parameters": {
25       "type": "object",
26       "required": [
27         "required"
28       ],
29       "description": "description",
30       "properties": {
31         "key": {
32           "description": "A user-provided message",
33           "type": "string"
34         }
35       }
36     },
37     "pre_tool_speech": "auto",
38     "response_timeout_secs": 1,
39     "tool_call_sound": "typing",
40     "tool_call_sound_behavior": "auto",
41     "tool_error_handling_mode": "auto"
42   },
43   "access_info": {
44     "is_creator": true,
45     "creator_name": "John Doe",
46     "creator_email": "john.doe@example.com",
47     "role": "admin",
48     "anonymous_access_level_override": "admin",
49     "access_source": "creator"
50   },
51   "usage_stats": {
52     "avg_latency_secs": 1.1,
53     "total_calls": 1
54   },
55   "response_mocks": [
56     {
57       "mock_result": "mock_result",
58       "parameter_conditions": [
59         {
60           "eval": {
61             "type": "anything"
62           },
63           "path": "path"
64         }
65       ]
66     }
67   ]
68 }

Get tool that is available in the workspace.

Path parameters

tool_idstringRequired

ID of the requested tool.

Query parameters

environmentstringOptionalDefaults to production

Environment whose values are used when the MCP server URL, headers, or auth connection reference environment variables. Mirrors the environment a conversation would run in; defaults to production.

Response

Successful Response

idstring

tool_configobject

The type of tool

access_infoobject

usage_statsobject

response_mockslist of objects

Mock responses with optional parameter conditions. Evaluated top-to-bottom; first match wins.

Errors

422

Tools Get Request Unprocessable Entity Error

Path parameters

Headers

Query parameters

Response

Errors