Skip to main content
POST
/
v1
/
senders
/
{senderId}
/
agent
/
tools
Create tool
curl --request POST \
  --url https://api.zavu.dev/v1/senders/{senderId}/agent/tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "get_order_status",
  "description": "Get the status of a customer order",
  "webhookUrl": "https://api.example.com/webhooks/order-status",
  "webhookSecret": "whsec_...",
  "parameters": {
    "type": "object",
    "properties": {
      "order_id": {
        "type": "string",
        "description": "The order ID to look up"
      }
    },
    "required": [
      "order_id"
    ]
  }
}
'
{
  "tool": {
    "id": "<string>",
    "agentId": "<string>",
    "name": "get_order_status",
    "description": "<string>",
    "parameters": {
      "properties": {},
      "required": [
        "<string>"
      ]
    },
    "webhookUrl": "<string>",
    "enabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
senderId
string
required

Body

application/json
​
name
string
required
Maximum string length: 100
​
description
string
required
Maximum string length: 500
​
parameters
object
required
​
webhookUrl
string<uri>
required

Must be HTTPS.

​
webhookSecret
string

Optional secret for webhook signature verification.

​
enabled
boolean
default:true

Response

Tool created.

​
tool
object
required