Quick Start

Get started with the API in just a few steps:

Choose a resource category from the sidebar
Browse available endpoints and their documentation
Use the interactive status code picker to explore responses
Copy code examples in your preferred programming language

Making Your First Request

Here's a simple example to get you started with the Vani API:

Before you begin: set up authentication first — see the Authentication page to obtain an OAuth 2.0 access token or an API key. The examples below use api.app.vanihq.com; replace the host with your account's data center (US, AU, CA, EU, IN, SA, UAE). Every resource page has a Data Center selector.

cURL


curl -X GET "https://api.app.vanihq.com/vani/api/v1/editions" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

JavaScript


async function listPresentations() {
  const response = await fetch('https://api.app.vanihq.com/vani/api/v1/editions', {
    method: 'GET',
    headers: {
      'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
      'Content-Type': 'application/json'
    }
  });

  const data = await response.json();
  console.log(data);
  return data;
}

listPresentations();

Node.js


const https = require('https');

const options = {
  hostname: 'api.app.vanihq.com',
  path: '/vani/api/v1/editions',
  method: 'GET',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';

  res.on('data', (chunk) => {
    data += chunk;
  });

  res.on('end', () => {
    const result = JSON.parse(data);
    console.log(result);
  });
});

req.on('error', (error) => {
  // Handle error appropriately
});

req.end();

Python


import requests

url = "https://api.app.vanihq.com/vani/api/v1/editions"
headers = {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
data = response.json()
print(data)

Java


import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class VaniApiExample {
    public static void main(String[] args) throws IOException, InterruptedException {
        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.app.vanihq.com/vani/api/v1/editions"))
                .header("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
                .header("Content-Type", "application/json")
                .GET()
                .build();

        HttpResponse<String> response = client.send(request,
                HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Response Format

All API responses follow a consistent JSON format:

JSON Response

{
  "data": {
    "editions_info": [
      {
        "created_time": "Sun, 09 Apr 2023, 08:43:02",
        "last_modified_time": "Sun, 09 Apr 2023, 08:43:02",
        "edition_id": "75918186",
        "edition_type_name": "ORG",
        "state": "ACTIVE",
        "edition_name": "OrgEdition",
        "edition_owner_id": "69828190",
        "is_default": "true",
        "uri": "/vani/api/v1/editions/75918186"
      }
    ]
  },
  "message": "Editions fetched successfully",
  "request_uri": "/vani/api/v1/editions",
  "status": "success"
}

Next Steps

            
                    Explore Resources — Browse the API resources in the sidebar
                
                    Choose your data center — Point requests at your account's data center host using the Data Center selector
                
                    Test Endpoints — Use the interactive examples to test API calls
                
                    Build Your Integration — Start building your Vani integration