Tools

List Sessions

Retrieves a paginated list of sessions for the organisation. Supports extensive filtering by time range, duration, user, space, tags, and search terms. Use this to find sessions, check session history, or monitor active sessions.

List Spaces

Retrieves a paginated list of spaces in the organisation. Supports filtering by session, tags, user, date range, and search terms. Use this to browse available virtual classrooms.

Update Session

Updates a session's name and/or recording access policy. Use this to rename sessions or control who can view session recordings.

Launch Space

Creates a new virtual classroom space or retrieves an existing one, and generates a join URL for a user. Use this to set up a teaching session with configured recording, transcription, features, and user roles. Returns the join URL that can be embedded in an iframe or used for redirection.

Get Recording

Retrieves the recording URL for a session. The returned URL provides access to an interactive recording where users can replay events, download resources, and switch between different participants' perspectives. The recording URL is valid for up to 3 hours.

List Users

Retrieves a paginated list of users in the organisation. Supports filtering by role, space, session, and search terms.

Get Transcript

Provides a downloadable JSON transcription for a session. Transcription must have been enabled and finished processing. The download contains spoken text, timestamps, participant IDs, and breakout IDs.

Get Session

Retrieves detailed information about a specific session by its UUID. Returns participant profiles, timing, recording status, summary, and associated space details.

Remove User

Removes a user from the organisation. This is a destructive action and cannot be undone.

Delete Space Recordings

Permanently deletes audio/video, recorded events, and transcripts for every session in a space. The space and basic session metadata remain available. Find the space UUID with list_spaces.

Delete Session Recordings

Permanently deletes a session’s audio/video, recorded events, and transcript. Basic session metadata remains available. Find the session UUID with list_sessions.