Vocalis/AI
API Reference · v1

Give your software
a voice.

A REST API and post-call webhook system for programmatically managing agents, telephony profiles, and call data. Full interactive reference available inside the dashboard.

Authentication

All requests are authenticated with a short-lived JWT bearer token, obtained via the login endpoint and refreshed automatically by the official SDKs.

Request
curl https://api.vocalis.ai/api/v1/agents/ \
  -H "Authorization: Bearer $VOCALIS_ACCESS_TOKEN"

Core endpoints

GET/api/v1/agents/List all agents in the organization.
POST/api/v1/agents/Create a new standalone, router, or worker agent.
GET/api/v1/agents/{id}/Retrieve a single agent's full configuration.
PATCH/api/v1/agents/{id}/Update an agent's configuration.
GET/api/v1/calls/List call logs with transcript and extracted data.
POST/api/v1/knowledge-base/documents/Ingest a new knowledge base document.

Post-session webhooks

When a call ends, Vocalis AI POSTs the transcript, extracted schema fields, and call metadata to your configured webhook URL - signed with an HMAC header for verification.

Webhook payload
{
  "call_id": "call_1000",
  "agent_id": "agt_worker_booking",
  "status": "COMPLETED",
  "duration_seconds": 96,
  "extracted_data": {
    "patient_name": "Jordan Lee",
    "booking_confirmed": true,
    "appointment_date": "2026-08-04"
  }
}