Authentication

Every request must include credentials as one of the following HTTP headers:

Base URL: examples use <vaanii_api_base_url> in place of the Vaanii API address. Contact the Vaanii team at team@vaanii.ai to get it.

MethodHeader
API KeyX-API-Key: <your_api_key>
API Key (alternative)Authorization: ApiKey <your_api_key>

If credentials are missing or invalid, the API responds with 401 Unauthorized.

Getting an API key

An API key is generated inside the dashboard after you log in. There is no signup-only path for creating keys programmatically.

  1. 1Log in to the Vaanii dashboard (email/password or Google).
  2. 2Open API Keys from the sidebar.
  3. 3Click Generate key, give it a name, and copy the key now. The raw key is shown only once. It is stored as a hash and cannot be recovered later. (You can reveal it again from the same page, or revoke it, which removes the key immediately.)

The API key is a 64-character hex string (secrets.token_hex(32)). Send it with every request as X-API-Key: <your_api_key> (or Authorization: ApiKey <your_api_key>).

Finding your campaign ID

Many endpoints take a campaign_id, for example POST /api/v1/leads/create and GET /api/v1/calls/history. It is a UUID such as 3f9c1b2a-9e2d-4f1a-8c7b-1a2b3c4d5e6f. To copy it from the dashboard:

  1. 1Log in to your Vaanii account.
  2. 2In the sidebar, open Agents → Campaigns.
  3. 3Find your campaign and click the ⋮ more options button at the end of its row.
  4. 4Click Copy Campaign ID. The ID is copied to your clipboard.

A campaign ID never changes, so you can store it in your own system.