Skip to main content

​
Get Started in 3 Steps

Get up and running with the Voice Agent API quickly.

​
Step 1: Get Your API Key

To authenticate your requests, you’ll need an API key:
  1. Log in to your dashboard
  2. Navigate to API Keys section
  3. Click “Create API Key”
  4. Give it a descriptive name
  5. Copy the key value (you won’t be able to see it again!)
Store your API key securely. It provides full access to your account.
If you’re building a web application, you can use JWT token authentication instead:
  1. Authenticate users through your application
  2. Receive a JWT token
  3. Include it in the Authorization: Bearer <token> header

​
Step 2: Make Your First Request

Try listing your agents to verify your authentication works:
curl -X GET "https://api.example.com/api/v1/agents" \
  -H "X-API-Key: your-api-key-here"
Or with JWT:
curl -X GET "https://api.example.com/api/v1/agents" \
  -H "Authorization: Bearer your-jwt-token"
Create a new voice agent:
curl -X POST "https://api.example.com/api/v1/agents" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "agent": {
      "name": "My First Agent",
      "conversation_config": {}
    }
  }'

​
Step 3: Explore the API

Now that you’ve made your first API call, explore what you can build:
  • Create Integrations: Set up third-party service connections
  • Manage Conversations: Access conversation data and transcripts
  • Create Campaigns: Build voice campaigns for bulk outreach
  • Configure Agents: Customize agent behavior and tools

​
API Endpoints

Agents

Create and manage voice agents

Integrations

Configure service integrations

API Keys

Manage authentication keys

Conversations

Access conversation data

Campaigns

Create voice campaigns

​
Code Examples

​
JavaScript/Node.js

const axios = require('axios');

const apiClient = axios.create({
  baseURL: 'https://api.example.com/api/v1',
  headers: {
    'X-API-Key': 'your-api-key-here'
  }
});

// List agents
const agents = await apiClient.get('/agents');

// Create an agent
const newAgent = await apiClient.post('/agents', {
  agent: {
    name: 'My Voice Agent',
    conversation_config: {}
  }
});

​
Python

import requests

headers = {
    'X-API-Key': 'your-api-key-here',
    'Content-Type': 'application/json'
}

# List agents
response = requests.get(
    'https://api.example.com/api/v1/agents',
    headers=headers
)
agents = response.json()

# Create an agent
agent_data = {
    'agent': {
        'name': 'My Voice Agent',
        'conversation_config': {}
    }
}
response = requests.post(
    'https://api.example.com/api/v1/agents',
    headers=headers,
    json=agent_data
)

​
Need Help?

API Reference

Complete API documentation

Support

Contact our support team