Create tool

POST

/v1/convai/tools

POST

/v1/convai/tools

1 from elevenlabs import (
2     ElevenLabs,
3     ToolRequestModel,
4     ToolRequestModelToolConfig_Client,
5 )
6 
7 client = ElevenLabs(
8     api_key="YOUR_API_KEY",
9 )
10 client.conversational_ai.tools.create(
11     request=ToolRequestModel(
12         tool_config=ToolRequestModelToolConfig_Client(
13             name="name",
14             description="description",
15             expects_response=False,
16         ),
17     ),
18 )

Try it

1 {
2   "id": "foo",
3   "tool_config": {
4     "name": "foo",
5     "description": "foo",
6     "response_timeout_secs": 20,
7     "disable_interruptions": false,
8     "force_pre_tool_speech": false,
9     "assignments": [
10       {
11         "source": "response",
12         "dynamic_variable": "foo",
13         "value_path": "foo"
14       }
15     ],
16     "type": "webhook",
17     "api_schema": {
18       "url": "foo",
19       "method": "GET",
20       "path_params_schema": {},
21       "query_params_schema": {
22         "properties": {},
23         "required": [
24           "foo"
25         ]
26       },
27       "request_body_schema": {
28         "type": "object",
29         "required": [
30           "foo"
31         ],
32         "description": "",
33         "properties": {}
34       },
35       "request_headers": {},
36       "auth_connection": {
37         "auth_connection_id": "foo"
38       }
39     },
40     "dynamic_variables": {
41       "dynamic_variable_placeholders": {}
42     }
43   },
44   "access_info": {
45     "is_creator": true,
46     "creator_name": "foo",
47     "creator_email": "foo",
48     "role": "admin"
49   },
50   "usage_stats": {
51     "avg_latency_secs": 42,
52     "total_calls": 0
53   }
54 }

Add a new tool to the available tools in the workspace.

Request

This endpoint expects an object.

tool_configobjectRequired

Configuration for the tool

Response

Successful Response

idstring

tool_configobject

The type of tool

access_infoobject

usage_statsobject

Create tool

Headers

Request

Response

Errors