Create tool

POST

/api/tools

Creates a new tool and attaches it to one of the tenant's agents. The tool may be a webhook call, a fixed call transfer, or a multi-destination dynamic transfer.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Tool created.

Bodyapplication/json

🟠400

🟠401

🟠403

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.snakk.ai/api/tools' \
--header 'X-API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "agent_id": "a0000000-1111-2222-3333-444455556666",
    "name": "book_appointment",
    "display_name": "Book appointment",
    "description": "Books an appointment in the external calendar",
    "type": "webhook",
    "webhook_url": "https://example.com/webhooks/book",
    "webhook_method": "POST",
    "webhook_headers": {
        "Authorization": "Bearer ***"
    },
    "webhook_body_template": "{\"date\":\"{{date}}\",\"name\":\"{{name}}\"}",
    "webhook_timezone": "Europe/Oslo",
    "parameters": {
        "date": {
            "type": "string",
            "description": "Requested date"
        },
        "name": {
            "type": "string",
            "description": "Caller name"
        }
    },
    "requires_identity": false
}'

Response Example

201 - Example 1

{
    "tool": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
        "name": "string",
        "display_name": "string",
        "description": "string",
        "type": "webhook",
        "webhook_url": "string",
        "webhook_method": "GET",
        "webhook_headers": {},
        "webhook_body_template": "string",
        "webhook_timezone": "string",
        "parameters": {},
        "transfer_destinations": [
            {}
        ],
        "enabled": true
    }
}

Modified at 2026-07-08 19:01:40

Add tool/webhook to agent

Update tool