Skip to main content
The Voice Agents API lets you onboard workspaces, create and manage assistants, initiate outbound calls, and handle real-time webhook events programmatically.

​
Base URL

All API requests target the production server: 
https://api.voice-agents.miraiminds.co
A staging environment is also available for testing: 
https://api.stage.voice-agent.miraiminds.co

​
Authentication

Every request must include two API key headers:
HeaderDescription
x-public-keyYour public API key for identification
x-private-keyYour private API key for authorization
Most endpoints also require a workspace header to scope requests to a specific workspace. 
curl -X POST https://api.voice-agents.miraiminds.co/v2/call/initiate \
  -H "x-public-key: pk_your_public_key" \
  -H "x-private-key: sk_your_private_key" \
  -H "workspace: your_workspace_id" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Contact sneh@miraiminds.co to obtain your API keys and workspace ID.

​
API endpoints

The API is organized into the following groups:

Onboarding

Register a Shopify store and create a workspace with billing configuration.

Assistant

Create, retrieve, and update voice agent configurations.

Call

Initiate outbound calls and abort queued calls.

Webhooks

Receive real-time call status and action events.

Organization

Archive and unarchive organizations and workspaces.

Voice Gallery

Browse available voice options for your agents.

​
Common error codes

CodeMeaning
200Success
201Resource created
400Bad request — check your request body or parameters
401Unauthorized — missing or invalid API keys
403Forbidden — insufficient permissions
404Not found — resource does not exist
429Rate limit exceeded — wait before retrying
500Internal server error

​
Rate limits

The API enforces rate limits to ensure stability. If you receive a 429 response, wait before retrying. Assistant updates have a cooldown period to prevent overlapping update operations.
Keep your x-private-key secure. Never expose it in client-side code or public repositories.