Skip to main content

Create Room

Create a new classroom session. This endpoint initializes a room and returns a token for the initial participant (usually the host/teacher).

Endpoint: POST https://api.verriflo.com/v1/room/create

Headers​

HeaderTypeRequiredDescription
VF-ORG-IDstringYesYour Organization ID (e.g., llHUjznZtGuY6jXP)
Content-TypestringYesapplication/json

Request Body​

{
"roomId": "math-101",
"title": "Calculus I - Morning Session",
"participant": {
"uid": "teacher-123",
"name": "Prof. Smith",
"role": "TEACHER"
},
"customization": {
"showLobby": true,
"theme": "dark"
},
"settings": {
"maxParticipants": 1000,
"emptyTimeout": 300
}
}

Parameters​

FieldTypeRequiredDescription
roomIdstringYesUnique identifier for the room. Must be unique per room and cannot be reused later even if the room is destroyed.
titlestringYesDisplay title for the classroom.
participantobjectYesInitial participant details.
participant.uidstringYesUnique ID for the participant.
participant.namestringYesDisplay name.
participant.rolestringYesRole: TEACHER, STUDENT, MODERATOR, or ADMIN.
customizationobjectNoUI customization options (see Customization Guide).
settingsobjectNoRoom configuration settings.
settings.maxParticipantsnumberNoLimits the number of users who can join the room. (Default: 1000, Max: 5000)
settings.emptyTimeoutnumberNoDuration (in seconds) the room stays active after the last participant leaves. (Default: 300 (5min), Max: 1800 (30min))

Response​

{
"success": true,
"data": {
"token": "eyJhbGciOiJIUz...",
"iframeUrl": "https://live.verriflo.com/iframe/live?token=eyJ...",
"expiresAt": "2023-12-31T23:59:59.000Z",
"room": {
"roomId": "math-101",
"sid": "RM_7482..."
}
}
}