API Reference Introduction

Welcome to the Vodex.ai API documentation. This comprehensive API reference provides programmatic access to Vodex.ai’s AI-powered voice calling capabilities, allowing you to integrate intelligent voice automation into your applications and workflows.

What you’ll learn: How to authenticate with the Vodex.ai API, make your first API calls, and integrate voice calling capabilities into your applications.

Base URL

All API requests should be made to the following base URL:

https://api.vodex.ai

HTTPS Required: All API requests must use HTTPS. HTTP requests will be rejected for security reasons.

Authentication

The Vodex.ai API uses API key authentication. You’ll need two pieces of information to authenticate your requests:

Required Headers

Authorization Header
Database URL Header

API Key AuthenticationInclude your API key in the Authorization header of all requests:

Authorization: YOUR_API_KEY

Keep Your API Key Secure: Never expose your API key in client-side code or public repositories. Store it securely and use environment variables.

Complete Authentication Example

curl -X GET "https://api.vodex.ai/v1/projects" \
  -H "Authorization: YOUR_API_KEY" \
  -H "dburl: YOUR_ACCOUNT_URL" \
  -H "Content-Type: application/json"

Getting Your API Key

To access the Vodex.ai API, you’ll need to request API credentials:

Request API Access: Send an email to support@vodex.ai with the subject “Request API Key”. Include your company name, use case, expected API usage volume, and technical contact information.

Send Request Email

Email Support

Use the exact subject line: “Request API Key”
Provide detailed information about your use case
Include your technical requirements

Receive Credentials

Get Your API Access

Support team will review your request
You’ll receive your API key and account URL
Documentation and usage guidelines will be provided

Test Integration

Verify Setup

Test authentication with a simple API call
Verify your headers are correctly configured
Start with basic endpoints before complex integrations

API Structure

The Vodex.ai API is organized around REST principles and uses standard HTTP response codes. The API accepts and returns JSON-encoded data.

Core Resources

Projects

Campaign Management

Create and manage different bot projects
Configure project-specific settings
Organize campaigns by use case or client

Key Endpoints:

GET /v1/projects - List all projects
POST /v1/projects - Create new project
DELETE /v1/projects/{id} - Delete project

Audience

Contact Management

Upload and manage target audience data
Segment contacts for different campaigns
Update contact information and custom fields

Key Endpoints:

POST /v1/audience - Create audience list
GET /v1/audience - Retrieve audience data
PUT /v1/audience/{id} - Update audience list

Campaigns

Campaign Operations

Create and configure calling campaigns
Monitor campaign performance
Manage campaign lifecycle

Key Endpoints:

POST /v1/campaign - Create campaign
GET /v1/campaign - List campaigns
DELETE /v1/campaign/{id} - Delete campaign

Agent Settings

AI Configuration

Configure AI agent behavior and responses
Set up prompts and conversation flows
Manage agent personalities and voices

Key Endpoints:

POST /v1/agent-setting - Create agent configuration
GET /v1/agent-setting - Retrieve agent settings
PUT /v1/agent-setting/{id} - Update agent settings

Call Triggers

Call Execution

Initiate automated calls programmatically
Trigger individual or batch calls
Monitor call status and outcomes

Key Endpoints:

POST /v1/call-trigger/run-campaign - Start campaign calls

Quick Start: Trigger Your First Call

Get started quickly with the most commonly used endpoint - triggering calls:

🚀 Call Trigger API

Start Making Calls ImmediatelyUse the Call Trigger API to programmatically initiate AI-powered calls for your campaigns.Quick Access: /v1/call-trigger/run-campaign

Basic Call Trigger Example

curl -X POST "https://api.vodex.ai/v1/call-trigger/run-campaign" \
  -H "Authorization: YOUR_API_KEY" \
  -H "dburl: YOUR_ACCOUNT_URL" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignId": "your_campaign_id",
    "audienceId": "your_audience_id"
  }'

Response Format

All API responses follow a consistent JSON format:

Success Response

{
  "success": true,
  "data": {
    // Response data here
  },
  "message": "Operation completed successfully"
}

Error Response

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error description"
  }
}

HTTP Status Codes

