Tools

Create tool

Register a new custom tool that voice agents can trigger over an HTTP webhook mid-call.

POST
/tools

Register a new custom tool that voice agents can trigger over an HTTP webhook mid-call.

Authorization

ApiKeyAuth
X-API-Key<token>

Voice platform authentication secret. Create one from the API Keys endpoint or your dashboard.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/tools" \  -H "Content-Type: application/json" \  -d '{    "name": "book_appointment",    "description": "Books an appointment slot in the CRM.",    "httpEndpoint": "https://hooks.acme.com/book",    "method": "POST"  }'
{  "id": "string",  "name": "string",  "description": "string",  "httpEndpoint": "string",  "method": "string",  "isActive": true}
{  "statusCode": 400,  "message": [    "name should not be empty"  ],  "error": "Bad Request"}
{  "statusCode": 401,  "message": "Unauthorized",  "error": "Unauthorized"}