--- title: Fetch details of a preset --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Realtime Kit](https://developers.cloudflare.com/api/go/resources/realtime_kit) [Presets](https://developers.cloudflare.com/api/go/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 client.RealtimeKit.Presets.GetPresetByID(ctx, appID, presetID, query) (\*[PresetGetPresetByIDResponse](), error) 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 appID string 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)>) presetID string 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)>)
query PresetGetPresetByIDParams AccountID param.Field\[string] The account identifier tag. maxLength32 Link to this property
[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(method)%20get_preset_by_id%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type PresetGetPresetByIDResponse struct{…}
Data PresetGetPresetByIDResponseData Data returned by the operation ID string ID of the preset formatuuid Link to this property
Config PresetGetPresetByIDResponseDataConfig MaxScreenshareCount float64 Maximum number of screen shares that can be active at a given time Link to this property
MaxVideoStreams PresetGetPresetByIDResponseDataConfigMaxVideoStreams Maximum number of streams that are visible on a device Desktop float64 Maximum number of video streams visible on desktop devices Link to this property Mobile float64 Maximum number of streams visible on mobile devices Link to this property
Link to this property
Media PresetGetPresetByIDResponseDataConfigMedia Media configuration options. eg: Video quality
Screenshare PresetGetPresetByIDResponseDataConfigMediaScreenshare Configuration options for participant screen shares FrameRate float64 Frame rate of screen share Link to this property
Quality PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality Quality of screen share One of the following: const PresetGetPresetByIDResponseDataConfigMediaScreenshareQualityHD PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality = "hd" Link to this property const PresetGetPresetByIDResponseDataConfigMediaScreenshareQualityVga PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality = "vga" Link to this property const PresetGetPresetByIDResponseDataConfigMediaScreenshareQualityQvga PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality = "qvga" Link to this property const PresetGetPresetByIDResponseDataConfigMediaScreenshareQualityFhd PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality = "fhd" Link to this property const PresetGetPresetByIDResponseDataConfigMediaScreenshareQualityUhd PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality = "uhd" Link to this property
Link to this property
Link to this property
Video PresetGetPresetByIDResponseDataConfigMediaVideo Configuration options for participant videos FrameRate float64 Frame rate of participants’ video maximum30 Link to this property
Quality PresetGetPresetByIDResponseDataConfigMediaVideoQuality Video quality of participants One of the following: const PresetGetPresetByIDResponseDataConfigMediaVideoQualityHD PresetGetPresetByIDResponseDataConfigMediaVideoQuality = "hd" Link to this property const PresetGetPresetByIDResponseDataConfigMediaVideoQualityVga PresetGetPresetByIDResponseDataConfigMediaVideoQuality = "vga" Link to this property const PresetGetPresetByIDResponseDataConfigMediaVideoQualityQvga PresetGetPresetByIDResponseDataConfigMediaVideoQuality = "qvga" Link to this property const PresetGetPresetByIDResponseDataConfigMediaVideoQualityFhd PresetGetPresetByIDResponseDataConfigMediaVideoQuality = "fhd" Link to this property const PresetGetPresetByIDResponseDataConfigMediaVideoQualityUhd PresetGetPresetByIDResponseDataConfigMediaVideoQuality = "uhd" Link to this property
Link to this property Simulcast boolOptional Enable simulcast for participant videos. Link to this property
Link to this property
Audio PresetGetPresetByIDResponseDataConfigMediaAudioOptional Control options for Audio quality. EnableHighBitrate boolOptional Enable High Quality Audio for your meetings Link to this property EnableStereo boolOptional Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
ViewType PresetGetPresetByIDResponseDataConfigViewType Type of the meeting One of the following: const PresetGetPresetByIDResponseDataConfigViewTypeGroupCall PresetGetPresetByIDResponseDataConfigViewType = "GROUP\_CALL" Link to this property const PresetGetPresetByIDResponseDataConfigViewTypeWebinar PresetGetPresetByIDResponseDataConfigViewType = "WEBINAR" Link to this property const PresetGetPresetByIDResponseDataConfigViewTypeAudioRoom PresetGetPresetByIDResponseDataConfigViewType = "AUDIO\_ROOM" Link to this property const PresetGetPresetByIDResponseDataConfigViewTypeLivestream PresetGetPresetByIDResponseDataConfigViewType = "LIVESTREAM" Link to this property
Link to this property LivestreamViewerQualities \[]int64Optional Livestream viewer quality levels. Link to this property
Link to this property CreatedAt Time Timestamp this preset was created at formatdate-time Link to this property Name string Name of the preset Link to this property
Permissions PresetGetPresetByIDResponseDataPermissions AcceptWaitingRequests bool Whether this participant can accept waiting requests Link to this property CanAcceptProductionRequests bool Link to this property CanChangeParticipantPermissions bool Link to this property CanEditDisplayName bool Link to this property CanLivestream bool Link to this property CanRecord bool Link to this property CanSpotlight bool Link to this property
Chat PresetGetPresetByIDResponseDataPermissionsChat
Private PresetGetPresetByIDResponseDataPermissionsChatPrivate CanReceive bool Link to this property CanSend bool Link to this property Files bool Link to this property Text bool Link to this property
Link to this property
Public PresetGetPresetByIDResponseDataPermissionsChatPublic CanSend 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
Link to this property
ConnectedMeetings PresetGetPresetByIDResponseDataPermissionsConnectedMeetings CanAlterConnectedMeetings bool Link to this property CanSwitchConnectedMeetings bool Link to this property CanSwitchToParentMeeting bool Link to this property
Link to this property DisableParticipantAudio bool Link to this property DisableParticipantScreensharing bool Link to this property DisableParticipantVideo bool Link to this property HiddenParticipant bool Whether this participant is visible to others or not Link to this property KickParticipant bool Link to this property
Media PresetGetPresetByIDResponseDataPermissionsMedia Media permissions
Audio PresetGetPresetByIDResponseDataPermissionsMediaAudio Audio permissions
CanProduce PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce Can produce audio One of the following: const PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduceAllowed PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce = "ALLOWED" Link to this property const PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduceNotAllowed PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce = "NOT\_ALLOWED" Link to this property const PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduceCanRequest PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce = "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Screenshare PresetGetPresetByIDResponseDataPermissionsMediaScreenshare Screenshare permissions
CanProduce PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce Can produce screen share video One of the following: const PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduceAllowed PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce = "ALLOWED" Link to this property const PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduceNotAllowed PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce = "NOT\_ALLOWED" Link to this property const PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduceCanRequest PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce = "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Video PresetGetPresetByIDResponseDataPermissionsMediaVideo Video permissions
CanProduce PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce Can produce video One of the following: const PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduceAllowed PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce = "ALLOWED" Link to this property const PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduceNotAllowed PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce = "NOT\_ALLOWED" Link to this property const PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduceCanRequest PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce = "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property PinParticipant bool Link to this property
Plugins PresetGetPresetByIDResponseDataPermissionsPlugins Plugin permissions CanClose bool Can close plugins that are already open Link to this property CanEditConfig bool Can edit plugin config Link to this property CanStart bool Can start plugins Link to this property
Config map\[string, PresetGetPresetByIDResponseDataPermissionsPluginsConfig] Plugin configuration keyed by plugin UUID.
AccessControl PresetGetPresetByIDResponseDataPermissionsPluginsConfigAccessControlOptional One of the following: const PresetGetPresetByIDResponseDataPermissionsPluginsConfigAccessControlFullAccess PresetGetPresetByIDResponseDataPermissionsPluginsConfigAccessControl = "FULL\_ACCESS" Link to this property const PresetGetPresetByIDResponseDataPermissionsPluginsConfigAccessControlViewOnly PresetGetPresetByIDResponseDataPermissionsPluginsConfigAccessControl = "VIEW\_ONLY" Link to this property
Link to this property HandlesViewOnly boolOptional Link to this property
Link to this property
Link to this property
Polls PresetGetPresetByIDResponseDataPermissionsPolls Poll permissions CanCreate bool Can create polls Link to this property CanView bool Can view polls Link to this property CanVote bool Can vote on polls Link to this property
Link to this property
RecorderType PresetGetPresetByIDResponseDataPermissionsRecorderType Type of the recording peer One of the following: const PresetGetPresetByIDResponseDataPermissionsRecorderTypeRecorder PresetGetPresetByIDResponseDataPermissionsRecorderType = "RECORDER" Link to this property const PresetGetPresetByIDResponseDataPermissionsRecorderTypeLivestreamer PresetGetPresetByIDResponseDataPermissionsRecorderType = "LIVESTREAMER" Link to this property const PresetGetPresetByIDResponseDataPermissionsRecorderTypeNone PresetGetPresetByIDResponseDataPermissionsRecorderType = "NONE" Link to this property
Link to this property ShowParticipantList bool Link to this property
WaitingRoomType PresetGetPresetByIDResponseDataPermissionsWaitingRoomType Waiting room type One of the following: const PresetGetPresetByIDResponseDataPermissionsWaitingRoomTypeSkip PresetGetPresetByIDResponseDataPermissionsWaitingRoomType = "SKIP" Link to this property const PresetGetPresetByIDResponseDataPermissionsWaitingRoomTypeOnPrivilegedUserEntry PresetGetPresetByIDResponseDataPermissionsWaitingRoomType = "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property const PresetGetPresetByIDResponseDataPermissionsWaitingRoomTypeSkipOnAccept PresetGetPresetByIDResponseDataPermissionsWaitingRoomType = "SKIP\_ON\_ACCEPT" Link to this property
Link to this property AcceptStageRequests boolOptional Link to this property IsRecorder boolOptional Link to this property
StageAccess PresetGetPresetByIDResponseDataPermissionsStageAccessOptional One of the following: const PresetGetPresetByIDResponseDataPermissionsStageAccessAllowed PresetGetPresetByIDResponseDataPermissionsStageAccess = "ALLOWED" Link to this property const PresetGetPresetByIDResponseDataPermissionsStageAccessNotAllowed PresetGetPresetByIDResponseDataPermissionsStageAccess = "NOT\_ALLOWED" Link to this property const PresetGetPresetByIDResponseDataPermissionsStageAccessCanRequest PresetGetPresetByIDResponseDataPermissionsStageAccess = "CAN\_REQUEST" Link to this property
Link to this property StageEnabled boolOptional Link to this property TranscriptionEnabled boolOptional Link to this property
Link to this property
UI PresetGetPresetByIDResponseDataUI
DesignTokens PresetGetPresetByIDResponseDataUIDesignTokens
BorderRadius PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius One of the following: const PresetGetPresetByIDResponseDataUIDesignTokensBorderRadiusSharp PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius = "sharp" Link to this property const PresetGetPresetByIDResponseDataUIDesignTokensBorderRadiusRounded PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius = "rounded" Link to this property const PresetGetPresetByIDResponseDataUIDesignTokensBorderRadiusExtraRounded PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius = "extra-rounded" Link to this property const PresetGetPresetByIDResponseDataUIDesignTokensBorderRadiusCircular PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius = "circular" Link to this property
Link to this property
BorderWidth PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth One of the following: const PresetGetPresetByIDResponseDataUIDesignTokensBorderWidthNone PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth = "none" Link to this property const PresetGetPresetByIDResponseDataUIDesignTokensBorderWidthThin PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth = "thin" Link to this property const PresetGetPresetByIDResponseDataUIDesignTokensBorderWidthFat PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth = "fat" Link to this property
Link to this property
Colors PresetGetPresetByIDResponseDataUIDesignTokensColors
Background PresetGetPresetByIDResponseDataUIDesignTokensColorsBackground Number1000 string Link to this property Number600 string Link to this property Number700 string Link to this property Number800 string Link to this property Number900 string Link to this property
Link to this property
Brand PresetGetPresetByIDResponseDataUIDesignTokensColorsBrand Number300 string Link to this property Number400 string Link to this property Number500 string Link to this property Number600 string Link to this property Number700 string Link to this property
Link to this property Danger string Link to this property Success string Link to this property Text string Link to this property TextOnBrand string Link to this property VideoBg string Link to this property Warning string Link to this property
Link to this property SpacingBase float64 minimum1 Link to this property
Theme PresetGetPresetByIDResponseDataUIDesignTokensTheme One of the following: const PresetGetPresetByIDResponseDataUIDesignTokensThemeDarkest PresetGetPresetByIDResponseDataUIDesignTokensTheme = "darkest" Link to this property const PresetGetPresetByIDResponseDataUIDesignTokensThemeDark PresetGetPresetByIDResponseDataUIDesignTokensTheme = "dark" Link to this property const PresetGetPresetByIDResponseDataUIDesignTokensThemeLight PresetGetPresetByIDResponseDataUIDesignTokensTheme = "light" Link to this property
Link to this property FontFamily stringOptional Link to this property GoogleFont stringOptional Link to this property Logo stringOptional formaturi Link to this property
Link to this property
Link to this property UpdatedAt Time 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)%20PresetGetPresetByIDResponse%20%3E%20(schema)>) ### Fetch details of a preset Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/realtime_kit" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.RealtimeKit.Presets.GetPresetByID( context.TODO(), "14a396e7-ca44-4937-bf1f-050a69118543", "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", realtime_kit.PresetGetPresetByIDParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", 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 } ```