Agent Tools
Test tool
Run a tool with the parameters you supply and return what it answered.
The call is synchronous: the response carries the tool’s status, body, and duration, so a green result is evidence the tool ran rather than evidence it was accepted. Each run is also recorded and readable afterwards via GET /v1/senders/{senderId}/agent/tools/{toolId}/test-runs.
A tool that answers with an error is reported as a run with success: false — the endpoint itself still returns 200. This fires the tool’s real webhook, so a test has whatever side effects the tool has.
POST
/
v1
/
senders
/
{senderId}
/
agent
/
tools
/
{toolId}
/
test
Test tool
curl --request POST \
--url https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"testParams": {
"order_id": "ORD-12345"
}
}
'import requests
url = "https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test"
payload = { "testParams": { "order_id": "ORD-12345" } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({testParams: {order_id: 'ORD-12345'}})
};
fetch('https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'testParams' => [
'order_id' => 'ORD-12345'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test"
payload := strings.NewReader("{\n \"testParams\": {\n \"order_id\": \"ORD-12345\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"testParams\": {\n \"order_id\": \"ORD-12345\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"testParams\": {\n \"order_id\": \"ORD-12345\"\n }\n}"
response = http.request(request)
puts response.read_body{
"run": {
"id": "<string>",
"toolId": "<string>",
"success": true,
"durationMs": 123,
"createdAt": "2023-11-07T05:31:56Z",
"params": {},
"statusCode": 123,
"response": "<string>",
"error": "<string>"
}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Parameters to pass to the tool for testing.
Response
The tool ran. Check run.success for what it answered.
One run of a tool triggered from the test endpoint. Recorded so a test is verifiable after the fact rather than only visible in the response.
Show child attributes
Show child attributes
⌘I
Test tool
curl --request POST \
--url https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"testParams": {
"order_id": "ORD-12345"
}
}
'import requests
url = "https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test"
payload = { "testParams": { "order_id": "ORD-12345" } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({testParams: {order_id: 'ORD-12345'}})
};
fetch('https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'testParams' => [
'order_id' => 'ORD-12345'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test"
payload := strings.NewReader("{\n \"testParams\": {\n \"order_id\": \"ORD-12345\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"testParams\": {\n \"order_id\": \"ORD-12345\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zavu.dev/v1/senders/{senderId}/agent/tools/{toolId}/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"testParams\": {\n \"order_id\": \"ORD-12345\"\n }\n}"
response = http.request(request)
puts response.read_body{
"run": {
"id": "<string>",
"toolId": "<string>",
"success": true,
"durationMs": 123,
"createdAt": "2023-11-07T05:31:56Z",
"params": {},
"statusCode": 123,
"response": "<string>",
"error": "<string>"
}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}{
"code": "invalid_request",
"message": "Phone number is invalid",
"details": {}
}