Quick Start

This guide walks through the fastest path to a working integration: creating a key in the dashboard, authenticating a request, and creating your first AI Agent. Every request is made over HTTPS to https://api.vantaxai.com/v1 and returns the standard response envelope.

Get an API Key

The API authenticates with scoped API keys. Generate one from the dashboard under Settings → API Keys, then choose the scope that matches what you intend to call:

• Agency keys reach agency-level endpoints (such as /v1/agency and /v1/agency/sub-accounts) and act on the owning agency.
• Sub-account keys reach resource endpoints (/v1/agents, /v1/contacts, /v1/calls, …) and act on the owning sub-account.

The account a key operates on is derived from the key itself— you never pass an agency_id or sub_account_id in the request. Using an agency key on a sub-account endpoint (or vice versa) returns 403 Forbidden. Because the examples below call /v1/agents, you'll want a sub-account key.

Make your first request

Verify your key by listing the Agents on its account. Pass the key as a bearer token in the Authorization header:

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

The same call with the Fetch API in JavaScript:

const res = await fetch("https://api.vantaxai.com/v1/agents", {
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
  },
});

const body = await res.json();

if (!body.success) {
  throw new Error(body.message);
}

console.log(body.data); // array of Agents
console.log(body.pagination); // { total, limit, has_more }

Create an Agent

POSTCreate an Agent by POSTing a JSON body to /v1/agents. At minimum, supply a name, a voice_id, and the ai_model that powers it:

curl https://api.vantaxai.com/v1/agents \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Front Desk Agent",
    "voice_id": "voice_aria",
    "ai_model": "gpt-4o"
  }'

On success the API responds with 201 Created and the new Agent wrapped in the standard envelope:

{
  "success": true,
  "data": {
    "id": "agent_8Kq2v...",
    "name": "Front Desk Agent",
    "voice_id": "voice_aria",
    "ai_model": "gpt-4o",
    "status": "active",
    "created_at": "2026-06-10T14:32:09Z"
  }
}

Next steps

You've authenticated, listed Agents, and created one. From here, dig into the details: