How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

vexa-ai API

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.

vexa-ai API is one of 2 APIs that vexa-ai publishes on the 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.

This API exposes 101 operations across 84 paths, organized into 22 resource areas, and defines 99 schemas. It is described by OpenAPI 3.1.0, at version 2026-10-31.

Requests are made against a single base URL, https://api.cloud.vexa.ai.

101 operations 84 paths 99 schemas 5 DELETE40 GET4 PATCH42 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2026-10-31
Base URL
https://api.cloud.vexa.ai
Authentication
API Key
Resource Areas
22

Authentication & Security 1

vexa-ai API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (apiKey). By default, every request must be authenticated.

Paths & Operations 101

Across 84 paths, the API surfaces 101 operations — 5 DELETE, 40 GET, 4 PATCH, 42 POST, 10 PUT. They span 22 resource areas, including Api, Myroom, Abc Defg Hij, Acme, Admin, Agent, Auth, Bots, and 14 more. Each is listed below with its method, path, parameters, and response codes.

Api 26
GET
/
GET /
get → 200
POST
/
POST /
post → 201
PUT
/
PUT /
put body → 200
POST
/api/chat
Stream a chat turn returning Server-Sent Events.
post_api_chat body → 201
POST
/api/chat/reset
Reset a chat session.
post_api_chat_reset body → 201
GET
/api/meeting/relay-health
Get typed transcript-relay health status.
get_api_meeting_relay_health → 200
GET
/api/meeting/stream
Stream the merged transcript and copilot-output feed as Server-Sent Events.
get_api_meeting_stream 2 params → 200
POST
/api/meeting/{start}
Launch a live-meeting copilot with SSE merge of transcript and copilot output.
post_api_meeting_start 1 param → 201
GET
/api/meetings/live
Retrieve live-meeting copilot registrations.
get_api_meetings_live → 200
GET
/api/models
Fetch the resolved model names for this subject.
get_api_models → 200
GET
/api/routines
Fetch all routines for this subject.
get_api_routines → 200
POST
/api/routines
Create a new routine.
post_api_routines body → 201
PATCH
/api/routines/{name}/enabled
Enable or disable a routine.
patch_api_routines_name_enabled 1 param body → 200
GET
/api/sessions
Fetch all sessions for this subject.
get_api_sessions → 200
GET
/api/sessions/{session}/history
Fetch the chat history of a session.
get_api_sessions_session_history 1 param → 200
POST
/api/workspace/git-token
Save a reusable GitHub PAT for workspace git operations.
post_api_workspace_git_token → 201
GET
/api/workspace/git/show
Retrieve a commit's unified diff for highlighted rendering in the UI.
get_api_workspace_git_show → 200
POST
/api/workspace/init
Initialize the workspace.
post_api_workspace_init → 201
POST
/api/workspace/invites
Create an invite to share a workspace with a read/write contributor role.
post_api_workspace_invites → 201
POST
/api/workspace/invites/accept
Accept an invite and join a shared workspace.
post_api_workspace_invites_accept → 201
GET
/api/workspace/invites/preview
Preview an invite without granting membership or consuming a use.
get_api_workspace_invites_preview 1 param → 200
DELETE
/api/workspace/invites/{id}
Revoke an invite by id.
delete_api_workspace_invites_id 1 param → 200
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_swap body → 201
POST
/api/workspace/upload
Upload files to the workspace.
post_api_workspace_upload body → 201
GET
/api/workspace/{tree}
Read workspace tree, file content, or git state.
get_api_workspace_tree 1 param → 200
PUT
/v1
PUT /v1
put_v1 body → 200
Myroom 1
POST
/MyRoom
POST /MyRoom
post_MyRoom body → 201
Abc Defg Hij 1
POST
/abc-defg-hij
POST /abc-defg-hij
post_abc_defg_hij body → 201
Acme 1
POST
/acme/knowledge.git
POST /acme/knowledge.git
post_acme_knowledge_git body → 201
Admin 5
DELETE
/admin/tokens/{id}
Delete an API token
delete_admin_tokens_id 1 param → 200
POST
/admin/users
Create user
post_admin_users body → 201
GET
/admin/users/email/{email}
Resolve a returning user by email (find-or-create)
get_admin_users_email_email 1 param → 200
POST
/admin/users/{id}/tokens
Mint a scoped session token
post_admin_users_id_tokens 1 param body → 201
PATCH
/admin/users/{userId}
Update an account's limits and platform-billing fields.
patch_admin_users_userId 1 param body → 200
Agent 11
POST
/agent/chat
Dispatch a streamed chat turn (not available on hosted service or Kubernetes).
post_agent_chat body → 201
POST
/agent/events
Fire a triage on a new email by posting an event.
post_agent_events 1 param body → 202
POST
/agent/meeting/start
Start a live meeting copilot to surface decisions and action items during the call.
post_agent_meeting_start → 201
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_meeting_stream 3 params → 200
GET
/agent/workspace/attached
Check what workspace is currently attached and what is parked.
get_agent_workspace_attached → 200
GET
/agent/workspace/file
Read a workspace file.
get_agent_workspace_file 1 param → 200
GET
/agent/workspace/git
Get git state including branch, uncommitted changes, and recent commits.
get_agent_workspace_git → 200
POST
/agent/workspace/init
Initialize a fresh workspace (idempotent).
post_agent_workspace_init → 201
POST
/agent/workspace/swap
Swap in an external git repo as the active workspace.
post_agent_workspace_swap body → 201
GET
/agent/workspace/tree
Browse the file tree of the workspace knowledge graph.
get_agent_workspace_tree 1 param → 200
POST
/agent/workspace/upload
Add files to the workspace so agents can ground on them.
post_agent_workspace_upload body → 201
Auth 1
GET
/auth/me
Fetch the user's identity and account limits.
get_auth_me → 200
Bots 8
GET
/bots
List meetings.
get_bots 4 params → 200
POST
/bots
Spawn a bot on a meeting link.
post_bots → 201
POST
/bots/internal/callback/lifecycle
Receive lifecycle.v1 LifecycleEvent to advance FSM and persist to DB.
post_bots_internal_callback_lifecycle body → 201
GET
/bots/status
Fetch bot status.
get_bots_status → 200
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).
get_bots_platform_nativeMeetingId_chat 2 params → 200
POST
/bots/{platform}/{nativeMeetingId}/chat
Not implemented — no bot-command (send) backend in the 0.12 core.
post_bots_platform_nativeMeetingId_chat 2 params → 201
PUT
/bots/{platform}/{nativeMeetingId}/config
Update config — change language/task mid-call (currently returns 404 in v0.12 open-core).
put_bots_platform_nativeMeetingId_config 2 params body → 200
POST
/bots/{platform}/{nativeMeetingId}/speak
Make the bot speak — TTS into the call (currently returns 404 in v0.12 open-core).
post_bots_platform_nativeMeetingId_speak 2 params body → 201
Calendar 3
POST
/calendar/ical/…/basic.ics
POST /calendar/ical/…/basic.ics
post_calendar_ical_basic_ics body → 201
PUT
/calendar/ical/…/basic.ics
PUT /calendar/ical/…/basic.ics
put_calendar_ical_basic_ics body → 200
POST
/calendar/ical/…/private-…/basic.ics
POST /calendar/ical/…/private-…/basic.ics
post_calendar_ical_private_basic_ics body → 201
Events 1
POST
/events
Dispatch an event as a unit invocation.
post_events body → 202
Health 1
GET
/health
Fetch the health status of the agent-api service.
get_health → 200
Hooks 1
PUT
/hooks/vexa
PUT /hooks/vexa
put_hooks_vexa body → 200
Internal 1
POST
/internal/validate
A raw token → {userid, scopes, maxconcurrent, email, webhook} (fail-closed)
post_internal_validate 1 param body → 201
Invocations 1
POST
/invocations
Dispatch a unit; the sink every trigger funnels through.
post_invocations body → 201
Meetings 9
GET
/meetings
List meetings with lightweight rows.
get_meetings 4 params → 200
POST
/meetings
Plan a meeting on a link.
post_meetings → 201
GET
/meetings/{meetingId}
Single meeting — fetch full meeting detail with complete data.
get_meetings_meetingId 1 param → 200
POST
/meetings/{meetingId}/transcribe
Not implemented — no on-demand re-transcribe backend in the 0.12 core.
post_meetings_meetingId_transcribe 1 param → 201
DELETE
/meetings/{platform}/{nativeMeetingId}
Delete a planned meeting by native key or delete durable artifacts from a terminal meeting.
delete_meetings_platform_nativeMeetingId 2 params → 200
PATCH
/meetings/{platform}/{nativeMeetingId}
Edit a planned meeting by native key (resolves to your newest owned row).
patch_meetings_platform_nativeMeetingId 2 params body → 200
GET
/meetings/{platform}/{nativeMeetingId}/participants
Get meeting participants.
get_meetings_platform_nativeMeetingId_participants 2 params → 200
POST
/meetings/{platform}/{nativeMeetingId}/share
Create a share capability token for the meeting's transcript.
post_meetings_platform_nativeMeetingId_share 2 params → 200
POST
/meetings/{platform}/{nativeMeetingId}/workspace
Bind a meeting to a shared workspace.
post_meetings_platform_nativeMeetingId_workspace 2 params body → 200
Recordings 6
GET
/recordings
List recordings.
get_recordings → 200
DELETE
/recordings/{recordingId}
Delete one recording.
delete_recordings_recordingId 1 param → 200
GET
/recordings/{recordingId}
Recording detail.
get_recordings_recordingId 1 param → 200
GET
/recordings/{recordingId}/master
Master metadata (finalize-on-read).
get_recordings_recordingId_master 2 params → 200
GET
/recordings/{recordingId}/media/{mediaFileId}/download
Download a recording media file.
get_recordings_recordingId_media_mediaFileId_download 2 params → 200
GET
/recordings/{recordingId}/media/{mediaFileId}/raw
Download recording media byte stream.
get_recordings_recordingId_media_mediaFileId_raw 2 params → 200
Runtime 1
POST
/runtime/callback
Receive workload state/terminal ACK from runtime kernel.
post_runtime_callback body → 201
Transcripts 3
GET
/transcripts
Get transcripts.
get_transcripts → 200
POST
/transcripts/share/accept
Redeem a share token from another authenticated Vexa user to access a transcript.
post_transcripts_share_accept → 201
POST
/transcripts/{platform}/{nativeMeetingId}/share
Share a transcript.
post_transcripts_platform_nativeMeetingId_share 2 params → 200
User 17
GET
/user/calendar
Retrieve the first active calendar connection.
get_user_calendar → 200
PUT
/user/calendar
Create or update the first active calendar connection.
put_user_calendar body → 200
GET
/user/calendar/sync
Read the aggregate last synchronization result across all active connections.
get_user_calendar_sync → 200
POST
/user/calendar/sync
Synchronize all active calendar connections and return aggregate results.
post_user_calendar_sync → 200
GET
/user/calendars
Fetch all calendar connections for the user.
get_user_calendars → 200
POST
/user/calendars
Create a new calendar connection.
post_user_calendars body → 201
DELETE
/user/calendars/{calendarId}
Disconnect a calendar connection.
delete_user_calendars_calendarId 1 param → 204
PATCH
/user/calendars/{calendarId}
Update a calendar connection.
patch_user_calendars_calendarId 1 param body → 200
GET
/user/calendars/{calendarId}/sync
Read the last synchronization result for a calendar connection.
get_user_calendars_calendarId_sync 1 param → 200
POST
/user/calendars/{calendarId}/sync
Synchronize a calendar connection immediately.
post_user_calendars_calendarId_sync 1 param → 200
GET
/user/models
Read the account's LLM settings.
get_user_models → 200
PUT
/user/models
Configure the account's LLM settings.
put_user_models body → 200
GET
/user/transcription
Read the account's speech-to-text endpoint override.
get_user_transcription → 200
PUT
/user/transcription
Set the transcription backend for the user account.
put_user_transcription → 200
GET
/user/webhook
Read the account's webhook configuration.
get_user_webhook → 200
PUT
/user/webhook
Configure the account's webhook delivery.
put_user_webhook body → 200
GET
/user/webhook/deliveries
Read the account's webhook delivery history.
get_user_webhook_deliveries 1 param → 200
Models 1
GET
/v1/models
Verify the names exposed by your gateway's available models.
get_v1_models → 200
Vexa 1
PUT
/vexa
PUT /vexa
put_vexa body → 200
Ws 1
POST
/ws/authorize-subscribe
Identity-scoped subscribe authorization.
post_ws_authorize_subscribe → 201

