Skip to main content

Base URL

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:
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:

HTTP Status Codes


Rate Limits

When rate limited, the response includes:

Pagination

List endpoints support pagination:
Parameters: Response includes:

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.