Send a real test request for a tool definition that is not saved yet

Sends a REAL request per the definition you send and returns what came back - the tool is NOT saved (unlike POST /v1/tools, label/description are optional here). Handy for trying an address before saving it as an agent tool. timeoutSecs is only validated here (5 to 30) - a test always waits a fixed 10 seconds instead, so you don't sit through a full runtime timeout; it's the value the tool would use at runtime once saved. Shares a rate limit with POST /v1/tools/{id}/test below - 10 attempts per minute per account combined.

post/v1/tools/test

Request

  • Base URL: https://volai.cz
  • URL: https://volai.cz/v1/tools/test
  • Auth: HTTP bearer

Request body

labelstring

Display name of the webhook tool, also used to derive its name for the agent. Reserved call-control names are not allowed.

descriptionstring

Tell the agent when to call this tool and what it does.

urlstring required

Public HTTPS endpoint receiving the tool request. Local/private addresses are rejected; the endpoint must respond within timeoutSecs.

methodstring required

HTTP request method: GET puts parameters in the query string, POST sends JSON. Case-insensitive GET or POST only.

headersobject

Complete map of custom HTTP headers; {} clears them on PATCH. Values are secrets and returned redacted. Header names are case-insensitive and must be unique. host, content-length, x-conversation-id and x-caller-id are reserved.

timeoutSecsinteger

Maximum wait for the endpoint's response during a call, in whole seconds. Defaults to 20.

Response

Test result

statusnumber required
durationMsnumber required
bodystring required
notestring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.