Schemas 99

The contract defines 99 schemas that model the data the API accepts and returns. The most detailed are GetMeetingsMeetingidResponse (14 properties), GetUserWebhookDeliveriesResponse (9 properties), PostAgentChatResponse (7 properties), PatchUserCalendarsCalendaridResponse (7 properties). Each schema is shown below with its type and property counts.

PutRequest
object
2 properties
PutResponse
object
4 properties
PostMyroomRequest
object
4 properties
PostAbcDefgHijRequest
object
4 properties
PostAbcDefgHijResponse
object
1 property
PostAcmeKnowledgeGitRequest
object
3 properties
PostAdminUsersRequest
object
1 property 1 required
PostAdminUsersResponse
object
2 properties
GetAdminUsersEmailEmailResponse
object
2 properties
PostAdminUsersIdTokensRequest
object
2 properties 1 required
PostAdminUsersIdTokensResponse
object
3 properties
PatchAdminUsersUseridRequest
object
2 properties
PatchAdminUsersUseridResponse
object
2 properties
PostAgentChatRequest
object
3 properties 1 required
PostAgentChatResponse
object
7 properties
PostAgentEventsRequest
object
3 properties 3 required
PostAgentEventsResponse
object
2 properties
GetAgentMeetingStreamResponse
object
6 properties
GetAgentWorkspaceAttachedResponse
object
2 properties
GetAgentWorkspaceGitResponse
object
3 properties
PostAgentWorkspaceInitResponse
object
3 properties
PostAgentWorkspaceSwapRequest
object
3 properties
GetAgentWorkspaceTreeResponse
object
1 property
PostAgentWorkspaceUploadRequest
object
1 property 1 required
PostAgentWorkspaceUploadResponse
object
1 property
PostApiChatRequest
object
3 properties 1 required
PostApiChatResponse
object
7 properties
PostApiChatResetRequest
object
1 property
PostApiChatResetResponse
object
1 property
GetApiMeetingRelayHealthResponse
object
1 property
GetApiMeetingStreamResponse
object
6 properties
GetApiModelsResponse
object
4 properties
GetApiRoutinesResponse
object
1 property
PostApiRoutinesRequest
object
4 properties 3 required
PostApiRoutinesResponse
object
3 properties
PatchApiRoutinesNameEnabledRequest
object
1 property 1 required
PatchApiRoutinesNameEnabledResponse
object
4 properties
GetApiSessionsResponse
object
1 property
GetApiSessionsSessionHistoryResponse
object
1 property
PostApiWorkspaceInitResponse
object
3 properties
GetApiWorkspaceInvitesPreviewResponse
object
7 properties
PostApiWorkspaceSwapRequest
object
3 properties
PostApiWorkspaceUploadRequest
object
1 property 1 required
PostApiWorkspaceUploadResponse
object
1 property
GetAuthMeResponse
object
4 properties
GetBotsResponse
object
1 property
PostBotsInternalCallbackLifecycleRequest
object
1 property 1 required
PutBotsPlatformNativemeetingidConfigRequest
object
2 properties
PostBotsPlatformNativemeetingidSpeakRequest
object
1 property 1 required
PostCalendarIcalBasicIcsRequest
object
4 properties
PutCalendarIcalBasicIcsRequest
object
2 properties
PostCalendarIcalPrivateBasicIcsRequest
object
4 properties
PostCalendarIcalPrivateBasicIcsResponse
object
5 properties
PostEventsRequest
object
4 properties 4 required
PostEventsResponse
object
2 properties
GetHealthResponse
object
3 properties
PutHooksVexaRequest
object
3 properties
PutHooksVexaResponse
object
4 properties
PostInternalValidateRequest
object
1 property 1 required
PostInternalValidateResponse
object
5 properties
PostInvocationsRequest
object
5 properties 5 required
PostInvocationsResponse
object
1 property
GetMeetingsResponse
object
1 property
GetMeetingsMeetingidResponse
object
14 properties
PatchMeetingsPlatformNativemeetingidRequest
object
4 properties
PatchMeetingsPlatformNativemeetingidResponse
object
1 property
GetMeetingsPlatformNativemeetingidParticipantsResponse
object
6 properties
PostMeetingsPlatformNativemeetingidShareResponse
object
4 properties
PostMeetingsPlatformNativemeetingidWorkspaceRequest
object
1 property 1 required
PostMeetingsPlatformNativemeetingidWorkspaceResponse
object
1 property
GetRecordingsRecordingidMasterResponse
object
1 property
GetRecordingsRecordingidMediaMediafileidDownloadResponse
object
1 property
PostRuntimeCallbackRequest
object
1 property 1 required
PostTranscriptsPlatformNativemeetingidShareResponse
object
4 properties
GetUserCalendarResponse
object
3 properties
PutUserCalendarRequest
object
3 properties
PutUserCalendarResponse
object
3 properties
GetUserCalendarSyncResponse
object
1 property
PostUserCalendarSyncResponse
object
2 properties
GetUserCalendarsResponse
object
1 property
PostUserCalendarsRequest
object
4 properties 2 required
PostUserCalendarsResponse
object
7 properties
PatchUserCalendarsCalendaridRequest
object
5 properties
PatchUserCalendarsCalendaridResponse
object
7 properties
GetUserCalendarsCalendaridSyncResponse
object
4 properties
PostUserCalendarsCalendaridSyncResponse
object
5 properties
GetUserModelsResponse
object
6 properties
PutUserModelsRequest
object
5 properties
PutUserModelsResponse
object
6 properties
GetUserTranscriptionResponse
object
3 properties
GetUserWebhookResponse
object
4 properties
PutUserWebhookRequest
object
3 properties 1 required
PutUserWebhookResponse
object
3 properties
GetUserWebhookDeliveriesResponse
object
9 properties
PutV1Request
object
3 properties
PutV1Response
object
3 properties
GetV1ModelsResponse
object
1 property
PutVexaRequest
object
3 properties
PutVexaResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vexa-ai-openapi-generated.yml Raw ↑

Other APIs vexa-ai publishes across the network.

Vexa AI Meetings API
Where this information came from

This is an independent, third-party profile of vexa-ai API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.