Skip to content
Cloudflare API
Start here
API Reference
Realtime Kit

Presets

Fetch all presets
realtime_kit.presets.get(strapp_id, PresetGetParams**kwargs) -> PresetGetResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/presets
Create a preset
realtime_kit.presets.create(strapp_id, PresetCreateParams**kwargs) -> PresetCreateResponse
POST/accounts/{account_id}/realtime/kit/{app_id}/presets
Fetch details of a preset
realtime_kit.presets.get_preset_by_id(strpreset_id, PresetGetPresetByIDParams**kwargs) -> PresetGetPresetByIDResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}
Delete a preset
realtime_kit.presets.delete(strpreset_id, PresetDeleteParams**kwargs) -> PresetDeleteResponse
DELETE/accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}
Update a preset
realtime_kit.presets.update(strpreset_id, PresetUpdateParams**kwargs) -> PresetUpdateResponse
PATCH/accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}
ModelsExpand Collapse
class PresetGetResponse: …
data: List[Data]
id: Optional[str]

ID of the preset

formatuuid
created_at: Optional[datetime]

Timestamp this preset was created at

formatdate-time
name: Optional[str]

Name of the preset

updated_at: Optional[datetime]

Timestamp this preset was last updated

formatdate-time
paging: Paging
end_offset: float
start_offset: float
total_count: float
minimum0
success: bool
class PresetCreateResponse: …
data: Data

Data returned by the operation

id: str

ID of the preset

formatuuid
config: DataConfig
max_screenshare_count: int

Maximum number of screen shares that can be active at a given time

max_video_streams: DataConfigMaxVideoStreams

Maximum number of streams that are visible on a device

desktop: int

Maximum number of video streams visible on desktop devices

mobile: int

Maximum number of streams visible on mobile devices

media: DataConfigMedia

Media configuration options. eg: Video quality

screenshare: DataConfigMediaScreenshare

Configuration options for participant screen shares

frame_rate: int

Frame rate of screen share

quality: Literal["hd", "vga", "qvga"]

Quality of screen share

One of the following:
"hd"
"vga"
"qvga"
video: DataConfigMediaVideo

Configuration options for participant videos

frame_rate: int

Frame rate of participants' video

maximum30
quality: Literal["hd", "vga", "qvga"]

Video quality of participants

One of the following:
"hd"
"vga"
"qvga"
audio: Optional[DataConfigMediaAudio]

Control options for Audio quality.

enable_high_bitrate: Optional[bool]

Enable High Quality Audio for your meetings

enable_stereo: Optional[bool]

Enable Stereo for your meetings

view_type: Literal["GROUP_CALL", "WEBINAR", "AUDIO_ROOM"]

Type of the meeting

One of the following:
"GROUP_CALL"
"WEBINAR"
"AUDIO_ROOM"
name: str

Name of the preset

ui: DataUI
design_tokens: DataUIDesignTokens
border_radius: Literal["rounded"]
border_width: Literal["thin"]
colors: DataUIDesignTokensColors
background: DataUIDesignTokensColorsBackground
_1000: str
_600: str
_700: str
_800: str
_900: str
brand: DataUIDesignTokensColorsBrand
_300: str
_400: str
_500: str
_600: str
_700: str
danger: str
success: str
text: str
text_on_brand: str
video_bg: str
warning: str
spacing_base: float
theme: Literal["dark"]
config_diff: Optional[object]
permissions: Optional[DataPermissions]
accept_waiting_requests: bool

Whether this participant can accept waiting requests

can_accept_production_requests: bool
can_change_participant_permissions: bool
can_edit_display_name: bool
can_livestream: bool
can_record: bool
can_spotlight: bool
chat: DataPermissionsChat

Chat permissions

private: DataPermissionsChatPrivate
can_receive: bool
can_send: bool
files: bool
text: bool
public: DataPermissionsChatPublic
can_send: bool

Can send messages in general

files: bool

Can send file messages

text: bool

Can send text messages

connected_meetings: DataPermissionsConnectedMeetings
can_alter_connected_meetings: bool
can_switch_connected_meetings: bool
can_switch_to_parent_meeting: bool
disable_participant_audio: bool
disable_participant_screensharing: bool
disable_participant_video: bool
hidden_participant: bool

Whether this participant is visible to others or not

kick_participant: bool
media: DataPermissionsMedia

Media permissions

