Skip to navigation

Changelog

Version 1 (2026-10-01)

First version of the public API. The version is a date and today it is the only one. A version is only extended, never changed: before removing something from an existing version there is 12 months’ notice.

Basics

  • API keys per Organization, in the live (vx_live_) and test (vx_test_) environments, with scopes, expiry, rotation with overlap, revocation and allowed addresses.
  • Cursor pagination on every list.
  • Idempotency with the Idempotency-Key header.
  • Request limits per key and per Organization, declared in the RateLimit-* headers.
  • Errors with a single shape and stable codes.
  • GET /v1/me to check a key and GET /v1/openapi.json for the OpenAPI description.

Reads

  • Calls: list with filters, detail with Report card and collected data, transcript, events and period summary.
  • Agents, Lines, usage and concurrent calls.
  • Usage: added minutes.welcome, the welcome minutes of a new customer (granted, remaining, expiry, state), used first. Minutes only.
  • Usage: added the debt (minutes.debt), the top-ups one by one with their expiry (minutes.credit_packs), the source of the minutes (minutes.source), the yearly pool (minutes.pool) and the pay-as-you-go minutes (minutes.overage_billing). Extra fields only, units only: never an amount of money.
  • Knowledge base documents and Knowledge base search.
  • Campaigns and contacts, and the state of outbound calls.

Actions

  • Starting an outbound call.
  • Campaigns: creation, contact upload, start and pause.
  • Knowledge base: upload, re-indexing and deletion of documents.
  • Agents: suspension and resumption, variables with a fixed value, Schedules and closures.
  • Sessions for the web widget.
  • Caller requests: search, export, erasure and objection to calls.

Webhooks

  • Signed endpoints, with events for calls, campaigns, Knowledge base, usage, Lines, license, payments and SMS.
  • At-least-once delivery, with 8 attempts over about 24 hours, test and resend.

MCP server

  • MCP server to connect an AI assistant, with an API key or OAuth 2.1.
  • Read tools and three actions, with the same scopes and limits as the API.