Glossary

Definitions for the core concepts you'll encounter across the API reference and guides, listed alphabetically.

Agency

The top-level tenant in Vantax. An agency owns one or more sub-accounts and is reached through agency-scoped endpoints such as /v1/agency and /v1/agency/sub-accounts. Agency-level operations require an agency-scoped API key.

Agent

An AI Agent that handles conversations across voice and chat — answering calls, replying to messages, scheduling, and invoking tools. Agents are configured per sub-account and managed via /v1/agents.

API Key (scoped)

A credential that authenticates requests and determines the tenant it acts on. Keys come in two scopes: agency keys reach agency endpoints, and sub-account keys reach resource endpoints. The account is derived from the key itself — you never pass an agency_id or sub_account_id. Using a key on the wrong scope returns 403. Keys look like vx_live_3fa9c2….

Channel

A medium an Agent communicates over — for example voice, SMS, or web chat. A single conversation may span one channel, and an Agent can be enabled on multiple channels.

Conversation

A threaded exchange of messages between an Agent and a contact on a given channel. Conversations group related messages and are accessed via /v1/conversations.

Execution

A single run of a workflow, created when a trigger fires. Each execution records its status, inputs, and step-by-step results so you can audit what the workflow did.

Idempotency

A guarantee that retrying the same request produces the same result without creating duplicate resources. Send an Idempotency-Key header on write requests so that safely retrying a timed-out call does not, for example, place a second call or send a duplicate message.

Knowledge Base

A collection of documents and sources an Agent can reference to ground its responses. Managed per sub-account via /v1/knowledge-base and attached to Agents to inform their answers.

Number Pool

A group of phone numbers an Agent can draw from when placing or receiving calls and messages, enabling load distribution and local presence. Managed via /v1/number-pools.

Sub-account

A workspace owned by an agency that holds resources — Agents, contacts, conversations, calls, and more. Resource endpoints like /v1/agents and /v1/contacts act on the sub-account derived from a sub-account-scoped API key.

Trigger

The condition that starts a workflow — such as an inbound call, a new message, or a schedule. When a trigger's condition is met, it creates a workflow execution.

Voice

The spoken persona of an Agent on phone channels, including its synthesis characteristics. Voice settings shape how an Agent sounds during inbound and outbound calls.

Webhook

An HTTP callback Vantax sends to a URL you configure when an event occurs — for example a completed call or an inbound message. Webhooks let your systems react to platform events in near real time.

Workflow

An automated sequence of steps that runs in response to a trigger, coordinating Agent actions and integrations. Workflows are defined per sub-account and managed via /v1/workflows.