Vexa LogoVexa
v0.6

Get Started with Vexa

Follow these steps to get your first transcription in under 5 minutes.

Progress
0%
1
Get Your API Key

Get your API key to authenticate your requests to Vexa.ai.

2
Start a Google Meet

Complete previous steps to unlock

Start a new Google Meet session and copy the meeting URL.

3
Start the Bot

Complete previous steps to unlock

Use the following command to start a bot in your Google Meet:

Please enter your API key and Google Meet URL first

Run this command in your terminal. The bot will request to join your meeting.

3.1
Let the Bot Join & Start Speaking

Complete previous steps to unlock

  1. Wait for the bot: After running the command, wait for about 10 seconds for the bot to request entry to your meeting.
  2. Allow the bot to enter: Look for the "MyMeetingBot" join request in your Google Meet and click "Allow" to let the bot join.
  3. Start speaking: Start speaking in your meeting. The bot will listen and transcribe your speech.
4
Get Transcription

Complete previous steps to unlock

After speaking for a few seconds, use this command to get the transcription:

Please enter your API key and Google Meet URL first
4.1
Are Transcripts Coming Through?

Complete previous steps to unlock

After running the command, check if you can see your transcripts in the response.

6
Stop the Bot

Complete previous steps to unlock

When you're done, use this command to stop the bot:

Please enter your API key and Google Meet URL first
Platform-Specific Guides
Microsoft Teams (Quickstart)
Get started with Microsoft Teams transcription in minutes
  1. Tenant permissions: Ensure your Microsoft 365 tenant/app has permissions to let a meeting bot join.
  2. Provide meeting link: Provide the Teams meeting link/ID to the Vexa API when creating a bot.
  3. Receive transcripts: Receive live transcripts via polling or WebSocket (see WebSocket section below).

Example API call:

# Replace placeholders with your actual endpoint and token
curl -X POST https://api.cloud.vexa.ai/bots \
  -H "Authorization: Bearer <API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "platform": "microsoft_teams",
    "meeting_url": "<TEAMS_MEETING_URL>",
    "language": "en"
  }'
WebSocket Streaming (Quickstart)
Stream transcripts in sub-second real-time with WebSocket
Authentication: Use your issued token to authenticate the WebSocket connection.
Connect: Connect to the transcripts WebSocket and listen for message events.
Handle reconnects: Implement reconnection logic as needed for production reliability.

Example WebSocket connection (JavaScript):

// Replace with your real WS URL and auth
const ws = new WebSocket("wss://api.cloud.vexa.ai/transcripts?bot_id=<BOT_ID>&token=<API_TOKEN>");

ws.onmessage = (evt) => {
  const msg = JSON.parse(evt.data);
  console.log("partial/final:", msg);
};

ws.onerror = (error) => {
  console.error("WebSocket error:", error);
};

ws.onclose = () => {
  console.log("WebSocket closed, implement reconnection logic");
};