API Reference

Every HTTP and WebSocket surface VoicEra exposes.

The complete VoicEra API: 71 REST routes across twelve routers, plus the realtime media WebSocket. Every page here was extracted from the routers and verified against them.

A running API serves an interactive console at http://localhost:8000/docs, generated from the same code. Use it to fire real requests; use these pages to learn what a route does and how it behaves.

There is no official Node.js, Python, or other client SDK. Every example on this site is a raw curl request or, for the WebSocket, a standard library client (WebSocket in the browser, websockets in Python) — see Recipes for REST and WebSocket API for the socket. GET /openapi.json on a running API is a valid input to any OpenAPI client generator if you want to build your own typed client.

Start here

Page	Covers
Introduction	Base URL, versioning, request and response conventions
Authentication	JWTs, X-API-Key, roles, organisation scoping
Errors	Status codes and error shapes
Endpoints cheatsheet	Every route across all three services, one page

Endpoints by resource

Page	Routes	What it covers
Agents	6	Create, read, update, delete voice agents
Calls	9	Outbound, inbound, web calls; recordings and transcripts
Campaigns	14	CSV upload, scheduling, start/pause/resume, progress, reports
Phone numbers	5	Number inventory, attaching to agents
Knowledge and RAG	4	Document upload and retrieval
Configuration catalogs	9	Which providers exist and what each accepts
Provider credentials	6	Storing encrypted API keys
Users and organisations	15	Signup, login, membership, roles, bot tokens

Realtime

• WebSocket API — WS /agent/{org_id}/{agent_id} in both modes: telephony frame serializers at 8 kHz, browser protobuf/RTVI at 16 kHz.

Conventions on every page

Each endpoint lists its method and path, the auth it requires, its request fields, its response shape, and the errors it can return. Paths already include the /api/v1 prefix.

Related

• Recipes — task-shaped recipes built on these routes
• Connecting a client — choosing a surface
• Data model — the documents behind these routes