Official Resource

API Documentation

Comprehensive REST API reference for Loxia AI. Integrate voice capabilities directly into your backend.

Authentication

All API requests require authentication. You must include your API key in the Authorization header as a Bearer token.

Authorization: Bearer YOUR_API_KEY

Keep your API keys secure. Do not expose them in client-side code such as frontend applications or mobile apps.

Agents API

Manage your AI agents. You can create new agents, assign system prompts, and configure voices.

List Agents

GET /v1/agents

Returns a paginated list of all agents associated with your account.

Create Agent

POST /v1/agents

Creates a new AI agent. Requires name and systemPrompt in the JSON body.

Calls API

Initiate and manage outbound calls dynamically.

Start an Outbound Call

POST /v1/calls/outbound

Triggers an immediate outbound call to a specific phone number using a designated agent ID.

Retrieve Call Analytics

GET /v1/calls/{call_id}/analytics

Returns the full transcript, duration, and sentiment analysis for a completed communication session.

Webhooks

Listen for real-time events. Configure webhook endpoints in your Dashboard to receive HTTP POST payloads when a call finishes, or a lead is captured.