Skip to main content

​
Base URL

https://api.talkifai.dev/v1
All API requests must be made over HTTPS. HTTP requests will be rejected.

​
Authentication

All endpoints require an API key passed in the Authorization header: 
Authorization: Bearer YOUR_API_KEY
See Authentication for details on generating and managing API keys.

​
Request Format

  • All request bodies must be JSON (Content-Type: application/json)
  • All timestamps are ISO 8601 (e.g., 2024-01-15T10:30:00Z)
  • Phone numbers must be in E.164 format (e.g., +12025550123)

​
Response Format

All responses follow this structure: 
// Success
{
  "success": true,
  "data": { ... }
}

// Error
{
  "success": false,
  "error": "Error message here",
  "code": "ERROR_CODE"
}

​
HTTP Status Codes

CodeMeaning
200Success
201Created
400Bad Request — missing or invalid fields
401Unauthorized — invalid or missing API key
403Forbidden — insufficient permissions
404Not Found — resource doesn’t exist
429Rate Limited — too many requests
500Internal Server Error

​
Rate Limits

TierRequests per minute
Free60
Pro300
Enterprise1,000+ (custom)
When rate limited, the response includes: 
Retry-After: 30
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1705318260

​
Pagination

List endpoints support pagination: 
GET /v1/calls?page=2&limit=50
Parameters:
ParamDefaultMaxDescription
page1—Page number
limit20100Items per page
Response includes: 
{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 2,
    "limit": 50,
    "total": 342,
    "hasNext": true,
    "hasPrev": true
  }
}

​
API Sections

Authentication

API key management and org context.

Agents

Create, update, and manage agents (Pipeline, Realtime, Text).

Voice Call Sessions

Initiate outbound calls, track sessions, get transcripts.

Text Chat API

REST + SSE text chat sessions for website chatbots.

Custom Functions

Add custom API integrations that agents call during conversations.

Webhooks

Receive real-time events when calls start, end, and more.