VEXIUM VOICE / API V1

Give your workflows a voice.

A stable API for connecting calls, appointments, agents, knowledge, and deliveries to the software already running your business.

Open OpenAPI Create a key

api.vexiumvoice.app

API available200 OK

GET/v1/whoami

{
  "authenticated_as": "api_key",
  "livemode": false,
  "key_prefix": "vx_test_••••••••",
  "scopes": ["calls:read"]
}

Stable version: v1
Authentication: Bearer token

Base URL

Every public route starts from this origin.

https://api.vexiumvoice.app/v1

FIRST CONNECTION

From zero to an authenticated response.

Create a key in the dashboard, store it as an environment variable, and verify its identity before building the rest of your integration.

01
Create a key
Choose test or production and grant only the permissions your system needs. The full secret is shown once.
02
Keep it out of code
Set VEXIUM_API_KEY in your server's secret manager. Never send it from the browser.
03
Verify the credential
GET /whoami confirms the account, mode, and permissions without returning the secret.

Your first request

curl "https://api.vexiumvoice.app/v1/whoami" \
  -H "Authorization: Bearer $VEXIUM_API_KEY"

Response

{
  "authenticated_as": "api_key",
  "livemode": false,
  "tenant": { "id": "…", "slug": "your-business" },
  "key_prefix": "vx_test_••••••••",
  "scopes": ["calls:read"]
}

CAPABILITY SCOPES

Every key does exactly what you authorize.

Read and write permissions are granted per resource. Separate integrations and revoke one without interrupting the others.

Agents

Read and update hours, services, menus, policies, and allowed voices.

agents:readagents:write

Calls

Read call history, transcripts, outcomes, and analytics.

calls:read

Appointments & leads

Read captures and manage confirmations, cancellations, or no-shows.

captures:readcaptures:write

Knowledge

List, upload, and remove documents; test what your agent would answer.

knowledge:readknowledge:write

Deliveries

Configure webhooks, test connections, and retry failed deliveries.

connections:readconnections:write

Usage

Read calls, minutes, and current-period limits.

usage:read

TEST / LIVE

The credential determines the mode: use vx_test_ for testing and vx_live_ for production. Test keys cannot modify data without an isolated test environment.

CLAUDE CODE

Give it the contract before the task.

Paste this prompt into Claude Code. It points to the current contract, explains authentication, and sets the security boundaries it must preserve.

The prompt never includes your key. Configure VEXIUM_API_KEY separately in your local environment or secret manager.

bootstrap-prompt.txt

Integrate the Vexium Voice API into this project.

Before writing code, read:
- https://api.vexiumvoice.app/v1/llms.txt
- https://api.vexiumvoice.app/v1/openapi.json

Use https://api.vexiumvoice.app/v1 as the base URL. Read the API key only from the VEXIUM_API_KEY environment variable and send it as "Authorization: Bearer <key>". Never hardcode, log, persist, or expose the key in client-side code. Start by calling GET /whoami to verify the account, test/live mode, and granted scopes. Request only the scopes this integration needs, handle structured API errors and rate-limit headers, and show me the proposed changes before modifying files.

OPERATIONAL SECURITY

Credentials belong on servers, not in interfaces.

One-time reveal

Vexium shows the secret when a key is created or rotated and cannot display it again. Rotate it if it is lost.

Least privilege

Create one key per integration, restrict its scopes, and stay in test mode until you are ready for live data.

Rotation without downtime

Rotate with a grace period, update your system, and immediately revoke any exposed key.

Never paste keys into tickets, chats, repositories, prompts, or frontend code. Do not record them in logs or analytics tools.

A contract for people and machines.

OpenAPI JSONCanonical schema for clients, SDKs, and validation.Open ↗llms.txtCompact context for agents and AI tools.Open ↗Vexium dashboardCreate, rotate, and revoke your API keys.Open ↗