For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
A named unique identifier for the conference. Allowed characters: `A-Za-z0-9_-`. Maximum of 100 characters.
descriptionstringOptional<=3000 characters
Description of the conference. Maximum of 3000 characters.
join_fromdatetimeOptional
Conference does not accept new participants before this time. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z`.
join_untildatetimeOptional
Conference stops accepting new participants at this time, but keeps running until all participants leave. Expects RFC 3339 datetime: `2022-01-01T23:59:60Z`. Date only: `2022-01-01` will be converted to `2022-01-01T00:00:00Z`.
qualityenumOptionalDefaults to 720p
The conference's resolution.
Allowed values:
layoutenumOptionalDefaults to grid-responsive
The conference's initial layout.
sizeenumOptionalDefaults to medium
The size of the video conference.
Allowed values:
record_on_startbooleanOptional
Whether to start recording when a conference session begins.
enable_room_previewsbooleanOptional
Whether a preview video of the conference content is generated.
enable_chatbooleanOptionalDefaults to true
Whether group chat is enabled for conference participants.
dark_primarystringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #044EF4
CTA buttons and selected items color (dark theme).
dark_backgroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #FFFFFF
Main background color (dark theme).
dark_foregroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #1D2127
Main foreground color (dark theme).
dark_successstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #17BB58
Success indication color (dark theme).
dark_negativestringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #F42C50
Error indication color (dark theme).
light_primarystringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #044EF4
CTA buttons and selected items color (light theme).
light_backgroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #FFFFFF
Main background color (light theme).
light_foregroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #1D2127
Main foreground color (light theme).
light_successstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #17BB58
Success indication color (light theme).
light_negativestringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #F42C50
Error indication color (light theme).
Response
idstringRequiredformat: "uuid"
Unique ID of the video conference.
namestringRequired
A named unique identifier for the conference. Allowed characters: `A-Za-z0-9_-`.
display_namestring or nullRequired
Display name of the video conference. Maximum of 200 characters.
descriptionstring or nullRequired
Description of the conference. Maximum of 3000 characters.
join_fromdatetime or nullRequired
Conference does not accept new participants before this time.
join_untildatetime or nullRequired
Conference stops accepting new participants at this time, but keeps running until all participants leave.
qualityenumRequired
The conference's resolution.
Allowed values:
layoutenumRequired
The conference's initial layout.
sizeenum or nullRequired
The size of the video conference.
Allowed values:
record_on_startbooleanRequired
Whether to start recording when a conference session begins.
tone_on_entry_and_exitbooleanRequired
Whether a tone is played when a member enters or exits the conference.
user_join_video_offbooleanRequired
Whether participants join with video off by user setting.
room_join_video_offbooleanRequired
Whether participants join with video off by room setting.
enable_chatbooleanRequired
Whether group chat is enabled for conference participants.
enable_room_previewsboolean or nullRequired
Whether a preview video of the conference content is generated.
dark_primarystring or nullRequired
CTA buttons and selected items color (dark theme).
dark_backgroundstring or nullRequired
Main background color (dark theme).
dark_foregroundstring or nullRequired
Main foreground color (dark theme).
dark_successstring or nullRequired
Success indication color (dark theme).
dark_negativestring or nullRequired
Error indication color (dark theme).
light_primarystring or nullRequired
CTA buttons and selected items color (light theme).
light_backgroundstring or nullRequired
Main background color (light theme).
light_foregroundstring or nullRequired
Main foreground color (light theme).
light_successstring or nullRequired
Success indication color (light theme).
light_negativestring or nullRequired
Error indication color (light theme).
metaobject or nullRequired
User-defined metadata for the conference.
created_atdatetimeRequired
Timestamp when the conference was created.
updated_atdatetimeRequired
Timestamp when the conference was last updated.
active_sessionobjectOptional
Active session information. Only present when requested via the `include_active_session` query parameter.
Response Example
Response
1
{
2
"id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
3
"name": "my_conference",
4
"display_name": "My Conference's Name",
5
"description": "This conference will be used for full company all hands meetings",