Skip to content
VaniAgent DOCS

API overview

The Developer API controls supported VaniAgent resources programmatically.

Base URL: https://api.vaniagent.com
Authentication: X-API-Key
Schema: /openapi-public.yaml

The published schema is curated from the deployed FastAPI contract. Dashboard, admin, OAuth, provider credential, and private integration routes are excluded.

Resources

Section titled “Resources”
GET /api/developer/v1/agents X-API-Key
Agents

Create and configure conversation agents.

POST /api/developer/v1/calls X-API-Key
Calls

Initiate and inspect direct calls; bulk initiation is also supported.

POST /api/developer/v1/contacts X-API-Key
Contacts

Upsert Contacts individually or in batches of up to 100.

POST /api/developer/v1/campaigns X-API-Key
Campaigns

Create uploaded-audience campaigns and control their lifecycle.

GET /api/developer/v1/knowledge X-API-Key
Knowledge

Maintain text knowledge sources used by agents.

POST /api/developer/v1/widget/session X-API-Key
Web widget

Create short-lived voice-widget sessions.

Conventions

Section titled “Conventions”
  • IDs are opaque strings; never derive meaning from their format.
  • Timestamps are returned in the API’s documented ISO format.
  • List endpoints may evolve with pagination or filters; preserve unknown fields.
  • A successful request does not guarantee a phone provider later connects the call.
  • Use idempotent application logic around contacts and webhook processing.