Voximate API v1
Introduction
Base URL
Every endpoint lives under one address. Requests are HTTPS only and send and receive JSON.
https://api.voximate.no/public/v1The API has 25 endpoints across agents, calls, phone numbers, webhooks and usage. It is versioned in the path (/v1): fields may be added to responses, but nothing in v1 is removed or renamed.
Start in the sandbox
https://api.voximate.no/sandbox/v1 and any key that starts with vox_test_. Nothing in it rings a phone or sends a webhook. See Sandbox, or press Try it in the sandbox on any endpoint in the reference.Your first request
Create an API key in the Voximate dashboard under Settings → API keys, put it in an environment variable, and ask the API who you are. GET /me needs no scope, so any valid key answers.
curl https://api.voximate.no/public/v1/me \
-H "Authorization: Bearer $VOXIMATE_API_KEY"{
"object": "api_key",
"id": "0b6f3c2e-1a4d-4e5f-9a8b-7c6d5e4f3a2b",
"workspace_id": "4f1a2b3c-5d6e-4f70-8a9b-0c1d2e3f4a5b",
"scopes": [
"agents:read",
"calls:read",
"calls:write"
]
}Keep keys on your server
Where to go next
Key concepts
- Agents are your AI voice agents: their instructions, the greeting they open with, their voice and language. A
draftagent can be tested; only apublishedone answers phone calls and places outbound calls. - Calls are every conversation an agent has had, inbound or outbound, over the phone or in a browser. After a call ends Voximate adds an analysis: a summary, the outcome, the sentiment and action items. The transcript is one request away.
- Phone numbers belong to your workspace. Each one is answered by the agent assigned to it, and an agent places outbound calls from one of its numbers.
- Webhooks push events to your server as they happen —
call.started,call.completed,call.failedandcall.transferred— each one signed so you can prove it came from Voximate.
Conventions
- Field names are
snake_case, every resource carries anobjectfield naming its type, ids are UUIDs and times are ISO 8601 in UTC. - Lists are paginated with a cursor — see Pagination.
- Every error has the same shape and a stable
code— see Errors. - Every response carries an
X-Request-Idheader. Quote it when you contact kontakt@voximate.no.