Skip to main content

VoiceMatrix Developer Platform

Everything on this page and the pages linked from it was checked against the production code and executed against a running deployment: the whole set on 2026-08-25 — a real key, every documented endpoint, a real webhook delivery whose signature was verified with the code on this site, and the MCP server driven end to end — and the agent API (configuration, testing, knowledge, calendar, integrations, the agent webhook) end to end against production on 2026-10-07, from outside, with a real key and Hebrew content. See the changelog for what those runs found and corrected. Where a fact could not be verified against running code or a source file, it says so instead of guessing.

If you read the previous version of these docs: almost every concrete detail in it — the API host, the base path, the ID formats, the webhook event catalog, the error shape — was wrong. Not out of date; it described an API that was never built. This rewrite replaces it entirely. See CHANGELOG.md for exactly what changed and why.

What VoiceMatrix is

VoiceMatrix is a Hebrew-first voice AI platform: phone-native AI agents that take inbound calls, place outbound calls, qualify leads, book appointments, and hand off to a human or to another agent — with a real public API, webhooks, an MCP server, and native CRM integrations behind it.

Base URL

text
https://api.voicematrix.ai/api/v1/ext

Every route in this documentation is relative to that base. There is no /v1 at the root — v1 is inside the /ext path, not a version prefix on the host.

The 60-second quickstart

bash
# 1. Mint a key — dashboard → Settings → API (self-serve since 2026-08-04)
#    You get the full key exactly once. It looks like: vm_live_<32 random characters>

# 2. Find out what your key can do (no scope required for this one)
curl https://api.voicematrix.ai/api/v1/ext/me \
  -H "X-API-Key: vm_live_your_key_here"

# 3. List your agents
curl https://api.voicematrix.ai/api/v1/ext/agents \
  -H "X-API-Key: vm_live_your_key_here"

# 4. Place an outbound call with one of them
curl -X POST https://api.voicematrix.ai/api/v1/ext/calls \
  -H "X-API-Key: vm_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"to": "+972501234567", "agent_id": "<agent-uuid-from-step-3>"}'

Authorization: Bearer vm_live_your_key_here works everywhere X-API-Key does — pick one convention and use it consistently.

What's actually here today

This section exists so you don't have to reverse-engineer what's real from what's aspirational. Every number is a route count from backend/internal/publicapi/routes.go, verified against the registered Gin routes, not a marketing figure.

SurfaceStateWhere
REST API (calls, leads, agents, knowledge, phone numbers, call control, webhooks)Live in productionendpoints.md, webhooks.md
OpenAPI 2.0 spec, drift-tested against the real routesLive, fixed 2026-08 after 4 months of serving broken JSONsdks-and-openapi.md
MCP server (9 read-only tools)Live in productionmcp-server.md
Official SDK (Python / TypeScript / npm / PyPI package)Does not exist yet — 4 attempts sit unmerged on feature branchessdks-and-openapi.md
Make.com custom appLive, 2 triggers + 2 actions, app-store listing pendingintegrations-crm-and-automation.md
Native CRM integrations (Salesforce, HubSpot, Google Calendar/Gmail)Live, OAuth-based, agent-scopedintegrations-crm-and-automation.md

Pages

  1. Authentication — API keys, scopes, tiers, rate limits, versioning, GET /me
  2. Resources
  3. Calls
  4. Leads
  5. Agents — everything the agent editor does: full configuration, delete/duplicate, simulations, security tests, drafts, integrations, calendar, share links, stats and usage
  6. Agent Webhook — call enrichment at call start and the call-end event, sent by the agent to your server
  7. Knowledge Base — per-agent, RAG-backed: text, URL and file sources, per-stage visibility, test search
  8. Phone Numbers — acquire and bind
  9. Call Control — hangup (and what's deliberately not here)
  10. Webhooks — real event catalog, signing, retries, replay, payload templating
  11. Errors — the error envelope, every error code with its HTTP status, field-level validation errors, delivery error classes
  12. MCP Server — connect Claude Code, Cursor, Claude Desktop
  13. SDKs & OpenAPI — the honest current state, and how to generate a client today
  14. Voice & Agent Capabilities — TTS/STT/LLM providers, multi-agent handoff, function tools
  15. Integrations — Make.com, Salesforce, HubSpot, Google Workspace
  16. Security & Data Residency — tenancy, encryption, what's honestly not encrypted yet
  17. Changelog

Code examples

Support

[email protected] · dashboard → Settings → API for key management.

All pages