Skip to main content

​
Quickstart Guide

Get started with the Vaani Backend API in just a few steps.
1

Get your API Key

First, you’ll need an API key to authenticate your requests. Contact your administrator or check your account settings to obtain your API key.
Your API key provides full access to your account. Keep it secure and never share it publicly.
2

Make your first API call

Let’s create an outbound call using the trigger-call endpoint:
curl -X POST 'https://api.vaaniresearch.com/api/trigger-call/' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "agent_name": "sales-agent",
    "contact_number": "+919876543210",
    "name": "John Doe",
    "voice": "",
    "metadata": {}
  }'

{
  "success": true,
  "message": "Command processed",
  "output": "call_id_12345",
  "error": null
}
3

Explore the API

Now that you’ve made your first call, explore the other endpoints:
  • Get Call History - Retrieve all calls for a client
  • Get Transcript - Access call transcripts
  • Stream Audio - Stream audio files
  • Get Call Details - Get comprehensive call information

View API Reference

See all available endpoints with detailed examples

​
Next Steps

  • Review the API Reference for detailed endpoint documentation
  • Check out the Development Guide for best practices
  • Explore all available endpoints and their parameters