Skip to main content

API Overview

The Vagary Voice API provides RESTful endpoints for managing voice agents, conversations, and analytics.

Base URL​

https://api.vagaryvoice.cloud/v1

Authentication​

All API requests require authentication via API key:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.vagaryvoice.cloud/v1/bots

Get your API key from the Dashboard Settings.

Rate Limits​

PlanRequests/minuteConcurrent connections
Starter6010
Pro30050
EnterpriseCustomCustom

Response Format​

All responses are JSON:

{
  "success": true,
  "data": { ... },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

Error Handling​

Errors follow standard HTTP status codes:

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request body is invalid",
    "details": { ... }
  }
}
Status CodeDescription
400Bad Request - Invalid parameters
401Unauthorized - Invalid API key
403Forbidden - Insufficient permissions
404Not Found - Resource doesn't exist
429Too Many Requests - Rate limit exceeded
500Server Error - Contact support

Endpoints​

Voice Bots​

  • GET /bots - List all bots
  • POST /bots - Create a new bot
  • GET /bots/{id} - Get bot details
  • PATCH /bots/{id} - Update a bot
  • DELETE /bots/{id} - Delete a bot

Conversations​

  • GET /conversations - List conversations
  • GET /conversations/{id} - Get conversation details
  • GET /conversations/{id}/transcript - Get transcript

Analytics​

  • GET /analytics/usage - Usage statistics
  • GET /analytics/performance - Performance metrics

Webhooks​

  • POST /webhooks - Register webhook
  • GET /webhooks - List webhooks
  • DELETE /webhooks/{id} - Remove webhook

SDKs​

Official SDKs are available for:

Next Steps​