Update Tool

Update an existing tool’s configuration.

HTTP Request

$ PATCH https://app.resemble.ai/api/v2/agents/{agent_uuid}/tools/{id}

URL Parameters

Parameter	Type	Description
agent_uuid	string	The agent’s UUID
id	integer	The tool ID

Request Body

All fields are optional for webhook and client tools. Only provide the fields you want to update.

System Tools: Only active, disable_interruptions, and force_pre_tool_speech can be updated in the tool_config.

Attribute	Type	Description
name	string	Update tool name
description	string	Update description
tool_config	object	Update configuration
active	boolean	Enable/disable tool

Example Request - Update Webhook Tool

$ curl --request PATCH "https://app.resemble.ai/api/v2/agents/550e8400-e29b-41d4-a716-446655440000/tools/1" \
>   -H "Authorization: Bearer YOUR_API_TOKEN" \
>   -H "Content-Type: application/json" \
>   --data '{
>     "description": "Updated weather checking tool",
>     "tool_config": {
>       "api_schema": {
>         "url": "https://api.weather.com/v2/check?location={{location}}",
>         "method": "GET"
>       },
>       "response_timeout_secs": 45
>     }
>   }'

Example Request - Update System Tool

$ curl --request PATCH "https://app.resemble.ai/api/v2/agents/550e8400-e29b-41d4-a716-446655440000/tools/2" \
>   -H "Authorization: Bearer YOUR_API_TOKEN" \
>   -H "Content-Type: application/json" \
>   --data '{
>     "active": false,
>     "tool_config": {
>       "disable_interruptions": true
>     }
>   }'

Response (Success)

1 {
2   "success": true,
3   "item": {
4     "id": 1,
5     "name": "check_weather",
6     "description": "Updated weather checking tool",
7     "tool_type": "webhook",
8     "tool_config": {
9       "api_schema": {
10         "url": "https://api.weather.com/v2/check?location={{location}}",
11         "method": "GET"
12       },
13       "parameters": {},
14       "assignments": [],
15       "response_timeout_secs": 45
16     },
17     "active": true,
18     "created_at": "2025-01-27T10:00:00Z",
19     "updated_at": "2025-01-27T10:30:00Z"
20   },
21   "message": "Tool updated successfully"
22 }

Response (Error)

1 {
2   "success": false,
3   "errors": {
4     "tool_config": [
5       "api_schema.method must be one of: GET, POST, PUT, PATCH, DELETE"
6     ]
7   },
8   "message": "Failed to update tool"
9 }

HTTP Request

$ PATCH https://app.resemble.ai/api/v2/agents/{agent_uuid}/tools/{id}

URL Parameters

Parameter	Type	Description
agent_uuid	string	The agent’s UUID
id	integer	The tool ID

Request Body

All fields are optional for webhook and client tools. Only provide the fields you want to update.

System Tools: Only active, disable_interruptions, and force_pre_tool_speech can be updated in the tool_config.

Attribute	Type	Description
name	string	Update tool name
description	string	Update description
tool_config	object	Update configuration
active	boolean	Enable/disable tool

Example Request - Update Webhook Tool

$ curl --request PATCH "https://app.resemble.ai/api/v2/agents/550e8400-e29b-41d4-a716-446655440000/tools/1" \
>   -H "Authorization: Bearer YOUR_API_TOKEN" \
>   -H "Content-Type: application/json" \
>   --data '{
>     "description": "Updated weather checking tool",
>     "tool_config": {
>       "api_schema": {
>         "url": "https://api.weather.com/v2/check?location={{location}}",
>         "method": "GET"
>       },
>       "response_timeout_secs": 45
>     }
>   }'

Example Request - Update System Tool

$ curl --request PATCH "https://app.resemble.ai/api/v2/agents/550e8400-e29b-41d4-a716-446655440000/tools/2" \
>   -H "Authorization: Bearer YOUR_API_TOKEN" \
>   -H "Content-Type: application/json" \
>   --data '{
>     "active": false,
>     "tool_config": {
>       "disable_interruptions": true
>     }
>   }'

Response (Success)

1 {
2   "success": true,
3   "item": {
4     "id": 1,
5     "name": "check_weather",
6     "description": "Updated weather checking tool",
7     "tool_type": "webhook",
8     "tool_config": {
9       "api_schema": {
10         "url": "https://api.weather.com/v2/check?location={{location}}",
11         "method": "GET"
12       },
13       "parameters": {},
14       "assignments": [],
15       "response_timeout_secs": 45
16     },
17     "active": true,
18     "created_at": "2025-01-27T10:00:00Z",
19     "updated_at": "2025-01-27T10:30:00Z"
20   },
21   "message": "Tool updated successfully"
22 }

Response (Error)

1 {
2   "success": false,
3   "errors": {
4     "tool_config": [
5       "api_schema.method must be one of: GET, POST, PUT, PATCH, DELETE"
6     ]
7   },
8   "message": "Failed to update tool"
9 }

Update Tool

Update Tool

HTTP Request

URL Parameters

Request Body

Example Request - Update Webhook Tool

Example Request - Update System Tool

Response (Success)

Response (Error)

See Also

HTTP Request

URL Parameters

Request Body

Example Request - Update Webhook Tool

Example Request - Update System Tool

Response (Success)

Response (Error)

See Also

$	curl --request PATCH "https://app.resemble.ai/api/v2/agents/550e8400-e29b-41d4-a716-446655440000/tools/1" \
>	-H "Authorization: Bearer YOUR_API_TOKEN" \
>	-H "Content-Type: application/json" \
>	--data '{
>	"description": "Updated weather checking tool",
>	"tool_config": {
>	"api_schema": {
>	"url": "https://api.weather.com/v2/check?location={{location}}",
>	"method": "GET"
>	},
>	"response_timeout_secs": 45
>	}
>	}'

1	{
2	"success": true,
3	"item": {
4	"id": 1,
5	"name": "check_weather",
6	"description": "Updated weather checking tool",
7	"tool_type": "webhook",
8	"tool_config": {
9	"api_schema": {
10	"url": "https://api.weather.com/v2/check?location={{location}}",
11	"method": "GET"
12	},
13	"parameters": {},
14	"assignments": [],
15	"response_timeout_secs": 45
16	},
17	"active": true,
18	"created_at": "2025-01-27T10:00:00Z",
19	"updated_at": "2025-01-27T10:30:00Z"
20	},
21	"message": "Tool updated successfully"
22	}

1	{
2	"success": false,
3	"errors": {
4	"tool_config": [
5	"api_schema.method must be one of: GET, POST, PUT, PATCH, DELETE"
6	]
7	},
8	"message": "Failed to update tool"
9	}