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

Path parameters

senderIdstring required
toolIdstring required

Request body

testParamsobject required

Parameters to pass to the tool for testing.

Response

The tool ran. Check run.success for what it answered.