Skip to main content

​
Introduction

Welcome to the Truedy API! Truedy is a voice AI calling platform that enables you to create AI-powered voice agents, make calls, manage campaigns, and integrate voice capabilities into your applications.

​
What is Truedy?

Truedy provides a comprehensive API for:
  • AI Voice Agents: Create intelligent voice agents with custom prompts, voices, and behaviors
  • Voice Calls: Make outbound calls or receive inbound calls with your agents
  • Campaigns: Run large-scale calling campaigns with contact management
  • Knowledge Bases: Upload documents to give your agents context
  • Tools & Integrations: Connect your agents to external APIs and services
  • Telephony: Manage phone numbers, purchase numbers, and configure telephony settings

​
Key Features

API Key Authentication

Secure API access using API keys with configurable rate limits and IP whitelisting

Rate Limiting

Per-API-key rate limits (minute, hour, day) to control usage and prevent abuse

Comprehensive Logging

Detailed usage logs for every API request with analytics and monitoring

Enterprise Security

IP whitelisting, encrypted key storage, and audit trails for compliance

​
Base URL

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

​
Authentication

Truedy API supports two authentication methods:
  1. API Keys (Recommended for server-to-server): Use Authorization: Bearer <key> header
  2. JWT Tokens (For frontend applications): Use Clerk JWT tokens
See the Authentication guide for details.

​
Rate Limits

API keys have configurable rate limits:
  • Per Minute: Default 60 requests/minute
  • Per Hour: Default 1,000 requests/hour
  • Per Day: Default 10,000 requests/day
Rate limit headers are included in all responses. See Rate Limits for details.

​
Response Format

All API responses follow a consistent format: 
{
  "data": {
    // Response data
  },
  "meta": {
    "request_id": "uuid",
    "ts": "2024-01-01T00:00:00Z"
  }
}

​
Error Handling

Errors are returned with appropriate HTTP status codes and a structured error object: 
{
  "error": {
    "code": "validation_error",
    "message": "Invalid request",
    "details": {
      "field": "phone_number",
      "reason": "Must be in E.164 format"
    }
  },
  "meta": {
    "request_id": "uuid",
    "ts": "2024-01-01T00:00:00Z"
  }
}

​
Getting Started

  1. Create an Account: Sign up at app.truedy.ai
  2. Create an API Key: Navigate to Settings → API Keys
  3. Make Your First Request: See the Quickstart guide

​
Support