Get tool

GET

/v1/convai/tools/:tool_id

GET

/v1/convai/tools/:tool_id

1 curl https://api.elevenlabs.io/v1/convai/tools/tool_id

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       }
14     ],
15     "disable_interruptions": true,
16     "dynamic_variables": {
17       "dynamic_variable_placeholders": {
18         "user_name": "John Doe"
19       }
20     },
21     "execution_mode": "immediate",
22     "expects_response": false,
23     "force_pre_tool_speech": true,
24     "parameters": {
25       "type": "object",
26       "required": [
27         "required"
28       ],
29       "description": "description",
30       "properties": {
31         "key": {
32           "type": "string",
33           "description": "A user-provided message"
34         }
35       }
36     },
37     "response_timeout_secs": 1,
38     "tool_call_sound": "typing",
39     "tool_call_sound_behavior": "auto",
40     "tool_error_handling_mode": "auto"
41   },
42   "access_info": {
43     "is_creator": true,
44     "creator_name": "John Doe",
45     "creator_email": "john.doe@example.com",
46     "role": "admin"
47   },
48   "usage_stats": {
49     "avg_latency_secs": 1.1,
50     "total_calls": 1
51   },
52   "response_mocks": [
53     {
54       "mock_result": "mock_result",
55       "parameter_conditions": [
56         {
57           "eval": {
58             "type": "anything"
59           },
60           "path": "path"
61         }
62       ]
63     }
64   ]
65 }

Get tool that is available in the workspace.

Path parameters

tool_idstringRequired

ID of the requested tool.

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

Response

Errors