audio: DataPermissionsMediaAudio

Audio permissions

can_produce: Literal["ALLOWED", "NOT_ALLOWED", "CAN_REQUEST"]

Can produce audio

One of the following:
"ALLOWED"
"NOT_ALLOWED"
"CAN_REQUEST"
screenshare: DataPermissionsMediaScreenshare

Screenshare permissions

can_produce: Literal["ALLOWED", "NOT_ALLOWED", "CAN_REQUEST"]

Can produce screen share video

One of the following:
"ALLOWED"
"NOT_ALLOWED"
"CAN_REQUEST"
video: DataPermissionsMediaVideo

Video permissions

can_produce: Literal["ALLOWED", "NOT_ALLOWED", "CAN_REQUEST"]

Can produce video

One of the following:
"ALLOWED"
"NOT_ALLOWED"
"CAN_REQUEST"
pin_participant: bool
plugins: DataPermissionsPlugins

Plugin permissions

can_close: bool

Can close plugins that are already open

can_edit_config: bool

Can edit plugin config

can_start: bool

Can start plugins

config: DataPermissionsPluginsConfig
One of the following:
str
class DataPermissionsPluginsConfigUnionMember1: …
access_control: Literal["FULL_ACCESS", "VIEW_ONLY"]
One of the following:
"FULL_ACCESS"
"VIEW_ONLY"
handles_view_only: bool
polls: DataPermissionsPolls

Poll permissions

can_create: bool

Can create polls

can_view: bool

Can view polls

can_vote: bool

Can vote on polls

recorder_type: Literal["RECORDER", "LIVESTREAMER", "NONE"]

Type of the recording peer

One of the following:
"RECORDER"
"LIVESTREAMER"
"NONE"
show_participant_list: bool
waiting_room_type: Literal["SKIP", "ON_PRIVILEGED_USER_ENTRY", "SKIP_ON_ACCEPT"]

Waiting room type

One of the following:
"SKIP"
"ON_PRIVILEGED_USER_ENTRY"
"SKIP_ON_ACCEPT"
is_recorder: Optional[bool]
success: bool

Success status of the operation

class PresetGetPresetByIDResponse: …
data: Data

Data returned by the operation

id: str

ID of the preset

formatuuid
config: DataConfig
max_screenshare_count: int

Maximum number of screen shares that can be active at a given time

max_video_streams: DataConfigMaxVideoStreams

Maximum number of streams that are visible on a device

desktop: int

Maximum number of video streams visible on desktop devices

mobile: int

Maximum number of streams visible on mobile devices

media: DataConfigMedia

Media configuration options. eg: Video quality

screenshare: DataConfigMediaScreenshare

Configuration options for participant screen shares

frame_rate: int

Frame rate of screen share

quality: Literal["hd", "vga", "qvga"]

Quality of screen share

One of the following:
"hd"
"vga"
"qvga"
video: DataConfigMediaVideo

Configuration options for participant videos

frame_rate: int

Frame rate of participants' video

maximum30
quality: Literal["hd", "vga", "qvga"]

Video quality of participants

One of the following:
"hd"
"vga"
"qvga"
audio: Optional[DataConfigMediaAudio]

Control options for Audio quality.

enable_high_bitrate: Optional[bool]

Enable High Quality Audio for your meetings

enable_stereo: Optional[bool]

Enable Stereo for your meetings

view_type: Literal["GROUP_CALL", "WEBINAR", "AUDIO_ROOM"]

Type of the meeting

One of the following:
"GROUP_CALL"
"WEBINAR"
"AUDIO_ROOM"
name: str

Name of the preset

ui: DataUI
design_tokens: DataUIDesignTokens
border_radius: Literal["rounded"]
border_width: Literal["thin"]
colors: DataUIDesignTokensColors
background: DataUIDesignTokensColorsBackground
_1000: str
_600: str
_700: str
_800: str
_900: str
brand: DataUIDesignTokensColorsBrand
_300: str
_400: str
_500: str
_600: str
_700: str
danger: str
success: str
text: str
text_on_brand: str
video_bg: str
warning: str
spacing_base: float
theme: Literal["dark"]
config_diff: Optional[object]
permissions: Optional[DataPermissions]
accept_waiting_requests: bool

Whether this participant can accept waiting requests

