Tools

Test a tool

POSThttps://voxa.abhinavyadav.in/api/v1/tools/test

Runs an HTTP tool once with the arguments you give, exactly as an agent would mid-call, and shows what the model would receive.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the agents.edit permission.

X-API-KeyAuthorization: Beareragents.edit

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body application/json

toolobjectrequired

The tool, as it would appear in an agent's tools.

Show child attributes

namestringrequired

The function name the model calls: letters, digits and _.

matches ^[a-zA-Z_][a-zA-Z0-9_]{0,63}$

descriptionstringrequired

When the model should use the tool.

3 to 1000 characters

parametersobject

JSON Schema of the arguments the model fills in.

methodenum<string>default: "POST"

GET sends the arguments as query parameters, POST as a JSON body.

One of:GETPOST

urlstringrequired

Where the request goes.

headersobject

Extra request headers, such as an authorization header.

pre_call_messagestring

Said while the request runs.

timeout_secondsnumberdefault: 8

The request is abandoned after this long.

1 to 30

argsobject

The arguments the model would pass.

Response

200Success.

See the 200 example next to the code samples.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

429Over the per-key rate limit; wait for Retry-After.

detailstring

What went wrong, in plain words.

curl --request POST \ --url 'https://voxa.abhinavyadav.in/api/v1/tools/test?timezone=Asia/Kolkata' \ --header 'X-API-Key: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "tool": { "name": "check_availability", "description": "Free appointment slots for a date", "method": "POST", "url": "https://example.com/slots" }, "args": { "date": "2026-10-02" } }'

import requests url = "https://voxa.abhinavyadav.in/api/v1/tools/test" params = { "timezone": "Asia/Kolkata", } headers = { "X-API-Key": "<api-key>", } payload = { "tool": { "name": "check_availability", "description": "Free appointment slots for a date", "method": "POST", "url": "https://example.com/slots", }, "args": { "date": "2026-10-02", }, } response = requests.post(url, params=params, headers=headers, json=payload) print(response.status_code, response.json())

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/tools/test?timezone=Asia/Kolkata", { method: "POST", headers: { "X-API-Key": "<api-key>", "Content-Type": "application/json", }, body: JSON.stringify({ "tool": { "name": "check_availability", "description": "Free appointment slots for a date", "method": "POST", "url": "https://example.com/slots" }, "args": { "date": "2026-10-02" } }), }) const data = await response.json() console.log(response.status, data)

{ "ok": true, "status": 200, "elapsed_ms": 184, "response": { "slots": [ "10:00", "11:30" ] }, "sent_to_model": { "status": 200, "result": { "slots": [ "10:00", "11:30" ] } } }