POST /accounts/{account_id}/realtimekit/presets
Creates a preset belonging to the current organization
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Name of the preset |
config |
Object | Yes | |
config.view_type |
String | Yes |
Type of the meeting Valid values:
|
config.media |
Object | Yes |
Media configuration options. eg: Video quality |
config.media.video |
Object | Yes |
Configuration options for participant videos |
config.media.video.quality |
String | Yes |
Video quality of participants Valid values:
|
config.media.video.frame_rate |
Integer | Yes |
Frame rate of participants' video |
config.media.audio |
Object | No |
Control options for Audio quality. |
config.media.audio.enable_high_bitrate |
Boolean | No |
Enable High Quality Audio for your meetings Default value: false |
config.media.audio.enable_stereo |
Boolean | No |
Enable Stereo for your meetings Default value: false |
config.media.screenshare |
Object | Yes |
Configuration options for participant screen shares |
config.media.screenshare.quality |
String | Yes |
Quality of screen share Valid values:
|
config.media.screenshare.frame_rate |
Integer | Yes |
Frame rate of screen share |
config.max_video_streams |
Object | Yes |
Maximum number of streams that are visible on a device |
config.max_video_streams.mobile |
Integer | Yes |
Maximum number of streams visible on mobile devices |
config.max_video_streams.desktop |
Integer | Yes |
Maximum number of video streams visible on desktop devices |
config.max_screenshare_count |
Integer | Yes |
Maximum number of screen shares that can be active at a given time |
ui |
Object | Yes | |
ui.config_diff |
Object | No | |
ui.design_tokens |
Object | Yes | |
ui.design_tokens.border_radius |
String | Yes |
Valid values:
|
ui.design_tokens.logo |
String | Yes | |
ui.design_tokens.spacing_base |
Number | Yes |
Default value: 4 |
ui.design_tokens.border_width |
String | Yes |
Valid values:
|
ui.design_tokens.colors |
Object | Yes | |
ui.design_tokens.colors.text_on_brand |
String | Yes |
Default value: "#EEEEEE" |
ui.design_tokens.colors.text |
String | Yes |
Default value: "#EEEEEE" |
ui.design_tokens.colors.warning |
String | Yes |
Default value: "#FFCD07" |
ui.design_tokens.colors.brand |
Object | Yes | |
ui.design_tokens.colors.brand.300 |
String | Yes |
Default value: "#844d1c" |
ui.design_tokens.colors.brand.400 |
String | Yes |
Default value: "#9d5b22" |
ui.design_tokens.colors.brand.500 |
String | Yes |
Default value: "#b56927" |
ui.design_tokens.colors.brand.600 |
String | Yes |
Default value: "#d37c30" |
ui.design_tokens.colors.brand.700 |
String | Yes |
Default value: "#d9904f" |
ui.design_tokens.colors.danger |
String | Yes |
Default value: "#FF2D2D" |
ui.design_tokens.colors.background |
Object | Yes | |
ui.design_tokens.colors.background.1000 |
String | Yes |
Default value: "#141414" |
ui.design_tokens.colors.background.600 |
String | Yes |
Default value: "#222222" |
ui.design_tokens.colors.background.700 |
String | Yes |
Default value: "#1f1f1f" |
ui.design_tokens.colors.background.800 |
String | Yes |
Default value: "#1b1b1b" |
ui.design_tokens.colors.background.900 |
String | Yes |
Default value: "#181818" |
ui.design_tokens.colors.success |
String | Yes |
Default value: "#62A504" |
ui.design_tokens.colors.video_bg |
String | Yes |
Default value: "#191919" |
ui.design_tokens.theme |
String | Yes |
Valid values:
|
permissions |
Object | No | |
permissions.show_participant_list |
Boolean | Yes | |
permissions.chat |
Object | Yes |
Chat permissions |
permissions.chat.public |
Object | Yes | |
permissions.chat.public.files |
Boolean | Yes |
Can send file messages |
permissions.chat.public.text |
Boolean | Yes |
Can send text messages |
permissions.chat.public.can_send |
Boolean | Yes |
Can send messages in general |
permissions.chat.private |
Object | Yes | |
permissions.chat.private.files |
Boolean | Yes | |
permissions.chat.private.text |
Boolean | Yes | |
permissions.chat.private.can_receive |
Boolean | Yes | |
permissions.chat.private.can_send |
Boolean | Yes | |
permissions.hidden_participant |
Boolean | Yes |
Whether this participant is visible to others or not |
permissions.is_recorder |
Boolean | No |
Default value: false |
permissions.kick_participant |
Boolean | Yes | |
permissions.recorder_type |
String | Yes |
Type of the recording peer Valid values:
Default value: "NONE" |
permissions.connected_meetings |
Object | Yes | |
permissions.connected_meetings.can_switch_to_parent_meeting |
Boolean | Yes | |
permissions.connected_meetings.can_alter_connected_meetings |
Boolean | Yes | |
permissions.connected_meetings.can_switch_connected_meetings |
Boolean | Yes | |
permissions.can_change_participant_permissions |
Boolean | Yes | |
permissions.can_accept_production_requests |
Boolean | Yes | |
permissions.can_livestream |
Boolean | Yes | |
permissions.waiting_room_type |
String | Yes |
Waiting room type Valid values:
|
permissions.can_edit_display_name |
Boolean | Yes | |
permissions.can_spotlight |
Boolean | Yes | |
permissions.disable_participant_audio |
Boolean | Yes | |
permissions.disable_participant_video |
Boolean | Yes | |
permissions.pin_participant |
Boolean | Yes | |
permissions.plugins |
Object | Yes |
Plugin permissions |
permissions.plugins.can_start |
Boolean | Yes |
Can start plugins |
permissions.plugins.can_close |
Boolean | Yes |
Can close plugins that are already open |
permissions.plugins.config |
Yes | ||
permissions.plugins.can_edit_config |
Boolean | Yes |
Can edit plugin config |
permissions.media |
Object | Yes |
Media permissions |
permissions.media.video |
Object | Yes |
Video permissions |
permissions.media.video.can_produce |
String | Yes |
Can produce video Valid values:
|
permissions.media.audio |
Object | Yes |
Audio permissions |
permissions.media.audio.can_produce |
String | Yes |
Can produce audio Valid values:
|
permissions.media.screenshare |
Object | Yes |
Screenshare permissions |
permissions.media.screenshare.can_produce |
String | Yes |
Can produce screen share video Valid values:
|
permissions.polls |
Object | Yes |
Poll permissions |
permissions.polls.can_vote |
Boolean | Yes |
Can vote on polls |
permissions.polls.can_create |
Boolean | Yes |
Can create polls |
permissions.polls.can_view |
Boolean | Yes |
Can view polls |
permissions.disable_participant_screensharing |
Boolean | Yes | |
permissions.can_record |
Boolean | Yes | |
permissions.accept_waiting_requests |
Boolean | Yes |
Whether this participant can accept waiting requests |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.