Get tool

GET

/v1/convai/tools/:tool_id

GET

/v1/convai/tools/:tool_id

1 from elevenlabs import ElevenLabs
2 
3 client = ElevenLabs(
4     api_key="YOUR_API_KEY",
5 )
6 client.conversational_ai.tools.get(
7     tool_id="tool_id",
8 )

Try it

200Retrieved

1 {
2   "id": "foo",
3   "tool_config": {
4     "name": "foo",
5     "description": "foo",
6     "response_timeout_secs": 20,
7     "type": "webhook",
8     "api_schema": {
9       "url": "foo",
10       "method": "GET",
11       "path_params_schema": {},
12       "query_params_schema": {
13         "properties": {},
14         "required": [
15           "foo"
16         ]
17       },
18       "request_body_schema": {
19         "type": "object",
20         "required": [
21           "foo"
22         ],
23         "description": "",
24         "properties": {}
25       },
26       "request_headers": {}
27     },
28     "dynamic_variables": {
29       "dynamic_variable_placeholders": {}
30     }
31   },
32   "access_info": {
33     "is_creator": true,
34     "creator_name": "foo",
35     "creator_email": "foo",
36     "role": "admin"
37   }
38 }

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

Get tool

Path parameters

Headers

Response

Errors