Skip to main content

​
Chanl Analytics API

The Chanl Analytics API provides comprehensive call analytics, real-time monitoring, and AI-powered insights for voice conversations across multiple platforms including VAPI, Twilio, and custom integrations.

​
Base URL

  • Production: https://api.chanl.ai

​
Key Features

  • Multi-tenant Architecture - All operations are scoped to workspaces
  • Real-time Analytics - Live call monitoring and insights
  • AI-Powered Scoring - Automated conversation quality evaluation
  • Webhook Support - Real-time event notifications
  • Multiple Provider Support - VAPI, Twilio, and custom integrations

​
API Overview

The API is organized into five main sections:

Personas

Customer behavior profiles for testing

Scenarios

Test scenario creation and management

Schedules

Automated test scheduling and execution

Simulations

Test results, analysis, and insights

Authentication

JWT tokens, API keys, and workspace switching

​
Authentication

The API supports two authentication methods:

​
JWT Bearer Tokens

For user authentication via your chosen identity provider: 
{
  "headers": {
    "Authorization": "Bearer <jwt_token>"
  }
}

​
API Keys

For programmatic access using workspace-specific keys: 
{
  "headers": {
    "X-API-Key": "<api_key>"
  }
}

​
Rate Limiting

API requests are rate-limited per workspace to ensure fair usage and system stability. Rate limit headers are included in all responses:
  • X-RateLimit-Limit - Requests per time window
  • X-RateLimit-Remaining - Remaining requests in current window
  • X-RateLimit-Reset - Time when the rate limit resets

​
Error Handling

The API uses standard HTTP status codes and returns detailed error information: 
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": {
      "field": "email",
      "issue": "Invalid email format"
    }
  }
}

​
OpenAPI Specification

View Full API Specification

Complete OpenAPI 3.0.3 specification with all endpoints, schemas, and examples