The Voxeme API (documented in OpenAPI format) is currently in alpha. While all endpoints are functional, they are subject to change as we continue to enhance our omni-channel voice operating system.

​
Local Development

You can test the Voxeme API using any REST client that supports OpenAPI/Swagger specifications. Here’s how to get started:

​
Using REST Clients

  1. Download our OpenAPI specification from /api-reference/openapi.json
  2. Import the specification into your preferred REST client:

This will automatically configure all available endpoints, request/response schemas, and authentication requirements in your REST client.

​
CLI Development

If you prefer using our CLI tool, follow these steps:

Step 1: Install the Voxeme CLI:

npm i -g @voxeme/cli

Step 2: Navigate to your project directory and start the development server:

voxeme dev

Your local development environment will be available at http://localhost:3000.