API Reference

Complete reference documentation for the Vexa API.

Base URL

All API endpoints are relative to:

https://api.vexa.ai/v1

Response Format

All responses are returned in JSON format. Successful responses include the requested data in the data field. Error responses include anerror object with details about what went wrong.

Success Response

{
  "data": {
    "id": "bot_123",
    "name": "Meeting Bot",
    "status": "active"
  }
}

Error Response

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key"
  }
}

Rate Limiting

The API implements rate limiting to ensure fair usage. Rate limits vary by plan tier. Current rate limit status is returned in the headers of each response:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 98
X-RateLimit-Reset: 1625169710