Status Code	Meaning	Description
200	OK	Request successful
201	Created	Resource created successfully
400	Bad Request	Invalid request parameters
401	Unauthorized	Invalid or missing API key
403	Forbidden	Insufficient permissions
404	Not Found	Resource not found
429	Too Many Requests	Rate limit exceeded
500	Internal Server Error	Server error occurred

Rate Limits

The Vodex.ai API implements rate limiting to ensure fair usage and system stability:

Rate Limits Apply: API requests are limited based on your account tier. Contact support if you need higher limits for your use case.

Rate Limit Headers

All API responses include rate limit information in the headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Best Practices

Optimize Your Requests: Batch operations when possible and implement exponential backoff for retry logic to handle rate limits gracefully.

Common Integration Patterns

Webhook Integration

Many Vodex.ai API operations support webhooks for real-time notifications:

{
  "webhookUrl": "https://your-domain.com/webhook",
  "events": ["call_completed", "campaign_finished"]
}

Batch Operations

For high-volume operations, use batch endpoints when available:

{
  "batch": true,
  "items": [
    {"phone": "+1234567890", "name": "John Doe"},
    {"phone": "+1234567891", "name": "Jane Smith"}
  ]
}

SDK and Libraries

While we don’t currently provide official SDKs, the API is designed to work seamlessly with standard HTTP libraries in any programming language.

Recommended Libraries

JavaScript/Node.js
Python
PHP
Java

HTTP Clients

fetch (built-in)
axios
node-fetch

Next Steps

Now that you understand the basics:

Request your API key from support@vodex.ai
Test authentication with a simple API call
Explore the Call Trigger API to start making calls
Review other endpoints for complete integration
Set up webhooks for real-time notifications

Ready to integrate? The Vodex.ai API provides powerful programmatic access to AI-powered voice calling capabilities. Start with the Call Trigger API and expand your integration as needed.

Support and Resources

Getting Help

Email Support: support@vodex.ai
API Questions: Include “API Support” in your subject line
Response Time: Within 24 hours during business days

Additional Resources

📞 Call Trigger API

Start making AI-powered calls programmatically with the most popular endpoint.

📊 Dashboard API

Access campaign analytics and performance data via API.

👥 Audience Management

Programmatically manage your contact lists and audience data.

🤖 Agent Configuration

Configure AI agents and conversation flows via API.

Getting Started

Call Trigger

Analyze

Base URL

Authentication

Required Headers

Complete Authentication Example

Getting Your API Key

API Structure

Core Resources

Quick Start: Trigger Your First Call

🚀 Call Trigger API

Basic Call Trigger Example

Response Format

Success Response

Error Response

HTTP Status Codes

Rate Limits

Rate Limit Headers

Best Practices

Common Integration Patterns

Webhook Integration

Batch Operations

SDK and Libraries

Recommended Libraries

Next Steps

Support and Resources

Getting Help

Additional Resources

📞 Call Trigger API

📊 Dashboard API

👥 Audience Management

🤖 Agent Configuration

Getting Started

Call Trigger

Analyze

​Base URL

​Authentication

​Required Headers

​Complete Authentication Example

​Getting Your API Key

​API Structure

​Core Resources

​Quick Start: Trigger Your First Call

🚀 Call Trigger API

​Basic Call Trigger Example

​Response Format

​Success Response

​Error Response

​HTTP Status Codes

​Rate Limits

​Rate Limit Headers

​Best Practices

​Common Integration Patterns

​Webhook Integration

​Batch Operations

​SDK and Libraries

​Recommended Libraries

​Next Steps

​Support and Resources

​Getting Help

​Additional Resources

📞 Call Trigger API

📊 Dashboard API

👥 Audience Management

🤖 Agent Configuration

Base URL

Authentication

Required Headers

Complete Authentication Example

Getting Your API Key

API Structure

Core Resources

Quick Start: Trigger Your First Call

Basic Call Trigger Example

Response Format

Success Response

Error Response

HTTP Status Codes

Rate Limits

Rate Limit Headers

Best Practices

Common Integration Patterns

Webhook Integration

Batch Operations

SDK and Libraries

Recommended Libraries

Next Steps

Support and Resources

Getting Help

Additional Resources