AVKUL ERPDocs
SCREEN GUIDE · 11 OCT 2026

Live-class workspace

Use live-class workspace in the school workspace. Schedule live lessons, manage their lifecycle and maintain recordings where configured.

Try guided demo →Download guide ↓
Live-class workspace — illustrated workflow banner

What you can do

01

Get

02

Update

03

Remove

04

Start

05

End

06

Finalize Recording

Access & setup

Intended access: Assigned account with the required permissions.

  • A school account with the permissions shown below.
  • Choose the relevant school, academic session or child before working.
Required permission keys
live-class:viewlive-class:updatelive-class:delete

Use the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.

How the workflow works

  1. 01

    Create the class for the intended learners

    A school account with the permissions shown below.

  2. 02

    Review the scheduled time and class details

    Update is part of the documented workflow.

  3. 03

    Start the class and use the available joining experience

    Remove is part of the documented workflow.

  4. 04

    End the session and review an available recording

    Review the result in the connected record or workspace before moving on.

Request fields to understand

Source-declared fields used by related operations; each operation has its own validation and scope.

FieldDeclared typeInput
titlestringOptional
scheduledAtstringOptional
durationMinnumberOptional

Rules & current limits

  • Camera/microphone, media delivery and recordings depend on browser permissions and service configuration; a schedule alone does not prove media connectivity.

Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.

Try live-class workspace

Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.

Launch guided demo →

API & permissions reference

These are the source-matched API operations connected to this guide. Reading this reference does not execute any request.

7 source-declared operations
GET/api/v1/live-classes/:id

Get

live-class:view
PATCH/api/v1/live-classes/:id

Update

live-class:update

Declared request fields: title (optional), scheduledAt (optional), durationMin (optional).

DELETE/api/v1/live-classes/:id

Remove

live-class:delete
POST/api/v1/live-classes/:id/start

Start

live-class:update
POST/api/v1/live-classes/:id/end

End

live-class:update
POST/api/v1/live-classes/:id/recording/finalize

Finalize Recording

live-class:update
POST/api/v1/live-classes/:id/recording/recover

Recover Recording

live-class:update

Open the actual application

ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.

Keep exploring