Create a preset
realtime_kit.presets.create(strapp_id, PresetCreateParams**kwargs) -> PresetCreateResponse
POST/accounts/{account_id}/realtime/kit/{app_id}/presets
Creates a preset belonging to the current App
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
Accepted Permissions (at least one required)
Parameters
Create a preset
import os
from cloudflare import Cloudflare
client = Cloudflare(
api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted
)
preset = client.realtime_kit.presets.create(
app_id="app_id",
account_id="023e105f4ecef8ad9ca31a8372d0c353",
config={
"max_screenshare_count": 0,
"max_video_streams": {
"desktop": 0,
"mobile": 0,
},
"media": {
"screenshare": {
"frame_rate": 0,
"quality": "hd",
},
"video": {
"frame_rate": 30,
"quality": "hd",
},
},
"view_type": "GROUP_CALL",
},
name="name",
ui={
"design_tokens": {
"border_radius": "rounded",
"border_width": "thin",
"colors": {
"background": {
"_600": "600",
"_700": "700",
"_800": "800",
"_900": "900",
"_1000": "1000",
},
"brand": {
"_300": "300",
"_400": "400",
"_500": "500",
"_600": "600",
"_700": "700",
},
"danger": "danger",
"success": "success",
"text": "text",
"text_on_brand": "text_on_brand",
"video_bg": "video_bg",
"warning": "warning",
},
"logo": "logo",
"spacing_base": 0,
"theme": "dark",
}
},
)
print(preset.data){
"data": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"config": {
"max_screenshare_count": 0,
"max_video_streams": {
"desktop": 0,
"mobile": 0
},
"media": {
"screenshare": {
"frame_rate": 0,
"quality": "hd"
},
"video": {
"frame_rate": 30,
"quality": "hd"
},
"audio": {
"enable_high_bitrate": true,
"enable_stereo": true
}
},
"view_type": "GROUP_CALL"
},
"name": "name",
"ui": {
"design_tokens": {
"border_radius": "rounded",
"border_width": "thin",
"colors": {
"background": {
"600": "600",
"700": "700",
"800": "800",
"900": "900",
"1000": "1000"
},
"brand": {
"300": "300",
"400": "400",
"500": "500",
"600": "600",
"700": "700"
},
"danger": "danger",
"success": "success",
"text": "text",
"text_on_brand": "text_on_brand",
"video_bg": "video_bg",
"warning": "warning"
},
"logo": "logo",
"spacing_base": 0,
"theme": "dark"
},
"config_diff": {}
},
"permissions": {
"accept_waiting_requests": true,
"can_accept_production_requests": true,
"can_change_participant_permissions": true,
"can_edit_display_name": true,
"can_livestream": true,
"can_record": true,
"can_spotlight": true,
"chat": {
"private": {
"can_receive": true,
"can_send": true,
"files": true,
"text": true
},
"public": {
"can_send": true,
"files": true,
"text": true
}
},
"connected_meetings": {
"can_alter_connected_meetings": true,
"can_switch_connected_meetings": true,
"can_switch_to_parent_meeting": true
},
"disable_participant_audio": true,
"disable_participant_screensharing": true,
"disable_participant_video": true,
"hidden_participant": true,
"kick_participant": true,
"media": {
"audio": {
"can_produce": "ALLOWED"
},
"screenshare": {
"can_produce": "ALLOWED"
},
"video": {
"can_produce": "ALLOWED"
}
},
"pin_participant": true,
"plugins": {
"can_close": true,
"can_edit_config": true,
"can_start": true,
"config": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"polls": {
"can_create": true,
"can_view": true,
"can_vote": true
},
"recorder_type": "RECORDER",
"show_participant_list": true,
"waiting_room_type": "SKIP",
"is_recorder": true
}
},
"success": true
}Returns Examples
{
"data": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"config": {
"max_screenshare_count": 0,
"max_video_streams": {
"desktop": 0,
"mobile": 0
},
"media": {
"screenshare": {
"frame_rate": 0,
"quality": "hd"
},
"video": {
"frame_rate": 30,
"quality": "hd"
},
"audio": {
"enable_high_bitrate": true,
"enable_stereo": true
}
},
"view_type": "GROUP_CALL"
},
"name": "name",
"ui": {
"design_tokens": {
"border_radius": "rounded",
"border_width": "thin",
"colors": {
"background": {
"600": "600",
"700": "700",
"800": "800",
"900": "900",
"1000": "1000"
},
"brand": {
"300": "300",
"400": "400",
"500": "500",
"600": "600",
"700": "700"
},
"danger": "danger",
"success": "success",
"text": "text",
"text_on_brand": "text_on_brand",
"video_bg": "video_bg",
"warning": "warning"
},
"logo": "logo",
"spacing_base": 0,
"theme": "dark"
},
"config_diff": {}
},
"permissions": {
"accept_waiting_requests": true,
"can_accept_production_requests": true,
"can_change_participant_permissions": true,
"can_edit_display_name": true,
"can_livestream": true,
"can_record": true,
"can_spotlight": true,
"chat": {
"private": {
"can_receive": true,
"can_send": true,
"files": true,
"text": true
},
"public": {
"can_send": true,
"files": true,
"text": true
}
},
"connected_meetings": {
"can_alter_connected_meetings": true,
"can_switch_connected_meetings": true,
"can_switch_to_parent_meeting": true
},
"disable_participant_audio": true,
"disable_participant_screensharing": true,
"disable_participant_video": true,
"hidden_participant": true,
"kick_participant": true,
"media": {
"audio": {
"can_produce": "ALLOWED"
},
"screenshare": {
"can_produce": "ALLOWED"
},
"video": {
"can_produce": "ALLOWED"
}
},
"pin_participant": true,
"plugins": {
"can_close": true,
"can_edit_config": true,
"can_start": true,
"config": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"polls": {
"can_create": true,
"can_view": true,
"can_vote": true
},
"recorder_type": "RECORDER",
"show_participant_list": true,
"waiting_room_type": "SKIP",
"is_recorder": true
}
},
"success": true
}