DEVELOPER DOCUMENTATION

NEVOX AI
API Reference

Build powerful integrations with our comprehensive REST API. Full documentation for developers.

API Version: v2.0
Base URL: api.nevox.ai
Authentication

Authentication

Secure your API requests with bearer token authentication.

API Key Authentication

Use your API key in the Authorization header for all requests.

Secure Transmission

All API calls are encrypted using TLS 1.3 for maximum security.

Rate Limiting

1000 requests per minute for standard plans, 10000 for enterprise.

Keep Your Keys Secure

Never expose your API keys in client-side code or public repositories.

authentication.sh
// Authentication Header
curl -X POST https://api.nevox.ai/v2/calls \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+966501234567",
    "agent": "sales-agent"
  }'
API Endpoints

API Endpoints

Explore our comprehensive API endpoints for calls, agents, transcripts, and more.

API Categories

POST/v2/calls

Initiate a new outbound call with specified agent and parameters.

Example Response
{
  "to": "+966501234567",
  "agent": "sales-agent",
  "language": "ar-SA",
  "context": {
    "customerName": "أحمد",
    "purpose": "follow_up"
  }
}
GET/v2/calls/{call_id}

Retrieve details about a specific call including status and sentiment.

Example Response
{
  "id": "call_abc123",
  "status": "completed",
  "duration": 180,
  "sentiment": "positive"
}
GET/v2/calls

List all calls with pagination and filtering options.

Example Response
{
  "data": [...],
  "total": 150,
  "page": 1,
  "per_page": 20
}
DELETE/v2/calls/{call_id}

Delete a call record and associated data.

Example Response
{
  "success": true,
  "message": "Call deleted"
}
Webhooks

Webhooks

Receive real-time notifications for call events.

Available Events

call.initiatedTriggered when a call is initiated
call.answeredTriggered when call is answered
call.completedTriggered when call completes successfully
call.failedTriggered when a call fails
call.transcript.readyTriggered when transcript is ready
agent.updatedTriggered when agent config changes

Auto Retry

Automatic retries on failed deliveries

Failure Alerts

Get notified of webhook failures

Event Logs

30-day event history and logs

Replay Events

Replay events for debugging

Webhook Payload Example

webhook-payload.json
{
  "id": "evt_123abc",
  "type": "call.completed",
  "created": 1699123456,
  "data": {
    "call_id": "call_xyz789",
    "duration": 245,
    "status": "completed",
    "sentiment": "positive",
    "summary": "Customer satisfied with resolution",
    "agent_id": "agent_sales_01",
    "recording_url": "https://api.nevox.ai/recordings/..."
  }
}
SDKs & Libraries

SDKs & Libraries

Get started quickly with our official SDKs for popular languages.

Node.js

Node.js

npm install @nevox/sdk
import { NevoxAI } from '@nevox/sdk';

const client = new NevoxAI({
  apiKey: process.env.NEVOX_API_KEY
});

const call = await client.calls.create({
  to: '+966501234567',
  agent: 'sales-agent'
});
Python

Python

pip install nevox-ai
from nevox import NevoxAI

client = NevoxAI(api_key=os.environ['NEVOX_API_KEY'])

call = client.calls.create(
    to='+966501234567',
    agent='sales-agent'
)
PHP

PHP

composer require nevox/sdk
use Nevox\NevoxAI;

$client = new NevoxAI([
    'api_key' => getenv('NEVOX_API_KEY')
]);

$call = $client->calls->create([
    'to' => '+966501234567',
    'agent' => 'sales-agent'
]);

More SDKs coming soon: Go, Ruby, Java, .NET

Ready to Integrate?

Start building with NEVOX AI API today and transform your customer communication.