Vantax AI Agent API

The Vantax API is organized around REST. It has predictable, resource-oriented URLs, accepts JSON request bodies, returns JSON responses, and uses standard HTTP response codes, authentication, and verbs. Every response is wrapped in a consistent envelope so your integration code can handle success and failure uniformly.

Base URL

All API requests are made to the following base URL over HTTPS:

https://api.vantaxai.com/v1

Authentication

The API authenticates requests with scoped API keys. Pass your key as a bearer token in the Authorization header (or via the x-api-key header):

curl https://api.vantaxai.com/v1/agents \
  -H "Authorization: Bearer vx_live_3fa9c2..."

Keys come in two scopes. The scope determines which endpoints the key can reach and which account it operates on — the account is derived from the key itself, never from the request body:

• Agency keys access agency-level endpoints (e.g. listing sub-accounts) and act on the owning agency.
• Sub-account keys access resource endpoints (agents, contacts, calls, …) and act on the owning sub-account.

Response Envelope

Every response shares the same top-level shape:

// Success
{
  "success": true,
  "data": { /* the resource, or an array of resources */ },
  "pagination": { "total": 42, "limit": 20, "has_more": true } // list endpoints
}

// Error
{
  "success": false,
  "message": "Human-readable explanation"
}

Resource Groups

The API is divided into 12 resource groups: