Create an agent tool

Creates a tool. label is the readable name; the name the model sees is derived from it automatically (Verify order -> verify_order) and returned in the name field. description is the only thing the model bases its decision of WHEN to use the tool on - write it as an instruction ("Use when the caller asks where their order is."), 10 to 1000 characters.

post/v1/tools

Request

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

Headers

Idempotency-Keystring

Optional key for one logical request. Its scope is global to this API key, independent of the HTTP method, path, or body: use a new value for every distinct logical action across all endpoints and request bodies, and reuse it only to retry the exact same logical request. Reusing a non-blank key within 24 hours returns the stored response; a concurrent request with the same key returns 409 idempotency_in_progress. A missing or whitespace-only value disables idempotency.

Request body

labelstring required

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

descriptionstring required

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

Created tool

Changes

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