can_accept_production_requests: bool
can_change_participant_permissions: bool
can_edit_display_name: bool
can_livestream: bool
can_record: bool
can_spotlight: bool
chat: DataPermissionsChat

Chat permissions

private: DataPermissionsChatPrivate
can_receive: bool
can_send: bool
files: bool
text: bool
public: DataPermissionsChatPublic
can_send: bool

Can send messages in general

files: bool

Can send file messages

text: bool

Can send text messages

connected_meetings: DataPermissionsConnectedMeetings
can_alter_connected_meetings: bool
can_switch_connected_meetings: bool
can_switch_to_parent_meeting: bool
disable_participant_audio: bool
disable_participant_screensharing: bool
disable_participant_video: bool
hidden_participant: bool

Whether this participant is visible to others or not

kick_participant: bool
media: DataPermissionsMedia

Media permissions

audio: DataPermissionsMediaAudio

Audio permissions

can_produce: Literal["ALLOWED", "NOT_ALLOWED", "CAN_REQUEST"]

Can produce audio

One of the following:
"ALLOWED"
"NOT_ALLOWED"
"CAN_REQUEST"
screenshare: DataPermissionsMediaScreenshare

Screenshare permissions

can_produce: Literal["ALLOWED", "NOT_ALLOWED", "CAN_REQUEST"]

Can produce screen share video

One of the following:
"ALLOWED"
"NOT_ALLOWED"
"CAN_REQUEST"
video: DataPermissionsMediaVideo

Video permissions

can_produce: Literal["ALLOWED", "NOT_ALLOWED", "CAN_REQUEST"]

Can produce video

One of the following:
"ALLOWED"
"NOT_ALLOWED"
"CAN_REQUEST"
pin_participant: bool
plugins: DataPermissionsPlugins

Plugin permissions

can_close: bool

Can close plugins that are already open

can_edit_config: bool

Can edit plugin config

can_start: bool

Can start plugins

config: DataPermissionsPluginsConfig
One of the following:
str
class DataPermissionsPluginsConfigUnionMember1: …
access_control: Literal["FULL_ACCESS", "VIEW_ONLY"]
One of the following:
"FULL_ACCESS"
"VIEW_ONLY"
handles_view_only: bool
polls: DataPermissionsPolls

Poll permissions

can_create: bool

Can create polls

can_view: bool

Can view polls

can_vote: bool

Can vote on polls

recorder_type: Literal["RECORDER", "LIVESTREAMER", "NONE"]

Type of the recording peer

One of the following:
"RECORDER"
"LIVESTREAMER"
"NONE"
show_participant_list: bool
waiting_room_type: Literal["SKIP", "ON_PRIVILEGED_USER_ENTRY", "SKIP_ON_ACCEPT"]

Waiting room type

One of the following:
"SKIP"
"ON_PRIVILEGED_USER_ENTRY"
"SKIP_ON_ACCEPT"
is_recorder: Optional[bool]
success: bool

Success status of the operation

class PresetDeleteResponse: …
data: Data

Data returned by the operation

id: str

ID of the preset

formatuuid
config: DataConfig
max_screenshare_count: int

Maximum number of screen shares that can be active at a given time

max_video_streams: DataConfigMaxVideoStreams

Maximum number of streams that are visible on a device

desktop: int

Maximum number of video streams visible on desktop devices

mobile: int

Maximum number of streams visible on mobile devices

media: DataConfigMedia

Media configuration options. eg: Video quality

screenshare: DataConfigMediaScreenshare

Configuration options for participant screen shares

frame_rate: int

Frame rate of screen share

quality: Literal["hd", "vga", "qvga"]

Quality of screen share

One of the following:
"hd"
"vga"
"qvga"
video: DataConfigMediaVideo

Configuration options for participant videos

frame_rate: int

Frame rate of participants' video

maximum30
quality: Literal["hd", "vga", "qvga"]

Video quality of participants

One of the following:
"hd"
"vga"
"qvga"
audio: Optional[DataConfigMediaAudio]

Control options for Audio quality.

enable_high_bitrate: Optional[bool]

Enable High Quality Audio for your meetings

enable_stereo: Optional[bool]

Enable Stereo for your meetings

view_type: Literal["GROUP_CALL", "WEBINAR", "AUDIO_ROOM"]

Type of the meeting

One of the following:
"GROUP_CALL"
"WEBINAR"
"AUDIO_ROOM"
name: str

Name of the preset

