VaaniiVAANII

Vaanii API Reference

The Vaanii API lets you manage voice-call campaigns and the leads associated with those campaigns.

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.

What you can do

  • Create, configure and manage outbound voice campaigns
  • Add, update and track leads through the sales pipeline
  • Control telephony, STT/TTS, languages and extraction settings

Getting Started

Before making your first API call, make sure you have credentials and understand how resources are scoped.

  1. 1Authentication — required before calling any endpoint. Learn how to obtain and use your API key in the Authentication Guide.
  2. 2Resources — are scoped to your company. Every lead and campaign belongs to a single organisation.
  3. 3Try the APIs — browse the API Reference to see every endpoint, field, and example.

API Structure

The documentation is organized into the following areas. Each covers a distinct part of the platform.

Campaign Configuration

Configure campaign behavior, telephony, speech services, languages, extraction and webhooks.

Leads API

Create and manage leads associated with campaigns.

HTTP Status Codes

HTTP status codes and API response behavior.

Need Help?

If you have any questions, reach out to us or visit the relevant section of the documentation.

Authentication GuideLeads APICampaign Configuration