--- title: Fetch details of a preset --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Realtime Kit](https://developers.cloudflare.com/api/python/resources/realtime_kit) [Presets](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/presets) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # 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} Fetches details of a preset using the provided preset ID ##### Security API Token The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). **Example:**`Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY` ##### Accepted Permissions (at least one required) `Realtime Admin``Realtime` ##### ParametersExpand Collapse account\_id: str The account identifier tag. maxLength32 [Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(method)%20get_preset_by_id%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) app\_id: str The app identifier tag. [Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(method)%20get_preset_by_id%20%3E%20(params)%20default%20%3E%20(param)%20app_id%20%3E%20(schema)>) preset\_id: str formatuuid [Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(method)%20get_preset_by_id%20%3E%20(params)%20default%20%3E%20(param)%20preset_id%20%3E%20(schema)>) ##### ReturnsExpand Collapse

class PresetGetPresetByIDResponse: …

data: Data Data returned by the operation

id: str ID of the preset formatuuid Link to this property

config: DataConfig

max\_screenshare\_count: float Maximum number of screen shares that can be active at a given time Link to this property

max\_video\_streams: DataConfigMaxVideoStreams Maximum number of streams that are visible on a device

desktop: float Maximum number of video streams visible on desktop devices Link to this property mobile: float Maximum number of streams visible on mobile devices Link to this property

Link to this property

media: DataConfigMedia Media configuration options. eg: Video quality

screenshare: DataConfigMediaScreenshare Configuration options for participant screen shares

frame\_rate: float Frame rate of screen share Link to this property

quality: Literal\["hd", "vga", "qvga", 2 more] Quality of screen share

One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property

Link to this property

video: DataConfigMediaVideo Configuration options for participant videos

frame\_rate: float Frame rate of participants’ video maximum30 Link to this property

quality: Literal\["hd", "vga", "qvga", 2 more] Video quality of participants

One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property

Link to this property simulcast: Optional\[bool] Enable simulcast for participant videos. Link to this property

Link to this property

audio: Optional\[DataConfigMediaAudio] Control options for Audio quality.

enable\_high\_bitrate: Optional\[bool] Enable High Quality Audio for your meetings Link to this property enable\_stereo: Optional\[bool] Enable Stereo for your meetings Link to this property

Link to this property

view\_type: Literal\["GROUP\_CALL", "WEBINAR", "AUDIO\_ROOM", "LIVESTREAM"] Type of the meeting

One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property

Link to this property livestream\_viewer\_qualities: Optional\[List\[int]] Livestream viewer quality levels. Link to this property

Link to this property created\_at: datetime Timestamp this preset was created at formatdate-time Link to this property name: str Name of the preset Link to this property

permissions: DataPermissions

accept\_waiting\_requests: bool Whether this participant can accept waiting requests Link to this property can\_accept\_production\_requests: bool Link to this property can\_change\_participant\_permissions: bool Link to this property can\_edit\_display\_name: bool Link to this property can\_livestream: bool Link to this property can\_record: bool Link to this property can\_spotlight: bool Link to this property

chat: DataPermissionsChat

private: DataPermissionsChatPrivate

can\_receive: bool Link to this property can\_send: bool Link to this property files: bool Link to this property text: bool Link to this property

Link to this property

public: DataPermissionsChatPublic

can\_send: bool Can send messages in general Link to this property files: bool Can send file messages Link to this property text: bool Can send text messages Link to this property

Link to this property

connected\_meetings: DataPermissionsConnectedMeetings

can\_alter\_connected\_meetings: bool Link to this property can\_switch\_connected\_meetings: bool Link to this property can\_switch\_to\_parent\_meeting: bool Link to this property

Link to this property disable\_participant\_audio: bool Link to this property disable\_participant\_screensharing: bool Link to this property disable\_participant\_video: bool Link to this property hidden\_participant: bool Whether this participant is visible to others or not Link to this property kick\_participant: bool Link to this property

media: DataPermissionsMedia Media permissions

audio: DataPermissionsMediaAudio Audio permissions

can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce audio

One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property

Link to this property

screenshare: DataPermissionsMediaScreenshare Screenshare permissions

can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce screen share video

One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property

Link to this property

video: DataPermissionsMediaVideo Video permissions

can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce video

One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property

Link to this property

Link to this property pin\_participant: bool Link to this property

plugins: DataPermissionsPlugins Plugin permissions

can\_close: bool Can close plugins that are already open Link to this property can\_edit\_config: bool Can edit plugin config Link to this property can\_start: bool Can start plugins Link to this property

config: Dict\[str, DataPermissionsPluginsConfig] Plugin configuration keyed by plugin UUID.

access\_control: Optional\[Literal\["FULL\_ACCESS", "VIEW\_ONLY"]]

One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property

Link to this property handles\_view\_only: Optional\[bool] Link to this property

Link to this property

polls: DataPermissionsPolls Poll permissions

can\_create: bool Can create polls Link to this property can\_view: bool Can view polls Link to this property can\_vote: bool Can vote on polls Link to this property

Link to this property

recorder\_type: Literal\["RECORDER", "LIVESTREAMER", "NONE"] Type of the recording peer

One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property

Link to this property show\_participant\_list: bool Link to this property

waiting\_room\_type: Literal\["SKIP", "ON\_PRIVILEGED\_USER\_ENTRY", "SKIP\_ON\_ACCEPT"] Waiting room type

One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property

Link to this property accept\_stage\_requests: Optional\[bool] Link to this property is\_recorder: Optional\[bool] Link to this property

stage\_access: Optional\[Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"]]

One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property

Link to this property stage\_enabled: Optional\[bool] Link to this property transcription\_enabled: Optional\[bool] Link to this property

Link to this property

ui: DataUI

design\_tokens: DataUIDesignTokens

border\_radius: Literal\["sharp", "rounded", "extra-rounded", "circular"]

One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property

Link to this property

border\_width: Literal\["none", "thin", "fat"]

One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property

Link to this property

colors: DataUIDesignTokensColors

background: DataUIDesignTokensColorsBackground

\_1000: str Link to this property \_600: str Link to this property \_700: str Link to this property \_800: str Link to this property \_900: str Link to this property

Link to this property

brand: DataUIDesignTokensColorsBrand

\_300: str Link to this property \_400: str Link to this property \_500: str Link to this property \_600: str Link to this property \_700: str Link to this property

Link to this property danger: str Link to this property success: str Link to this property text: str Link to this property text\_on\_brand: str Link to this property video\_bg: str Link to this property warning: str Link to this property

Link to this property spacing\_base: float minimum1 Link to this property

theme: Literal\["darkest", "dark", "light"]

One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property

Link to this property font\_family: Optional\[str] Link to this property google\_font: Optional\[str] Link to this property logo: Optional\[str] formaturi Link to this property

Link to this property

Link to this property updated\_at: datetime Timestamp this preset was last updated formatdate-time Link to this property

Link to this property success: bool Success status of the operation Link to this property

[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_get_preset_by_id_response%20%3E%20(schema)>) ### Fetch details of a preset Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) response = client.realtime_kit.presets.get_preset_by_id( preset_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", account_id="023e105f4ecef8ad9ca31a8372d0c353", app_id="14a396e7-ca44-4937-bf1f-050a69118543", ) print(response.data) ``` 200 example ``` { "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", "simulcast": true }, "audio": { "enable_high_bitrate": true, "enable_stereo": true } }, "view_type": "GROUP_CALL", "livestream_viewer_qualities": [ 0 ] }, "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "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": { "foo": { "access_control": "FULL_ACCESS", "handles_view_only": true } } }, "polls": { "can_create": true, "can_view": true, "can_vote": true }, "recorder_type": "RECORDER", "show_participant_list": true, "waiting_room_type": "SKIP", "accept_stage_requests": true, "is_recorder": true, "stage_access": "ALLOWED", "stage_enabled": true, "transcription_enabled": true }, "ui": { "design_tokens": { "border_radius": "sharp", "border_width": "none", "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" }, "spacing_base": 1, "theme": "darkest", "font_family": "font_family", "google_font": "google_font", "logo": "https://example.com" } }, "updated_at": "2019-12-27T18:11:19.117Z" }, "success": true } ``` ##### Returns Examples 200 example ``` { "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", "simulcast": true }, "audio": { "enable_high_bitrate": true, "enable_stereo": true } }, "view_type": "GROUP_CALL", "livestream_viewer_qualities": [ 0 ] }, "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "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": { "foo": { "access_control": "FULL_ACCESS", "handles_view_only": true } } }, "polls": { "can_create": true, "can_view": true, "can_vote": true }, "recorder_type": "RECORDER", "show_participant_list": true, "waiting_room_type": "SKIP", "accept_stage_requests": true, "is_recorder": true, "stage_access": "ALLOWED", "stage_enabled": true, "transcription_enabled": true }, "ui": { "design_tokens": { "border_radius": "sharp", "border_width": "none", "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" }, "spacing_base": 1, "theme": "darkest", "font_family": "font_family", "google_font": "google_font", "logo": "https://example.com" } }, "updated_at": "2019-12-27T18:11:19.117Z" }, "success": true } ```