ui: DataUI
design_tokens: DataUIDesignTokens
border_radius: Literal["rounded"]
border_width: Literal["thin"]
colors: DataUIDesignTokensColors
background: DataUIDesignTokensColorsBackground
_1000: str
_600: str
_700: str
_800: str
_900: str
brand: DataUIDesignTokensColorsBrand
_300: str
_400: str
_500: str
_600: str
_700: str
danger: str
success: str
text: str
text_on_brand: str
video_bg: str
warning: str
spacing_base: float
theme: Literal["dark"]
config_diff: Optional[object]
permissions: Optional[DataPermissions]
accept_waiting_requests: bool

Whether this participant can accept waiting requests

can_accept_production_requests: bool
can_change_participant_permissions: bool
can_edit_display_name: bool
can_livestream: bool
can_record: bool
can_spotlight: bool
chat: DataPermissionsChat

Chat permissions

private: DataPermissionsChatPrivate
can_receive: bool
can_send: bool
files: bool
text: bool
public: DataPermissionsChatPublic
can_send: bool

Can send messages in general

files: bool

Can send file messages

text: bool

Can send text messages

connected_meetings: DataPermissionsConnectedMeetings
can_alter_connected_meetings: bool
can_switch_connected_meetings: bool
can_switch_to_parent_meeting: bool
disable_participant_audio: bool
disable_participant_screensharing: bool
disable_participant_video: bool
hidden_participant: bool

Whether this participant is visible to others or not

kick_participant: bool
media: DataPermissionsMedia

Media permissions

audio: DataPermissionsMediaAudio

Audio permissions

can_produce: Literal["ALLOWED", "NOT_ALLOWED", "CAN_REQUEST"]

Can produce audio

One of the following:
"ALLOWED"
"NOT_ALLOWED"
"CAN_REQUEST"
screenshare: DataPermissionsMediaScreenshare

Screenshare permissions

can_produce: Literal["ALLOWED", "NOT_ALLOWED", "CAN_REQUEST"]

Can produce screen share video

One of the following:
"ALLOWED"
"NOT_ALLOWED"
"CAN_REQUEST"
video: DataPermissionsMediaVideo

Video permissions

can_produce: Literal["ALLOWED", "NOT_ALLOWED", "CAN_REQUEST"]

Can produce video

One of the following:
"ALLOWED"
"NOT_ALLOWED"
"CAN_REQUEST"
pin_participant: bool
plugins: DataPermissionsPlugins

Plugin permissions

can_close: bool

Can close plugins that are already open

can_edit_config: bool

Can edit plugin config

can_start: bool

Can start plugins

config: DataPermissionsPluginsConfig
One of the following:
str
class DataPermissionsPluginsConfigUnionMember1: …
access_control: Literal["FULL_ACCESS", "VIEW_ONLY"]
One of the following:
"FULL_ACCESS"
"VIEW_ONLY"
handles_view_only: bool
polls: DataPermissionsPolls

Poll permissions

can_create: bool

Can create polls

can_view: bool

Can view polls

can_vote: bool

Can vote on polls

recorder_type: Literal["RECORDER", "LIVESTREAMER", "NONE"]

Type of the recording peer

One of the following:
"RECORDER"
"LIVESTREAMER"
"NONE"
show_participant_list: bool
waiting_room_type: Literal["SKIP", "ON_PRIVILEGED_USER_ENTRY", "SKIP_ON_ACCEPT"]

Waiting room type

One of the following:
"SKIP"
"ON_PRIVILEGED_USER_ENTRY"
"SKIP_ON_ACCEPT"
is_recorder: Optional[bool]
success: bool

Success status of the operation

class PresetUpdateResponse: …
data: Data

Data returned by the operation

id: str

ID of the preset

formatuuid
config: DataConfig
max_screenshare_count: int

Maximum number of screen shares that can be active at a given time

max_video_streams: DataConfigMaxVideoStreams

Maximum number of streams that are visible on a device

desktop: int

Maximum number of video streams visible on desktop devices

mobile: int

Maximum number of streams visible on mobile devices

media: DataConfigMedia

Media configuration options. eg: Video quality

screenshare: DataConfigMediaScreenshare

Configuration options for participant screen shares

frame_rate: int

Frame rate of screen share

quality: Literal["hd", "vga", "qvga"]

Quality of screen share

One of the following:
"hd"
"vga"
"qvga"
video: DataConfigMediaVideo

