Raw schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Your id for the space. The same id returns the same space; a new id creates a new space."
},
"name": {
"description": "Display name of the space (defaults to the id).",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"allow_guests": {
"description": "Let people without an invitation join (Lessonspace default true).",
"type": "boolean"
},
"record_av": {
"description": "Record audio and video.",
"type": "boolean"
},
"record_content": {
"description": "Record the whiteboard and documents (defaults to record_av).",
"type": "boolean"
},
"transcribe": {
"description": "Transcribe the session (needed for lessonspace_get_session_transcript).",
"type": "boolean"
},
"summarise": {
"description": "Create an AI lesson summary.",
"type": "boolean"
},
"server": {
"description": "Region of the space. If omitted, Lessonspace picks it from the IP location of this server, which is near the AI platform and not near the participant. When the user's region matters, pass the `region` of an existing space from lessonspace_list_spaces.",
"type": "string",
"minLength": 1,
"maxLength": 64
},
"locale": {
"description": "Interface language.",
"type": "string",
"enum": [
"en",
"fr",
"it",
"pl"
]
},
"video_layout_mode": {
"type": "string",
"enum": [
"grid",
"sidebar",
"floating"
]
},
"session_tags": {
"description": "Tags put on the session (for filtering later).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"space_tags": {
"description": "Tags put on the space.",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"user": {
"description": "The participant this link is for.",
"type": "object",
"properties": {
"name": {
"description": "The participant's name (default 'Guest').",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"id": {
"description": "Your id for this participant (shows as external id).",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"email": {
"type": "string",
"maxLength": 320,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"leader": {
"description": "Teacher/host rights (Lessonspace default false).",
"type": "boolean"
},
"ghost": {
"description": "Join invisibly (observer).",
"type": "boolean"
},
"record": {
"description": "Record this participant's audio/video.",
"type": "boolean"
},
"single_use": {
"description": "The link works for one person only: once someone joins with it, nobody else can use it (the first person can rejoin until the session ends).",
"type": "boolean"
}
}
},
"not_before": {
"description": "The link works from this time (default: now).",
"type": "string"
},
"not_after": {
"description": "The link stops working at this time (default and maximum: 7 days after not_before, or after now).",
"type": "string"
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}