Authentication

Vexa uses API keys for authentication. There are two types of API keys: User API keys and Admin API keys.

User API Keys

User API keys grant access to meeting operations: creating bots, fetching transcripts, and managing meetings. These keys are scoped to individual users and can be created through the Admin API or dashboard.

Include your User API key in the X-API-Key header for all REST API requests:

X-API-Key: your_user_api_key_here

Admin API Keys

Admin API keys provide full system access, including user management and token creation. These keys are configured at the server level and should be kept secure.

Include your Admin API key in the X-Admin-API-Key header for Admin API requests:

X-Admin-API-Key: your_admin_api_key_here

WebSocket Authentication

WebSocket connections authenticate using the same User API key, but passed as a query parameter (since browsers cannot set custom headers for WebSocket connections):

wss://api.vexa.ai/ws?api_key=your_user_api_key_here

Getting Your API Key

To get a User API key:

  1. Log in to the Vexa Dashboard
  2. Go to Settings or use the Admin API to create a token
  3. Copy your API key and store it securely

Note: API keys are only shown once at creation. If you lose your key, you'll need to create a new one.