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.

As of v0.10.4, Vexa joins Zoom meetings via the Zoom Web Client by default — no Zoom Marketplace listing, no OAuth setup, no SDK credentials required. The bot opens app.zoom.us/wc/... in a Playwright-driven browser, fills the bot name, joins audio, and starts transcribing. Same API call as Google Meet and Microsoft Teams. The legacy Native SDK path is still available for operators who already have it configured: opt in by setting ZOOM_SDK=true plus ZOOM_CLIENT_ID and ZOOM_CLIENT_SECRET on meeting-api / runtime-api. See Zoom Integration Setup Guide for the SDK setup. Most users won’t need it.
Marketplace note (SDK path only): Zoom Marketplace approval can take weeks to months. Before approval, you should assume you can reliably join only meetings created/hosted by the authorizing account. The hosted Vexa Zoom app is not approved at the time of writing. The Web Client default path has no Marketplace dependency.

​
Native meeting ID and passcode

For Zoom, you must pass the numeric meeting ID (9-11 digits):
  • URL: https://us05web.zoom.us/j/12345678901?pwd=...
  • native_meeting_id: 12345678901
If your URL includes ?pwd=..., you may pass it as passcode: 
{
  "platform": "zoom",
  "native_meeting_id": "12345678901",
  "passcode": "YOUR_PWD"
}
ZoomGov URLs (zoomgov.com) are also supported with the same format.
Zoom Events links (events.zoom.us) are not supported. Zoom Events uses unique per-registrant join links that cannot be shared with a bot.

​
Setup

​
Default (Web Client)

No setup. Send the same POST /bots payload you’d send for google_meet or teams. The bot opens Zoom’s browser client, joins, and transcribes.

​
Native SDK path (opt-in)

If you’ve already obtained Zoom Marketplace credentials and prefer the Native SDK route:
  1. Follow the Zoom Integration Setup Guide for the OAuth + OBF flow.
  2. Set on meeting-api / runtime-api:
    • ZOOM_SDK=true
    • ZOOM_CLIENT_ID=...
    • ZOOM_CLIENT_SECRET=...
  3. Bots created with platform=zoom will dispatch to the SDK path instead of the Web Client.

​
API example

curl -X POST "$API_BASE/bots" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $API_KEY" \
  -d '{
    "platform": "zoom",
    "native_meeting_id": "YOUR_MEETING_ID",
    "passcode": "YOUR_PWD",
    "recording_enabled": true,
    "transcribe_enabled": true,
    "transcription_tier": "realtime"
  }'