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:

cURL


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

JavaScript


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

const data = await response.json();
// Process the response data
return data;

Node.js


const https = require('https');

const options = {
  hostname: 'api.app.vanihq.com',
  path: '/vani/api/v1/spaces',
  method: 'GET',
  headers: {
    'Authorization': 'Bearer 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);
    // Process the response data
  });
});

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

req.end();

Python


import requests

url = "https://api.app.vanihq.com/vani/api/v1/spaces"
headers = {
    "Authorization": "Bearer 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/spaces"))
                .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
                .header("Content-Type", "application/json")
                .GET()
                .build();

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

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

Response Format

All API responses follow a consistent JSON format:

JSON Response


{
  "success": true,
  "data": {
    "spaces": [
      {
        "id": "space_123",
        "name": "My Workspace",
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
      }
    ]
  },
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 1
  }
}

Next Steps

            
                    Explore Resources - Browse the API resources in the sidebar
                
                    Set up Authentication - Configure OAuth 2.0 or API key authentication
                
                    Test Endpoints - Use the interactive examples to test API calls
                
                    Build Your Integration - Start building your Vani integration