Developer Documentation

Build with Zlavox API

Powerful REST API and SDKs to integrate AI voice agents into your applications. Complete documentation, code examples, and developer support.

On This Page

Need Help?

Join our developer community or contact support

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header.

Authentication Example
curl https://api.zlavox.com/v1/calls \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Keep your API key secure

Never share your API key or commit it to version control. Use environment variables to store sensitive credentials.

Making Calls

Create outbound calls with AI voice agents using the Calls API endpoint.

cURL

curl -X POST https://api.zlavox.com/v1/calls \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+1234567890",
    "assistant_id": "asst_123",
    "metadata": {
      "customer_id": "cust_456"
    }
  }'

JavaScript

const zlavox = require('zlavox');

const client = new zlavox.Client({
  apiKey: process.env.ZLAVOX_API_KEY
});

const call = await client.calls.create({
  to: '+1234567890',
  assistantId: 'asst_123',
  metadata: {
    customerId: 'cust_456'
  }
});

console.log('Call created:', call.id);

Python

from zlavox import Client

client = Client(api_key=os.environ.get('ZLAVOX_API_KEY'))

call = client.calls.create(
    to='+1234567890',
    assistant_id='asst_123',
    metadata={
        'customer_id': 'cust_456'
    }
)

print(f'Call created: {call.id}')

API Endpoints

Complete reference of all available API endpoints.

POST/v1/calls

Create a new outbound call with an AI assistant

View Parameters
to

Phone number to call (E.164 format)

string • Required
assistant_id

ID of the AI assistant to use

string • Required
metadata

Custom metadata object

object • Optional
GET/v1/calls/{id}

Retrieve details of a specific call

View Parameters
id

Unique call identifier

string • Required
GET/v1/calls

List all calls with optional filters

View Parameters
limit

Number of results (max 100)

integer • Optional
status

Filter by call status

string • Optional
DELETE/v1/calls/{id}

Cancel an ongoing call

View Parameters
id

Unique call identifier

string • Required

Official SDKs

Use our official SDKs for faster development in your favorite language.

Node.js

v2.1.0

Official Node.js SDK with TypeScript support

Python

v1.8.3

Python SDK with async/await support

Ruby

v1.5.2

Ruby gem for Rails and Sinatra apps

Go

v0.9.1

Lightweight Go SDK for high performance

Rate Limits

Understand API rate limits and how to handle them in your application.

PlanRequests/MinRequests/Day
Starter6010,000
Pro12050,000
EnterpriseCustomCustom

Ready to Start Building?

Get your API key and start integrating voice AI in minutes