API Endpoint Reference
This page provides detailed documentation for every endpoint in the EazyClassroom Academy API. Each endpoint requires authentication with a valid api_key (sent as POST parameter or query string).
1. Create Room
Creates a new persistent virtual room.
Endpoint: action=create_room
Method: POST
Scope required: create_room
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
api_key | string | Yes | – | Your API key |
room_name | string | Yes | – | Human‑readable name (e.g., "Math Class") |
room_password | string | No | (empty) | Password required for moderators to start sessions |
max_participants | int | No | 50 | Maximum number of attendees |
max_duration | int | No | 180 | Maximum session length in minutes |
auto_start_recording | boolean | No | true | Automatically start recording when session begins |
start_muted | boolean | No | false | Mute all participants on join |
stop_recording | boolean | No | false | Allow moderators to stop recording |
webcams_for_teachers | boolean | No | false | Only moderators can share webcams |
Response (Success)
{
"success": true,
"message": "Room created successfully",
"data": {
"room_id": "math-class",
"room_name": "Math Class",
"moderator_password": "mp",
"attendee_password": "ap"
}
}