Create Tool | SpeechifyAI API

curl -X POST https://api.speechify.ai/v1/agents/tool-definitions \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "lookup_order",
  "description": "Fetch order details by order ID.",
  "kind": "webhook",
  "config": {
    "headers": {
      "X-Org-ID": "acme"
    },
    "method": "POST",
    "params": [
      {
        "description": "Order ID",
        "name": "order_id",
        "required": true,
        "type": "string"
      }
    ],
    "timeout_ms": 5000,
    "url": "https://api.your-app.com/webhooks/lookup-order"
  }
}'

{
  "id": "tool_01kb9kefcacry5t3662gfsgtzj",
  "name": "lookup_order",
  "description": "Fetch order details by order ID.",
  "kind": "webhook",
  "config": {
    "headers": {
      "X-Org-ID": "acme"
    },
    "method": "POST",
    "params": [
      {
        "description": "Order ID",
        "name": "order_id",
        "required": true,
        "type": "string"
      }
    ],
    "timeout_ms": 5000,
    "url": "https://api.your-app.com/webhooks/lookup-order"
  },
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "webhook_secret": "wh_sec_3f9a2b7c8d1e4f5a6b7c8d9e0f1a2b3c"
}

Create a tool. For webhook tools, the response includes the HMAC webhook_secret exactly once — store it immediately; subsequent reads return a masked placeholder.

Authentication

AuthorizationBearer

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

Headers

Speechify-VersionstringOptional

Request

This endpoint expects an object.

namestringRequired

descriptionstringRequired

kindenumRequired

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

configobjectRequired

Response headers

X-Request-IDstring

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an X-Request-ID request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an `X-Request-ID` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope.

Response

The created tool.

idstringformat: "^tool_[0-9a-hjkmnp-tv-z]{26}$"

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