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

200Successful

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 }

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

Create tool

Headers

Request

Response

Errors