Skip to main content

​
Getting Started

Welcome to the ClearTalk API documentation. Our API allows you to integrate voice AI capabilities, manage agents, handle campaigns, and interact with Twilio services programmatically.

​
Base URL

All API requests should be made to: 
https://api.cleartalk.ai

​
Authentication

The ClearTalk API uses API key authentication. You’ll need to include your API key in the x-api-key header with every request.

​
Getting Your API Key

Contact our developer support team to obtain your API key:

​
Making Authenticated Requests

Include your API key in the request headers: 
curl -X GET "https://api.cleartalk.ai/callback/standardCampaign" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch(
  "https://api.cleartalk.ai/callback/standardCampaign",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY",
      "Content-Type": "application/json",
    },
  },
);

import requests

headers = {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.cleartalk.ai/callback/standardCampaign', headers=headers)

​
Quick Start

Here’s a quick example to get started:

​
List All Agents

curl -X GET "https://api.cleartalk.ai/callback/standardCampaign" \
  -H "x-api-key: YOUR_API_KEY"

​
Create a New Agent

curl -X POST "https://api.cleartalk.ai/callback/standardCampaign" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumber": "+15550000000",
    "agentName": "My Agent",
    "task": "Handle customer inquiries",
    "selectedVoice": "Maya"
  }'

​
Rate Limiting

Please refer to your service agreement for rate limiting details. Contact developer support for information about rate limits for your plan.

​
Error Handling

The API uses standard HTTP status codes:
  • 200 - Success
  • 201 - Created successfully
  • 400 - Bad request (invalid parameters)
  • 401 - Unauthorized (invalid API key)
  • 404 - Resource not found
  • 409 - Conflict (e.g., duplicate resource)
  • 500 - Internal server error

​
Support

If you encounter any issues or have questions:
  • Email: devsupport@cleartalk.ai
  • Documentation: Explore the API reference sections below for detailed endpoint information