Create a custom mid-call tool on a voice agent (tools scope required)

Wires the company's OWN HTTPS API into the voice agent as a mid-call tool (e.g. order lookup, booking check). The URL host is pinned at creation; caller-supplied values only fill {param} placeholders in path/query/body. Always verify with POST /api/v1/tools/test afterwards. Grounding rules (param values must come from the caller's own words) are enforced automatically.

post/api/v1/tools

Request

  • Base URL: https://salestick-backend-647994203646.europe-central2.run.app
  • URL: https://salestick-backend-647994203646.europe-central2.run.app/api/v1/tools
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

agentIdstring

Which voice agent gets the tool - required only when the team has several (ids from GET /api/v1/agents).

namestring required

snake_case tool name, 3-41 chars, e.g. check_order_status.

descriptionstring required

For the voice AI: when to call this tool and what it returns.

method'GET' | 'POST' required
urlstring required

HTTPS endpoint; {param} placeholders allowed in path/query, never in the host. Host must be publicly reachable (no private/internal addresses).

headersobject

Static headers, e.g. an Authorization header. Stored server-side, masked in listings.

bodyobject

POST only: JSON body template; string values may contain {param} placeholders.

responseFieldsstring[]

Allowlist of response fields (dot paths) the voice AI is shown. Strongly recommended.

timeoutMsinteger

Response

Tool created (live on new calls immediately)

Changes

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