X-API-Key: Required for all regular client operations (e.g., managing bots, getting transcripts). Obtain your key from an administrator.
X-Admin-API-Key: Required only for administrative endpoints (prefixed with /admin). This key is configured server-side.

Include the appropriate header in your requests.

OpenAPI spec version: 1.2.0

Properties

start

start: number

end

end: number

text

text: string

language?

optional language: string

created_at?

optional created_at: string

speaker?

optional speaker: string

absolute_start_time?

optional absolute_start_time: string

Absolute start timestamp of the segment (UTC)

absolute_end_time?

optional absolute_end_time: string

Absolute end timestamp of the segment (UTC)

ValidationError

Properties

loc

loc: ValidationErrorLocItem[]

msg

msg: string

type

type: string

Type Aliases

BotStatusLabels

BotStatusLabels = object

Generated by orval v7.17.0 🍺 Do not edit manually. Vexa API Gateway

Main entry point for the Vexa platform APIs.

Provides access to:

Bot Management (Starting/Stopping transcription bots)
Transcription Retrieval
User & Token Administration (Admin only)

Authentication

Two types of API keys are used:

X-API-Key: Required for all regular client operations (e.g., managing bots, getting transcripts). Obtain your key from an administrator.
X-Admin-API-Key: Required only for administrative endpoints (prefixed with /admin). This key is configured server-side.

Include the appropriate header in your requests.

OpenAPI spec version: 1.2.0

Index Signature

[key: string]: string

MeetingResponseData

MeetingResponseData = object

JSON data containing meeting metadata like name, participants, languages, notes, and status reasons

Index Signature

[key: string]: unknown

MeetingStatus

MeetingStatus = typeof MeetingStatus[keyof typeof MeetingStatus]

Meeting status values with their sources and transitions.

Status Flow: requested -> joining -> awaiting_admission -> active -> stopping -> completed | | v v -> failed failed failed

Sources:

requested: POST bot API (user)
joining: bot callback
awaiting_admission: bot callback
active: bot callback
stopping: user (stop bot API)
completed: user, bot callback
failed: bot callback, validation errors

Platform

Platform = typeof Platform[keyof typeof Platform]

Platform identifiers for meeting platforms. The value is the external API name, while the bot_name is what's used internally by the bot.

RequestBotProxyBotsPostBody

RequestBotProxyBotsPostBody = object

Properties

platform

platform: Platform

native_meeting_id

native_meeting_id: string

The platform-specific ID for the meeting (e.g., Google Meet code, Teams ID)

bot_name?

optional bot_name: string

Optional name for the bot in the meeting

language?

optional language: string

Optional language code for transcription (e.g., 'en', 'es')

task?

optional task: string

Optional task for the transcription model (e.g., 'transcribe', 'translate')

passcode?

optional passcode: string

Optional passcode for the meeting (Teams only)

UpdateMeetingDataProxyMeetingsPlatformNativeMeetingIdPatchBody

UpdateMeetingDataProxyMeetingsPlatformNativeMeetingIdPatchBody = object

Properties

data

data: UpdateMeetingDataProxyMeetingsPlatformNativeMeetingIdPatchBodyData

Schema for updating meeting data fields - restricted to user-editable fields only

UpdateMeetingDataProxyMeetingsPlatformNativeMeetingIdPatchBodyData

UpdateMeetingDataProxyMeetingsPlatformNativeMeetingIdPatchBodyData = object

Schema for updating meeting data fields - restricted to user-editable fields only

Properties

name?

optional name: string

Meeting name/title

participants?

optional participants: string[]

List of participant names

languages?

optional languages: string[]

List of language codes detected/used in the meeting

notes?

optional notes: string

Meeting notes or description

ValidationErrorLocItem

ValidationErrorLocItem = string | number

Generated by orval v7.17.0 🍺 Do not edit manually. Vexa API Gateway

Main entry point for the Vexa platform APIs.

Provides access to:

Bot Management (Starting/Stopping transcription bots)
Transcription Retrieval
User & Token Administration (Admin only)

Authentication

Two types of API keys are used:

X-API-Key: Required for all regular client operations (e.g., managing bots, getting transcripts). Obtain your key from an administrator.
X-Admin-API-Key: Required only for administrative endpoints (prefixed with /admin). This key is configured server-side.

Include the appropriate header in your requests.

OpenAPI spec version: 1.2.0