# vexa-ai API

**Canonical:** https://apis.io/apis/vexa-ai/vexa-ai-api/  
**Provider:** vexa-ai — https://apis.io/providers/vexa-ai/  
**Base URL:** https://api.cloud.vexa.ai  
**Documentation:** https://docs.vexa.ai/api/agent.md

vexa-ai API is one of 2 APIs that [vexa-ai](https://apis.io/providers/vexa-ai/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

vexa-ai API as documented publicly: 101 operations. Contract generated from the documentation by API Evangelist (2026-10-31); not the provider's own document.

## Operations (60 of 101)

| Method | Path | Summary |
|---|---|---|
| GET | `/` | GET / |
| POST | `/` | POST / |
| PUT | `/` | PUT / |
| POST | `/MyRoom` | POST /MyRoom |
| POST | `/abc-defg-hij` | POST /abc-defg-hij |
| POST | `/acme/knowledge.git` | POST /acme/knowledge.git |
| DELETE | `/admin/tokens/{id}` | Delete an API token |
| POST | `/admin/users` | Create user |
| GET | `/admin/users/email/{email}` | Resolve a returning user by email (find-or-create) |
| POST | `/admin/users/{id}/tokens` | Mint a scoped session token |
| PATCH | `/admin/users/{userId}` | Update an account's limits and platform-billing fields. |
| POST | `/agent/chat` | Dispatch a streamed chat turn (not available on hosted service or Kubernetes). |
| POST | `/agent/events` | Fire a triage on a new email by posting an event. |
| POST | `/agent/meeting/start` | Start a live meeting copilot to surface decisions and action items during the call. |
| GET | `/agent/meeting/stream` | Stream the merged transcript and copilot-output feed for a live meeting (not available on hosted service or Kubernetes). |
| GET | `/agent/workspace/attached` | Check what workspace is currently attached and what is parked. |
| GET | `/agent/workspace/file` | Read a workspace file. |
| GET | `/agent/workspace/git` | Get git state including branch, uncommitted changes, and recent commits. |
| POST | `/agent/workspace/init` | Initialize a fresh workspace (idempotent). |
| POST | `/agent/workspace/swap` | Swap in an external git repo as the active workspace. |
| GET | `/agent/workspace/tree` | Browse the file tree of the workspace knowledge graph. |
| POST | `/agent/workspace/upload` | Add files to the workspace so agents can ground on them. |
| POST | `/api/chat` | Stream a chat turn returning Server-Sent Events. |
| POST | `/api/chat/reset` | Reset a chat session. |
| GET | `/api/meeting/relay-health` | Get typed transcript-relay health status. |
| GET | `/api/meeting/stream` | Stream the merged transcript and copilot-output feed as Server-Sent Events. |
| POST | `/api/meeting/{start}` | Launch a live-meeting copilot with SSE merge of transcript and copilot output. |
| GET | `/api/meetings/live` | Retrieve live-meeting copilot registrations. |
| GET | `/api/models` | Fetch the resolved model names for this subject. |
| GET | `/api/routines` | Fetch all routines for this subject. |
| POST | `/api/routines` | Create a new routine. |
| PATCH | `/api/routines/{name}/enabled` | Enable or disable a routine. |
| GET | `/api/sessions` | Fetch all sessions for this subject. |
| GET | `/api/sessions/{session}/history` | Fetch the chat history of a session. |
| POST | `/api/workspace/git-token` | Save a reusable GitHub PAT for workspace git operations. |
| GET | `/api/workspace/git/show` | Retrieve a commit's unified diff for highlighted rendering in the UI. |
| POST | `/api/workspace/init` | Initialize the workspace. |
| POST | `/api/workspace/invites` | Create an invite to share a workspace with a read/write contributor role. |
| POST | `/api/workspace/invites/accept` | Accept an invite and join a shared workspace. |
| GET | `/api/workspace/invites/preview` | Preview an invite without granting membership or consuming a use. |
| DELETE | `/api/workspace/invites/{id}` | Revoke an invite by id. |
| POST | `/api/workspace/swap` | Attach an external git repo as the active workspace (parks the current one; omit `repo` to swap back to the seed). |
| POST | `/api/workspace/upload` | Upload files to the workspace. |
| GET | `/api/workspace/{tree}` | Read workspace tree, file content, or git state. |
| GET | `/auth/me` | Fetch the user's identity and account limits. |
| GET | `/bots` | List meetings. |
| POST | `/bots` | Spawn a bot on a meeting link. |
| POST | `/bots/internal/callback/lifecycle` | Receive lifecycle.v1 LifecycleEvent to advance FSM and persist to DB. |
| GET | `/bots/status` | Fetch bot status. |
| GET | `/bots/{platform}/{nativeMeetingId}/chat` | Restored, empty — the owner boundary is real; the message list is always empty (0.12 does not persist in-meeting chat server-side). |
| POST | `/bots/{platform}/{nativeMeetingId}/chat` | Not implemented — no bot-command (send) backend in the 0.12 core. |
| PUT | `/bots/{platform}/{nativeMeetingId}/config` | Update config — change language/task mid-call (currently returns 404 in v0.12 open-core). |
| POST | `/bots/{platform}/{nativeMeetingId}/speak` | Make the bot speak — TTS into the call (currently returns 404 in v0.12 open-core). |
| POST | `/calendar/ical/…/basic.ics` | POST /calendar/ical/…/basic.ics |
| PUT | `/calendar/ical/…/basic.ics` | PUT /calendar/ical/…/basic.ics |
| POST | `/calendar/ical/…/private-…/basic.ics` | POST /calendar/ical/…/private-…/basic.ics |
| POST | `/events` | Dispatch an event as a unit invocation. |
| GET | `/health` | Fetch the health status of the agent-api service. |
| PUT | `/hooks/vexa` | PUT /hooks/vexa |
| POST | `/internal/validate` | A raw token → {user_id, scopes, max_concurrent, email, webhook_*} (fail-closed) |

…and 41 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/vexa-ai/openapi/_ae-authored/vexa-ai-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/vexa-ai/json-schema/vexa-ai-get-user-webhook-deliveries-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/vexa-ai/json-schema/vexa-ai-put-user-models-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/vexa-ai/json-schema/vexa-ai-post-agent-chat-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/vexa-ai/json-schema/vexa-ai-post-api-chat-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/vexa-ai/json-schema/vexa-ai-get-meetings-platform-nativemeetingid-participants-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/vexa-ai/json-schema/vexa-ai-get-user-models-response-schema.json

## Other vexa-ai APIs (1)

- [Vexa AI Meetings API](https://apis.io/apis/vexa-ai/vexa-ai-meetings-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/vexa-ai/vexa-ai-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/vexa-ai/.