API Reference

VoxBridge exposes a REST API over HTTPS. Interactive OpenAPI documentation is available at /api-docs (Swagger UI) and /redoc.

Base URL

https://www.voxbridge.cc

Production deployments should set API_PUBLIC_URL in environment configuration so webhooks and integrations use the correct host.

Authentication summary

Route prefixCredential
/auth/*None (signup/login) or JWT (me)
/dashboard/*JWT Bearer (dashboard token)
/v1/*sk_live_ API key Bearer
/api/admin/*JWT (platform admin)

Public API endpoints (/v1)

MethodPathDescription
POST/v1/calls/outboundQueue an outbound call
GET/v1/callsList calls (paginated)
GET/v1/calls/{call_id}Get call by UUID
GET/v1/agentsList active agents
GET/v1/healthAPI health check

Auth endpoints

MethodPathDescription
POST/auth/signupRegister organization + user
POST/auth/loginObtain dashboard JWT
GET/auth/meCurrent user and organization

Dashboard endpoints (/dashboard)

MethodPathDescription
GET/dashboard/statsUsage and call counters
GET/dashboard/callsList org calls
GET/dashboard/agentsList agents (full detail)
POST/dashboard/agentsCreate agent
PATCH/dashboard/agents/{id}Update agent
DELETE/dashboard/agents/{id}Deactivate agent
GET/dashboard/api-keysList API keys
POST/dashboard/api-keysCreate API key
POST/dashboard/api-keys/{id}/revokeRevoke key
PATCH/dashboard/webhookSet org webhook URL
GET/dashboard/voice-charactersList voice profiles

System

MethodPathDescription
GET/healthService health (no auth)

HTTP status codes

  • 201 — Resource created (calls, signup, agents)
  • 401 — Missing or invalid credentials
  • 402 — Monthly minute limit reached
  • 403 — Inactive user/org or insufficient role
  • 404 — Call or agent not found
  • 409 — Email already registered
  • 422 — Validation error (Pydantic)

OpenAPI

For request/response schemas, enums, and try-it-out requests, use the generated specification:

Open Swagger UI ↗

Topic guides

Calls API → · Webhooks → · Authentication →