Skip to main content

Documentation Index

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

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

Vexa Dashboard is an open-source Next.js web UI for Vexa. It’s a fully functional application for joining meetings, viewing live transcripts, managing users/tokens, and reviewing transcript history — and it’s also a great starting point for building your own integration. Fork it, use it as a reference, or build on top of it. Location: services/dashboard/ in the Vexa monorepo

​
Use It as a Reference

The dashboard codebase contains working examples of how to integrate with the Vexa API and WebSocket. Use these as code snippets or patterns for building your own application:
WhatFileDescription
REST API clientsrc/lib/api.tsAPI wrapper for bots, meetings, transcripts, recordings
WebSocket hooksrc/hooks/use-vexa-websocket.tsReact hook for WebSocket connection, subscription, and message handling
Live transcriptssrc/hooks/use-live-transcripts.tsReal-time transcript rendering with deduplication and speaker grouping
Meetings storesrc/stores/meetings-store.tsZustand store for meeting state management
Meeting detail pagesrc/app/meetings/[id]/page.tsxFull meeting view with transcript, recording playback, and metadata
API config routesrc/app/api/config/route.tsServer-side API configuration and proxying

​
What You Need

  • A reachable Vexa API Gateway URL (typically http://<host>:8056)
  • The Vexa Admin API token (the ADMIN_API_TOKEN from your Vexa deployment, set as VEXA_ADMIN_API_KEY in the dashboard)

​
Run With Docker

docker run --rm -p 3000:3000 \
  -e VEXA_API_URL=http://your-vexa-host:8056 \
  -e VEXA_ADMIN_API_KEY=your_admin_api_token \
  vexaai/vexa-dashboard:latest
Production: Use immutable tags (e.g., 0.10.0-260405-0108) instead of :latest for reproducible deployments.
Then open http://localhost:3000.

​
Local Development

git clone https://github.com/Vexa-ai/vexa.git
cd vexa/services/dashboard
npm install
cp .env.example .env.local
# edit .env.local: VEXA_API_URL + VEXA_ADMIN_API_KEY
npm run dev
Local dev server runs on http://localhost:3001.