Moveris Meet — API Reference¶

REST endpoints exposed by Moveris Meet 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]
        P4a[POST .../scan/:pid]
        P4b[POST .../retry/:pid]
        P4c[POST .../stop/:pid]
        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"]
}

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"
}

Manual Participant Control¶

Control frame collection for a single participant while the bot is in the call. Same bot-key auth as session create. Only one participant can accumulate frames at a time — a second scan or retry while another is accumulating returns 409.

POST /api/sessions/:id/scan/:participantId
POST /api/sessions/:id/retry/:participantId
POST /api/sessions/:id/stop/:participantId

Headers

409 Conflict — another participant is accumulating, the camera is off, or the session has already ended:

{ "error": "Another participant is currently being scanned" }

or

{ "error": "Camera is off — can't scan yet" }

or

{ "error": "This session has already ended" }

The third case fires when scan/retry targets a session that still exists (so it passes auth/org checks) but whose bot has already stopped — for example after the meeting ended or DELETE /api/sessions/:id was called.

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

{
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "in_call_recording"
}

Just the session ID and bot status — no participant list. Participant names, stages, and verdicts arrive only over the SSE stream below, which replays current state on connect.

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

Response 200 OK

{
  "analyses": [ ],
  "total": 0,
  "limit": 50,
  "offset": 0
}

Requires database persistence enabled for your deployment (501 otherwise). Bot-key callers only ever see their own org's history.

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 architecture
• Integration Guide — End-to-end integration walkthrough
• Session Lifecycle — Bot and participant state transitions
• Overview — Models — Supported model aliases for sessions
• Webhook Setup Guide — Configure webhook delivery