Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.voxworks.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
API Overview

The Voxworks API lets you create contacts, schedule calls, retrieve call results, manage lists and objects, and receive inbound automation webhooks.

​
Base URL

https://voxworks.ai
All public API endpoints in this reference are under /api/v1.

​
Authentication

Most endpoints require a bearer API key: 
Authorization: Bearer YOUR_API_KEY
Webhook trigger URLs use a token in the path instead. If webhook HMAC signing is configured, include X-Webhook-Signature with the SHA-256 HMAC signature.

​
Content Type

Send JSON request bodies with: 
Content-Type: application/json

​
Errors

Errors use a consistent JSON shape: 
{
  "success": false,
  "message": "Invalid API key"
}
Rate-limited responses return 429 and include Retry-After, X-RateLimit-Limit, and X-RateLimit-Remaining headers.