Official Resource

API Documentation

Complete REST API reference for Loxia AI. Integrate voice features 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 keys secure. Never expose them in client-side code.

Agents API

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

Agents List

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

Start and manage outbound calls dynamically.

Start Outbound Call

POST /v1/calls/outbound

Initiates an immediate call to a specific 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 conversation.

Webhooks

Listen to real-time events. Configure webhook endpoints in the Dashboard to receive HTTP POST payloads when a call ends or a contact is acquired.