Configuration options for participant videos

frame_rate: int

Frame rate of participants' video

maximum30
quality: Literal["hd", "vga", "qvga"]

Video quality of participants

One of the following:
"hd"
"vga"
"qvga"
audio: Optional[DataConfigMediaAudio]

Control options for Audio quality.

enable_high_bitrate: Optional[bool]

Enable High Quality Audio for your meetings

enable_stereo: Optional[bool]

Enable Stereo for your meetings

view_type: Literal["GROUP_CALL", "WEBINAR", "AUDIO_ROOM"]

Type of the meeting

One of the following:
"GROUP_CALL"
"WEBINAR"
"AUDIO_ROOM"
name: str

Name of the preset

ui: DataUI
design_tokens: DataUIDesignTokens
border_radius: Literal["rounded"]
border_width: Literal["thin"]
colors: DataUIDesignTokensColors
background: DataUIDesignTokensColorsBackground
_1000: str
_600: str
_700: str
_800: str
_900: str
brand: DataUIDesignTokensColorsBrand
_300: str
_400: str
_500: str
_600: str
_700: str
danger: str
success: str
text: str
text_on_brand: str
video_bg: str
warning: str
spacing_base: float
theme: Literal["dark"]
config_diff: Optional[object]
permissions: Optional[DataPermissions]
accept_waiting_requests: bool

Whether this participant can accept waiting requests

can_accept_production_requests: bool
can_change_participant_permissions: bool
can_edit_display_name: bool
can_livestream: bool
can_record: bool
can_spotlight: bool
chat: DataPermissionsChat

Chat permissions

private: DataPermissionsChatPrivate
can_receive: bool
can_send: bool
files: bool
text: bool
public: DataPermissionsChatPublic
can_send: bool

Can send messages in general

files: bool

Can send file messages

text: bool

Can send text messages

connected_meetings: DataPermissionsConnectedMeetings
can_alter_connected_meetings: bool
can_switch_connected_meetings: bool
can_switch_to_parent_meeting: bool
disable_participant_audio: bool
disable_participant_screensharing: bool
disable_participant_video: bool
hidden_participant: bool

Whether this participant is visible to others or not

kick_participant: bool
media: DataPermissionsMedia

Media permissions

audio: DataPermissionsMediaAudio

Audio permissions

can_produce: Literal["ALLOWED", "NOT_ALLOWED", "CAN_REQUEST"]

Can produce audio

One of the following:
"ALLOWED"
"NOT_ALLOWED"
"CAN_REQUEST"
screenshare: DataPermissionsMediaScreenshare

Screenshare permissions

can_produce: Literal["ALLOWED", "NOT_ALLOWED", "CAN_REQUEST"]

Can produce screen share video

One of the following:
"ALLOWED"
"NOT_ALLOWED"
"CAN_REQUEST"
video: DataPermissionsMediaVideo

Video permissions

can_produce: Literal["ALLOWED", "NOT_ALLOWED", "CAN_REQUEST"]

Can produce video

One of the following:
"ALLOWED"
"NOT_ALLOWED"
"CAN_REQUEST"
pin_participant: bool
plugins: DataPermissionsPlugins

Plugin permissions

can_close: bool

Can close plugins that are already open

can_edit_config: bool

Can edit plugin config

can_start: bool

Can start plugins

config: DataPermissionsPluginsConfig
One of the following:
str
class DataPermissionsPluginsConfigUnionMember1: …
access_control: Literal["FULL_ACCESS", "VIEW_ONLY"]
One of the following:
"FULL_ACCESS"
"VIEW_ONLY"
handles_view_only: bool
polls: DataPermissionsPolls

Poll permissions

can_create: bool

Can create polls

can_view: bool

Can view polls

can_vote: bool

Can vote on polls

recorder_type: Literal["RECORDER", "LIVESTREAMER", "NONE"]

Type of the recording peer

One of the following:
"RECORDER"
"LIVESTREAMER"
"NONE"
show_participant_list: bool
waiting_room_type: Literal["SKIP", "ON_PRIVILEGED_USER_ENTRY", "SKIP_ON_ACCEPT"]

Waiting room type

One of the following:
"SKIP"
"ON_PRIVILEGED_USER_ENTRY"
"SKIP_ON_ACCEPT"
is_recorder: Optional[bool]
success: bool

Success status of the operation