Meeting Liveness Bot — API Reference¶

REST endpoints exposed by the Meeting Liveness Bot service. Base URL: https://<bot-url> (provided by Moveris for your environment).

Endpoint Map¶

flowchart TB
    subgraph M2M["M2M — Bearer sk-bot-*"]
        P1[POST /api/sessions]
        P2[GET /api/sessions/:id]
        P3[DELETE /api/sessions/:id]
        P4[GET /api/sessions/:id/events]
        P5[GET /api/analyses]
        P6[GET/PUT /api/settings/api-key]
    end

    subgraph Token["Interview token — no API key"]
        T1[GET /api/interview/:token]
        T2[GET /api/interview/:token/events]
        T3[GET /interview/* SPA]
    end

    subgraph Platform["Moveris platform — bot validates keys"]
        V1[POST /api/auth/v1/org-bot-keys/validate/]
    end

Authentication¶

Machine-to-machine (your backend)¶

Authorization: Bearer sk-bot-<your-bot-key>

Required for all /api/sessions routes and settings endpoints.

Interview token (read-only observer)¶

Routes under /api/interview/:token use the signed interviewToken from session creation. No Authorization header.

Sessions¶

Create Session¶

Start a bot for a video meeting.

POST /api/sessions

Headers

Request body

{
  "meetingUrl": "https://meet.google.com/abc-defg-hij",
  "model": "mixed-10-v3_1",
  "targetParticipantNames": ["John Smith"],
  "excludeParticipantNames": ["Jane Doe"],
  "bgSegmentation": false
}

Response 200 OK

{
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "botId": "bot_abc123",
  "status": "bot_created",
  "interviewToken": "eyJzZXNzaW9uSWQiOiI1NTBlODQwMC4uLiJ9.abc123sig",
  "message": "Bot is being created and will join the meeting shortly"
}

Get Session¶

Retrieve session state and stored results.

GET /api/sessions/:id

Headers

Response 200 OK

Returns session metadata, bot status, participants, and analysis results (shape varies by deployment and database configuration).

Delete Session¶

Stop the bot and end the session.

DELETE /api/sessions/:id

Headers

Response 200 OK

{
  "status": "stopped"
}

Session Events (SSE)¶

Real-time session updates for authenticated clients.

GET /api/sessions/:id/events

Headers

Returns a Server-Sent Events (SSE) stream with bot status changes and participant verdict updates.

Event types

Interview (Token Auth)¶

Resolve Interview Token¶

Validate a token and return session status. Used by the interviewer SPA on page load.

GET /api/interview/:token

No authentication header. The token is passed in the URL path.

Response 200 OK

Session summary including status and participant list.

Interview Events (SSE)¶

Real-time participant updates for the interviewer view.

GET /api/interview/:token/events

No authentication header. Opens an SSE stream for live verdict updates.

Interviewer SPA¶

Serves the read-only React UI for observers.

GET /interview/*

No API key. The app route expects the signed token in the path: /interview/<interviewToken>.

Analysis History¶

List Analyses¶

Paginated history of past analyses (when database persistence is enabled).

GET /api/analyses

Headers

Query parameters and response shape depend on deployment configuration.

Settings (Browser UI)¶

These endpoints support the bot's web UI for org API key management. M2M integrations typically configure the Moveris API key through Moveris staff or environment variables instead.

Error Responses¶

All errors return:

{
  "error": "Human-readable error message"
}

Moveris Platform Endpoints (Bot Validation)¶

The bot validates your sk-bot- key against the Moveris Developer Portal API (not the bot itself):

POST https://<moveris-api-url>/api/auth/v1/org-bot-keys/validate/
Content-Type: application/json

{
  "key": "sk-bot-<your-bot-key>"
}

Success response (wrapped in the standard Moveris API envelope):

{
  "data": {
    "organization_id": 42,
    "organization_name": "Your Organization",
    "organization_slug": "your-org",
    "bot_display_name": "Liveness Verifier",
    "logo_url": "https://example.com/logo.png",
    "primary_color": "#0066ff"
  },
  "success": true
}

Related¶

• How It Works — Pipeline and internal modules
• Integration Guide — End-to-end integration walkthrough
• Session Lifecycle — Bot and participant state transitions
• Fast Check — Underlying Moveris liveness endpoint used by the bot
• Webhook Setup Guide — Configure webhook delivery