Update Tool

PATCH

https://api.speechify.ai/v1/agents/tool-definitions/:id

PATCH

/v1/agents/tool-definitions/:id

$ curl -X PATCH https://api.speechify.ai/v1/agents/tool-definitions/id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "id": "tool_01kb9kefcacry5t3662gfsgtzj",
3   "name": "Acme Webhook Notifier",
4   "description": "Sends notifications to Acme Inc's webhook endpoint for real-time updates.",
5   "kind": "webhook",
6   "config": {
7     "url": "https://hooks.acme-inc.com/notify",
8     "method": "POST",
9     "headers": {},
10     "timeout_ms": 15000,
11     "params": [
12       {
13         "name": "event_type",
14         "type": "string",
15         "description": "Type of event triggering the webhook",
16         "required": true,
17         "enum": [
18           "user_signup",
19           "purchase_completed",
20           "subscription_cancelled"
21         ]
22       }
23     ],
24     "fire_and_forget": false
25   },
26   "created_at": "2024-01-15T09:30:00Z",
27   "updated_at": "2024-04-20T11:45:00Z",
28   "webhook_secret": "************"
29 }

Update a tool. Tool kind is immutable — create a new tool to change it.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

idstringRequired

Request

This endpoint expects an object.

namestringOptional

descriptionstringOptional

configobjectOptional

Response

The updated tool.

idstring

Prefixed wire identifier (tool_<26 char Crockford base32>).

namestring

descriptionstring

kindenum

What kind of tool this is, and where it executes.

builtin: a worker-resident platform capability (e.g. end_call, play_audio), configured per-agent
webhook: worker signs a payload and POSTs it to your URL
client: worker dispatches to the caller’s browser/SDK via data channel
mcp: worker connects to a customer-hosted MCP server and proxies tool calls

configobject

One of WebhookToolConfig, ClientToolConfig, or MCPToolConfig depending on kind.

created_atdatetime

updated_atdatetime

webhook_secretstring

HMAC signing secret for kind=webhook. Returned in full only on the create response; all subsequent reads return a masked placeholder. Store it on first create — there is no way to retrieve it later.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error