--- title: Realtime Kit --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Realtime Kit #### Realtime KitApps ##### [Fetch all apps](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/apps/methods/get) GET/accounts/{account\_id}/realtime/kit/apps ##### [Create App](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/apps/methods/post) POST/accounts/{account\_id}/realtime/kit/apps ##### ModelsExpand Collapse

AppGetResponse object {data, paging, success }

data: optional array of object {id, created\_at, name }

id: optional string formatuuid Link to this property created\_at: optional string formatdate-time Link to this property name: optional string Link to this property

Link to this property

paging: optional object {end\_offset, start\_offset, total\_count }

end\_offset: optional number Link to this property start\_offset: optional number Link to this property total\_count: optional number Link to this property

Link to this property success: optional boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.apps%20%3E%20(model)%20app_get_response%20%3E%20(schema)>)

AppPostResponse object {data, success }

data: optional object {app }

app: optional object {id, created\_at, name }

id: optional string formatuuid Link to this property created\_at: optional string formatdate-time Link to this property name: optional string Link to this property

Link to this property

Link to this property success: optional boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.apps%20%3E%20(model)%20app_post_response%20%3E%20(schema)>) #### Realtime KitMeetings ##### [Fetch all meetings for an App](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/meetings/methods/get) GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings ##### [Create a meeting](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/meetings/methods/create) POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings ##### [Fetch a meeting for an App](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/meetings/methods/get_meeting_by_id) GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id} ##### [Update a meeting](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/meetings/methods/update_meeting_by_id) PATCH/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id} ##### [Replace a meeting](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/meetings/methods/replace_meeting_by_id) PUT/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id} ##### [Fetch all participants of a meeting](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/meetings/methods/get_meeting_participants) GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants ##### [Add a participant](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/meetings/methods/add_participant) POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants ##### [Fetch a participant's detail](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/meetings/methods/get_meeting_participant) GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id} ##### [Edit a participant's detail](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/meetings/methods/edit_participant) PATCH/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id} ##### [Delete a participant](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/meetings/methods/delete_meeting_participant) DELETE/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id} ##### [Refresh participant's authentication token](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/meetings/methods/refresh_participant_token) POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id}/token ##### ModelsExpand Collapse

MeetingGetResponse object {data, paging, success }

data: array of object {id, created\_at, updated\_at, 9 more }

id: string ID of the meeting. formatuuid Link to this property created\_at: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property live\_stream\_on\_start: optional boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat: optional boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start: optional boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property

recording\_config: optional object {audio\_config, file\_name\_prefix, live\_streaming\_config, 4 more } Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.

audio\_config: optional object {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.

channel: optional "mono"or "stereo" Audio signal pathway within an audio file that carries a specific sound source.

One of the following: "mono" Link to this property "stereo" Link to this property

Link to this property

codec: optional "MP3"or "AAC" Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

One of the following: "MP3" Link to this property "AAC" Link to this property

Link to this property export\_file: optional boolean Controls whether to export audio file seperately Link to this property

Link to this property file\_name\_prefix: optional string Adds a prefix to the beginning of the file name of the recording. Link to this property

live\_streaming\_config: optional object {rtmp\_url }

rtmp\_url: optional string RTMP URL to stream to formaturi Link to this property

Link to this property max\_seconds: optional number Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property

realtimekit\_bucket\_config: optional object {enabled }

enabled: boolean Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property

Link to this property

storage\_config: optional object {access\_key, auth\_method, bucket, 9 more } or object {access\_key, region, auth\_method, 9 more } or object {private\_key, access\_key, auth\_method, 9 more } or object {password, access\_key, auth\_method, 9 more }

One of the following:

object {access\_key, auth\_method, bucket, 9 more }

access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property

auth\_method: optional "KEY"or "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: optional "gcs" Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {access\_key, region, auth\_method, 9 more }

access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property

auth\_method: optional "KEY"or "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {private\_key, access\_key, auth\_method, 9 more }

private\_key: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: optional "KEY" Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"or 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {password, access\_key, auth\_method, 9 more }

password: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: optional "PASSWORD" Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"or 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

Link to this property

video\_config: optional object {codec, export\_file, height, 2 more }

codec: optional "H264"or "VP8"or "VP9" Codec using which the recording will be encoded.

One of the following: "H264" Link to this property "VP8" Link to this property "VP9" Link to this property

Link to this property export\_file: optional boolean Controls whether to export video file seperately Link to this property height: optional number Height of the recording video in pixels maximum1920 minimum1 Link to this property

watermark: optional object {position, size, url } Watermark to be added to the recording

position: optional "left top"or "right top"or "left bottom"or "right bottom" Position of the watermark

One of the following: "left top" Link to this property "right top" Link to this property "left bottom" Link to this property "right bottom" Link to this property

Link to this property

size: optional object {height, width } Size of the watermark

height: optional number Height of the watermark in px minimum1 Link to this property width: optional number Width of the watermark in px minimum1 Link to this property

Link to this property url: optional string URL of the watermark image formaturi Link to this property

Link to this property width: optional number Width of the recording video in pixels maximum1920 minimum1 Link to this property

Link to this property

Link to this property session\_keep\_alive\_time\_in\_secs: optional number Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property

status: optional "ACTIVE"or "INACTIVE" Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.

One of the following: "ACTIVE" Link to this property "INACTIVE" Link to this property

Link to this property summarize\_on\_end: optional boolean Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title: optional string Title of the meeting. Link to this property transcribe\_on\_end: optional boolean Automatically generate transcripts when the meeting ends. Link to this property

Link to this property

paging: object {end\_offset, start\_offset, total\_count }

end\_offset: number Link to this property start\_offset: number Link to this property total\_count: number minimum0 Link to this property

Link to this property success: boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_get_response%20%3E%20(schema)>)

MeetingCreateResponse object {success, data }

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

data: optional object {id, created\_at, updated\_at, 10 more } Data returned by the operation

id: string ID of the meeting. formatuuid Link to this property created\_at: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property

ai\_config: optional object {summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries

summarization: optional object {summary\_type, text\_format, word\_limit } Summary Config

summary\_type: optional "general"or "team\_meeting"or "sales\_call"or 6 more Defines the style of the summary, such as general, team meeting, or sales call.

One of the following: "general" Link to this property "team\_meeting" Link to this property "sales\_call" Link to this property "client\_check\_in" Link to this property "interview" Link to this property "daily\_standup" Link to this property "one\_on\_one\_meeting" Link to this property "lecture" Link to this property "code\_review" Link to this property

Link to this property

text\_format: optional "plain\_text"or "markdown" Determines the text format of the summary, such as plain text or markdown.

One of the following: "plain\_text" Link to this property "markdown" Link to this property

Link to this property word\_limit: optional number Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property

Link to this property

transcription: optional object {keywords, language, profanity\_filter } Transcription Configurations

keywords: optional array of string Adds specific terms to improve accurate detection during transcription. Link to this property

language: optional "en-US"or "en-IN"or "de"or 7 more Specifies the language code for transcription to ensure accurate results.

One of the following: "en-US" Link to this property "en-IN" Link to this property "de" Link to this property "hi" Link to this property "sv" Link to this property "ru" Link to this property "pl" Link to this property "el" Link to this property "fr" Link to this property "nl" Link to this property

Link to this property profanity\_filter: optional boolean Control the inclusion of offensive language in transcriptions. Link to this property

Link to this property

Link to this property live\_stream\_on\_start: optional boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat: optional boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start: optional boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property

recording\_config: optional object {audio\_config, file\_name\_prefix, live\_streaming\_config, 4 more } Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.

audio\_config: optional object {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.

channel: optional "mono"or "stereo" Audio signal pathway within an audio file that carries a specific sound source.

One of the following: "mono" Link to this property "stereo" Link to this property

Link to this property

codec: optional "MP3"or "AAC" Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

One of the following: "MP3" Link to this property "AAC" Link to this property

Link to this property export\_file: optional boolean Controls whether to export audio file seperately Link to this property

Link to this property file\_name\_prefix: optional string Adds a prefix to the beginning of the file name of the recording. Link to this property

live\_streaming\_config: optional object {rtmp\_url }

rtmp\_url: optional string RTMP URL to stream to formaturi Link to this property

Link to this property max\_seconds: optional number Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property

realtimekit\_bucket\_config: optional object {enabled }

enabled: boolean Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property

Link to this property

storage\_config: optional object {access\_key, auth\_method, bucket, 9 more } or object {access\_key, region, auth\_method, 9 more } or object {private\_key, access\_key, auth\_method, 9 more } or object {password, access\_key, auth\_method, 9 more }

One of the following:

object {access\_key, auth\_method, bucket, 9 more }

access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property

auth\_method: optional "KEY"or "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: optional "gcs" Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {access\_key, region, auth\_method, 9 more }

access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property

auth\_method: optional "KEY"or "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {private\_key, access\_key, auth\_method, 9 more }

private\_key: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: optional "KEY" Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"or 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {password, access\_key, auth\_method, 9 more }

password: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: optional "PASSWORD" Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"or 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

Link to this property

video\_config: optional object {codec, export\_file, height, 2 more }

codec: optional "H264"or "VP8"or "VP9" Codec using which the recording will be encoded.

One of the following: "H264" Link to this property "VP8" Link to this property "VP9" Link to this property

Link to this property export\_file: optional boolean Controls whether to export video file seperately Link to this property height: optional number Height of the recording video in pixels maximum1920 minimum1 Link to this property

watermark: optional object {position, size, url } Watermark to be added to the recording

position: optional "left top"or "right top"or "left bottom"or "right bottom" Position of the watermark

One of the following: "left top" Link to this property "right top" Link to this property "left bottom" Link to this property "right bottom" Link to this property

Link to this property

size: optional object {height, width } Size of the watermark

height: optional number Height of the watermark in px minimum1 Link to this property width: optional number Width of the watermark in px minimum1 Link to this property

Link to this property url: optional string URL of the watermark image formaturi Link to this property

Link to this property width: optional number Width of the recording video in pixels maximum1920 minimum1 Link to this property

Link to this property

Link to this property session\_keep\_alive\_time\_in\_secs: optional number Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property

status: optional "ACTIVE"or "INACTIVE" Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.

One of the following: "ACTIVE" Link to this property "INACTIVE" Link to this property

Link to this property summarize\_on\_end: optional boolean Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title: optional string Title of the meeting. Link to this property transcribe\_on\_end: optional boolean Automatically generate transcripts when the meeting ends. Link to this property

Link to this property

[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_create_response%20%3E%20(schema)>)

MeetingGetMeetingByIDResponse object {success, data }

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

data: optional object {id, created\_at, updated\_at, 10 more } Data returned by the operation

id: string ID of the meeting. formatuuid Link to this property created\_at: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property

ai\_config: optional object {summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries

summarization: optional object {summary\_type, text\_format, word\_limit } Summary Config

summary\_type: optional "general"or "team\_meeting"or "sales\_call"or 6 more Defines the style of the summary, such as general, team meeting, or sales call.

One of the following: "general" Link to this property "team\_meeting" Link to this property "sales\_call" Link to this property "client\_check\_in" Link to this property "interview" Link to this property "daily\_standup" Link to this property "one\_on\_one\_meeting" Link to this property "lecture" Link to this property "code\_review" Link to this property

Link to this property

text\_format: optional "plain\_text"or "markdown" Determines the text format of the summary, such as plain text or markdown.

One of the following: "plain\_text" Link to this property "markdown" Link to this property

Link to this property word\_limit: optional number Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property

Link to this property

transcription: optional object {keywords, language, profanity\_filter } Transcription Configurations

keywords: optional array of string Adds specific terms to improve accurate detection during transcription. Link to this property

language: optional "en-US"or "en-IN"or "de"or 7 more Specifies the language code for transcription to ensure accurate results.

One of the following: "en-US" Link to this property "en-IN" Link to this property "de" Link to this property "hi" Link to this property "sv" Link to this property "ru" Link to this property "pl" Link to this property "el" Link to this property "fr" Link to this property "nl" Link to this property

Link to this property profanity\_filter: optional boolean Control the inclusion of offensive language in transcriptions. Link to this property

Link to this property

Link to this property live\_stream\_on\_start: optional boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat: optional boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start: optional boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property

recording\_config: optional object {audio\_config, file\_name\_prefix, live\_streaming\_config, 4 more } Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.

audio\_config: optional object {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.

channel: optional "mono"or "stereo" Audio signal pathway within an audio file that carries a specific sound source.

One of the following: "mono" Link to this property "stereo" Link to this property

Link to this property

codec: optional "MP3"or "AAC" Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

One of the following: "MP3" Link to this property "AAC" Link to this property

Link to this property export\_file: optional boolean Controls whether to export audio file seperately Link to this property

Link to this property file\_name\_prefix: optional string Adds a prefix to the beginning of the file name of the recording. Link to this property

live\_streaming\_config: optional object {rtmp\_url }

rtmp\_url: optional string RTMP URL to stream to formaturi Link to this property

Link to this property max\_seconds: optional number Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property

realtimekit\_bucket\_config: optional object {enabled }

enabled: boolean Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property

Link to this property

storage\_config: optional object {access\_key, auth\_method, bucket, 9 more } or object {access\_key, region, auth\_method, 9 more } or object {private\_key, access\_key, auth\_method, 9 more } or object {password, access\_key, auth\_method, 9 more }

One of the following:

object {access\_key, auth\_method, bucket, 9 more }

access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property

auth\_method: optional "KEY"or "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: optional "gcs" Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {access\_key, region, auth\_method, 9 more }

access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property

auth\_method: optional "KEY"or "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {private\_key, access\_key, auth\_method, 9 more }

private\_key: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: optional "KEY" Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"or 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {password, access\_key, auth\_method, 9 more }

password: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: optional "PASSWORD" Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"or 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

Link to this property

video\_config: optional object {codec, export\_file, height, 2 more }

codec: optional "H264"or "VP8"or "VP9" Codec using which the recording will be encoded.

One of the following: "H264" Link to this property "VP8" Link to this property "VP9" Link to this property

Link to this property export\_file: optional boolean Controls whether to export video file seperately Link to this property height: optional number Height of the recording video in pixels maximum1920 minimum1 Link to this property

watermark: optional object {position, size, url } Watermark to be added to the recording

position: optional "left top"or "right top"or "left bottom"or "right bottom" Position of the watermark

One of the following: "left top" Link to this property "right top" Link to this property "left bottom" Link to this property "right bottom" Link to this property

Link to this property

size: optional object {height, width } Size of the watermark

height: optional number Height of the watermark in px minimum1 Link to this property width: optional number Width of the watermark in px minimum1 Link to this property

Link to this property url: optional string URL of the watermark image formaturi Link to this property

Link to this property width: optional number Width of the recording video in pixels maximum1920 minimum1 Link to this property

Link to this property

Link to this property session\_keep\_alive\_time\_in\_secs: optional number Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property

status: optional "ACTIVE"or "INACTIVE" Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.

One of the following: "ACTIVE" Link to this property "INACTIVE" Link to this property

Link to this property summarize\_on\_end: optional boolean Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title: optional string Title of the meeting. Link to this property transcribe\_on\_end: optional boolean Automatically generate transcripts when the meeting ends. Link to this property

Link to this property

[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_get_meeting_by_id_response%20%3E%20(schema)>)

MeetingUpdateMeetingByIDResponse object {success, data }

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

data: optional object {id, created\_at, updated\_at, 10 more } Data returned by the operation

id: string ID of the meeting. formatuuid Link to this property created\_at: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property

ai\_config: optional object {summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries

summarization: optional object {summary\_type, text\_format, word\_limit } Summary Config

summary\_type: optional "general"or "team\_meeting"or "sales\_call"or 6 more Defines the style of the summary, such as general, team meeting, or sales call.

One of the following: "general" Link to this property "team\_meeting" Link to this property "sales\_call" Link to this property "client\_check\_in" Link to this property "interview" Link to this property "daily\_standup" Link to this property "one\_on\_one\_meeting" Link to this property "lecture" Link to this property "code\_review" Link to this property

Link to this property

text\_format: optional "plain\_text"or "markdown" Determines the text format of the summary, such as plain text or markdown.

One of the following: "plain\_text" Link to this property "markdown" Link to this property

Link to this property word\_limit: optional number Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property

Link to this property

transcription: optional object {keywords, language, profanity\_filter } Transcription Configurations

keywords: optional array of string Adds specific terms to improve accurate detection during transcription. Link to this property

language: optional "en-US"or "en-IN"or "de"or 7 more Specifies the language code for transcription to ensure accurate results.

One of the following: "en-US" Link to this property "en-IN" Link to this property "de" Link to this property "hi" Link to this property "sv" Link to this property "ru" Link to this property "pl" Link to this property "el" Link to this property "fr" Link to this property "nl" Link to this property

Link to this property profanity\_filter: optional boolean Control the inclusion of offensive language in transcriptions. Link to this property

Link to this property

Link to this property live\_stream\_on\_start: optional boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat: optional boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start: optional boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property

recording\_config: optional object {audio\_config, file\_name\_prefix, live\_streaming\_config, 4 more } Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.

audio\_config: optional object {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.

channel: optional "mono"or "stereo" Audio signal pathway within an audio file that carries a specific sound source.

One of the following: "mono" Link to this property "stereo" Link to this property

Link to this property

codec: optional "MP3"or "AAC" Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

One of the following: "MP3" Link to this property "AAC" Link to this property

Link to this property export\_file: optional boolean Controls whether to export audio file seperately Link to this property

Link to this property file\_name\_prefix: optional string Adds a prefix to the beginning of the file name of the recording. Link to this property

live\_streaming\_config: optional object {rtmp\_url }

rtmp\_url: optional string RTMP URL to stream to formaturi Link to this property

Link to this property max\_seconds: optional number Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property

realtimekit\_bucket\_config: optional object {enabled }

enabled: boolean Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property

Link to this property

storage\_config: optional object {access\_key, auth\_method, bucket, 9 more } or object {access\_key, region, auth\_method, 9 more } or object {private\_key, access\_key, auth\_method, 9 more } or object {password, access\_key, auth\_method, 9 more }

One of the following:

object {access\_key, auth\_method, bucket, 9 more }

access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property

auth\_method: optional "KEY"or "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: optional "gcs" Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {access\_key, region, auth\_method, 9 more }

access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property

auth\_method: optional "KEY"or "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {private\_key, access\_key, auth\_method, 9 more }

private\_key: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: optional "KEY" Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"or 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {password, access\_key, auth\_method, 9 more }

password: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: optional "PASSWORD" Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"or 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

Link to this property

video\_config: optional object {codec, export\_file, height, 2 more }

codec: optional "H264"or "VP8"or "VP9" Codec using which the recording will be encoded.

One of the following: "H264" Link to this property "VP8" Link to this property "VP9" Link to this property

Link to this property export\_file: optional boolean Controls whether to export video file seperately Link to this property height: optional number Height of the recording video in pixels maximum1920 minimum1 Link to this property

watermark: optional object {position, size, url } Watermark to be added to the recording

position: optional "left top"or "right top"or "left bottom"or "right bottom" Position of the watermark

One of the following: "left top" Link to this property "right top" Link to this property "left bottom" Link to this property "right bottom" Link to this property

Link to this property

size: optional object {height, width } Size of the watermark

height: optional number Height of the watermark in px minimum1 Link to this property width: optional number Width of the watermark in px minimum1 Link to this property

Link to this property url: optional string URL of the watermark image formaturi Link to this property

Link to this property width: optional number Width of the recording video in pixels maximum1920 minimum1 Link to this property

Link to this property

Link to this property session\_keep\_alive\_time\_in\_secs: optional number Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property

status: optional "ACTIVE"or "INACTIVE" Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.

One of the following: "ACTIVE" Link to this property "INACTIVE" Link to this property

Link to this property summarize\_on\_end: optional boolean Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title: optional string Title of the meeting. Link to this property transcribe\_on\_end: optional boolean Automatically generate transcripts when the meeting ends. Link to this property

Link to this property

[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_update_meeting_by_id_response%20%3E%20(schema)>)

MeetingReplaceMeetingByIDResponse object {success, data }

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

data: optional object {id, created\_at, updated\_at, 10 more } Data returned by the operation

id: string ID of the meeting. formatuuid Link to this property created\_at: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property

ai\_config: optional object {summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries

summarization: optional object {summary\_type, text\_format, word\_limit } Summary Config

summary\_type: optional "general"or "team\_meeting"or "sales\_call"or 6 more Defines the style of the summary, such as general, team meeting, or sales call.

One of the following: "general" Link to this property "team\_meeting" Link to this property "sales\_call" Link to this property "client\_check\_in" Link to this property "interview" Link to this property "daily\_standup" Link to this property "one\_on\_one\_meeting" Link to this property "lecture" Link to this property "code\_review" Link to this property

Link to this property

text\_format: optional "plain\_text"or "markdown" Determines the text format of the summary, such as plain text or markdown.

One of the following: "plain\_text" Link to this property "markdown" Link to this property

Link to this property word\_limit: optional number Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property

Link to this property

transcription: optional object {keywords, language, profanity\_filter } Transcription Configurations

keywords: optional array of string Adds specific terms to improve accurate detection during transcription. Link to this property

language: optional "en-US"or "en-IN"or "de"or 7 more Specifies the language code for transcription to ensure accurate results.

One of the following: "en-US" Link to this property "en-IN" Link to this property "de" Link to this property "hi" Link to this property "sv" Link to this property "ru" Link to this property "pl" Link to this property "el" Link to this property "fr" Link to this property "nl" Link to this property

Link to this property profanity\_filter: optional boolean Control the inclusion of offensive language in transcriptions. Link to this property

Link to this property

Link to this property live\_stream\_on\_start: optional boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat: optional boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start: optional boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property

recording\_config: optional object {audio\_config, file\_name\_prefix, live\_streaming\_config, 4 more } Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.

audio\_config: optional object {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.

channel: optional "mono"or "stereo" Audio signal pathway within an audio file that carries a specific sound source.

One of the following: "mono" Link to this property "stereo" Link to this property

Link to this property

codec: optional "MP3"or "AAC" Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

One of the following: "MP3" Link to this property "AAC" Link to this property

Link to this property export\_file: optional boolean Controls whether to export audio file seperately Link to this property

Link to this property file\_name\_prefix: optional string Adds a prefix to the beginning of the file name of the recording. Link to this property

live\_streaming\_config: optional object {rtmp\_url }

rtmp\_url: optional string RTMP URL to stream to formaturi Link to this property

Link to this property max\_seconds: optional number Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property

realtimekit\_bucket\_config: optional object {enabled }

enabled: boolean Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property

Link to this property

storage\_config: optional object {access\_key, auth\_method, bucket, 9 more } or object {access\_key, region, auth\_method, 9 more } or object {private\_key, access\_key, auth\_method, 9 more } or object {password, access\_key, auth\_method, 9 more }

One of the following:

object {access\_key, auth\_method, bucket, 9 more }

access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property

auth\_method: optional "KEY"or "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: optional "gcs" Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {access\_key, region, auth\_method, 9 more }

access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property

auth\_method: optional "KEY"or "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {private\_key, access\_key, auth\_method, 9 more }

private\_key: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: optional "KEY" Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"or 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {password, access\_key, auth\_method, 9 more }

password: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: optional "PASSWORD" Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type: optional "aws"or "azure"or "digitalocean"or 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

Link to this property

video\_config: optional object {codec, export\_file, height, 2 more }

codec: optional "H264"or "VP8"or "VP9" Codec using which the recording will be encoded.

One of the following: "H264" Link to this property "VP8" Link to this property "VP9" Link to this property

Link to this property export\_file: optional boolean Controls whether to export video file seperately Link to this property height: optional number Height of the recording video in pixels maximum1920 minimum1 Link to this property

watermark: optional object {position, size, url } Watermark to be added to the recording

position: optional "left top"or "right top"or "left bottom"or "right bottom" Position of the watermark

One of the following: "left top" Link to this property "right top" Link to this property "left bottom" Link to this property "right bottom" Link to this property

Link to this property

size: optional object {height, width } Size of the watermark

height: optional number Height of the watermark in px minimum1 Link to this property width: optional number Width of the watermark in px minimum1 Link to this property

Link to this property url: optional string URL of the watermark image formaturi Link to this property

Link to this property width: optional number Width of the recording video in pixels maximum1920 minimum1 Link to this property

Link to this property

Link to this property session\_keep\_alive\_time\_in\_secs: optional number Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property

status: optional "ACTIVE"or "INACTIVE" Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.

One of the following: "ACTIVE" Link to this property "INACTIVE" Link to this property

Link to this property summarize\_on\_end: optional boolean Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title: optional string Title of the meeting. Link to this property transcribe\_on\_end: optional boolean Automatically generate transcripts when the meeting ends. Link to this property

Link to this property

[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_replace_meeting_by_id_response%20%3E%20(schema)>)

MeetingGetMeetingParticipantsResponse object {data, paging, success }

data: array of object {id, created\_at, custom\_participant\_id, 4 more }

id: string ID of the participant. formatuuid Link to this property created\_at: string When this object was created. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: string A unique participant ID generated by the client. Link to this property preset\_name: string Preset applied to the participant. Link to this property updated\_at: string When this object was updated. The time is returned in ISO format. formatdate-time Link to this property name: optional string Name of the participant. Link to this property picture: optional string URL to a picture of the participant. formaturi Link to this property

Link to this property

paging: object {end\_offset, start\_offset, total\_count }

end\_offset: number Link to this property start\_offset: number Link to this property total\_count: number minimum0 Link to this property

Link to this property success: boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_get_meeting_participants_response%20%3E%20(schema)>)

MeetingAddParticipantResponse object {success, data }

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

data: optional object {id, token, created\_at, 5 more } Represents a participant.

id: string ID of the participant. formatuuid Link to this property token: string The participant’s auth token that can be used for joining a meeting from the client side. Link to this property created\_at: string When this object was created. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: string A unique participant ID generated by the client. Link to this property preset\_name: string Preset applied to the participant. Link to this property updated\_at: string When this object was updated. The time is returned in ISO format. formatdate-time Link to this property name: optional string Name of the participant. Link to this property picture: optional string URL to a picture of the participant. formaturi Link to this property

Link to this property

[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_add_participant_response%20%3E%20(schema)>)

MeetingGetMeetingParticipantResponse object {data, success }

data: object {id, created\_at, custom\_participant\_id, 4 more } Data returned by the operation

id: string ID of the participant. formatuuid Link to this property created\_at: string When this object was created. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: string A unique participant ID generated by the client. Link to this property preset\_name: string Preset applied to the participant. Link to this property updated\_at: string When this object was updated. The time is returned in ISO format. formatdate-time Link to this property name: optional string Name of the participant. Link to this property picture: optional string URL to a picture of the participant. formaturi Link to this property

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

[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_get_meeting_participant_response%20%3E%20(schema)>)

MeetingEditParticipantResponse object {success, data }

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

data: optional object {id, token, created\_at, 5 more } Represents a participant.

id: string ID of the participant. formatuuid Link to this property token: string The participant’s auth token that can be used for joining a meeting from the client side. Link to this property created\_at: string When this object was created. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: string A unique participant ID generated by the client. Link to this property preset\_name: string Preset applied to the participant. Link to this property updated\_at: string When this object was updated. The time is returned in ISO format. formatdate-time Link to this property name: optional string Name of the participant. Link to this property picture: optional string URL to a picture of the participant. formaturi Link to this property

Link to this property

[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_edit_participant_response%20%3E%20(schema)>)

MeetingDeleteMeetingParticipantResponse object {success, data }

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

data: optional object {created\_at, custom\_participant\_id, preset\_id, updated\_at } Data returned by the operation

created\_at: string Timestamp this object was created at. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: string A unique participant ID generated by the client. Link to this property preset\_id: string ID of the preset applied to this participant. formatuuid Link to this property updated\_at: string Timestamp this object was updated at. The time is returned in ISO format. formatdate-time Link to this property

Link to this property

[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_delete_meeting_participant_response%20%3E%20(schema)>)

MeetingRefreshParticipantTokenResponse object {data, success }

data: object {token } Data returned by the operation

token: string Regenerated participant’s authentication token. Link to this property

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

[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_refresh_participant_token_response%20%3E%20(schema)>) #### Realtime KitPresets ##### [Fetch all presets](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/presets/methods/get) GET/accounts/{account\_id}/realtime/kit/{app\_id}/presets ##### [Create a preset](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/presets/methods/create) POST/accounts/{account\_id}/realtime/kit/{app\_id}/presets ##### [Fetch details of a preset](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/presets/methods/get_preset_by_id) GET/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### [Delete a preset](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/presets/methods/delete) DELETE/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### [Update a preset](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/presets/methods/update) PATCH/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### [Replace a preset](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/presets/methods/replace_preset_by_id) PUT/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### ModelsExpand Collapse

PresetGetResponse object {data, paging, success }

data: array of object {id, created\_at, name, updated\_at }

id: optional string ID of the preset formatuuid Link to this property created\_at: optional string Timestamp this preset was created at formatdate-time Link to this property name: optional string Name of the preset Link to this property updated\_at: optional string Timestamp this preset was last updated formatdate-time Link to this property

Link to this property

paging: object {end\_offset, start\_offset, total\_count }

end\_offset: number Link to this property start\_offset: number Link to this property total\_count: number minimum0 Link to this property

Link to this property success: boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_get_response%20%3E%20(schema)>)

PresetCreateResponse object {data, success }

data: object {id, config, created\_at, 4 more } Data returned by the operation

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

config: object {max\_screenshare\_count, max\_video\_streams, media, 2 more }

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

max\_video\_streams: object {desktop, mobile } Maximum number of streams that are visible on a device

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

Link to this property

media: object {screenshare, video, audio } Media configuration options. eg: Video quality

screenshare: object {frame\_rate, quality } Configuration options for participant screen shares

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

quality: "hd"or "vga"or "qvga"or 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

Link to this property

video: object {frame\_rate, quality, simulcast } Configuration options for participant videos

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

quality: "hd"or "vga"or "qvga"or 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 boolean Enable simulcast for participant videos. Link to this property

Link to this property

audio: optional object {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality.

enable\_high\_bitrate: optional boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo: optional boolean Enable Stereo for your meetings Link to this property

Link to this property

Link to this property

view\_type: "GROUP\_CALL"or "WEBINAR"or "AUDIO\_ROOM"or "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 array of number Livestream viewer quality levels. Link to this property

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

permissions: object {accept\_waiting\_requests, can\_accept\_production\_requests, can\_change\_participant\_permissions, 23 more }

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

chat: object {private, public }

private: object {can\_receive, can\_send, files, text }

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

Link to this property

public: object {can\_send, files, text }

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

Link to this property

Link to this property

connected\_meetings: object {can\_alter\_connected\_meetings, can\_switch\_connected\_meetings, can\_switch\_to\_parent\_meeting }

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

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

media: object {audio, screenshare, video } Media permissions

audio: object {can\_produce } Audio permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

Link to this property

screenshare: object {can\_produce } Screenshare permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

Link to this property

video: object {can\_produce } Video permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

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

plugins: object {can\_close, can\_edit\_config, can\_start, config } Plugin permissions

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

config: map\[object {access\_control, handles\_view\_only } ] Plugin configuration keyed by plugin UUID.

access\_control: optional "FULL\_ACCESS"or "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 boolean Link to this property

Link to this property

Link to this property

polls: object {can\_create, can\_view, can\_vote } Poll permissions

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

Link to this property

recorder\_type: "RECORDER"or "LIVESTREAMER"or "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: boolean Link to this property

waiting\_room\_type: "SKIP"or "ON\_PRIVILEGED\_USER\_ENTRY"or "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 boolean Link to this property is\_recorder: optional boolean Link to this property

stage\_access: optional "ALLOWED"or "NOT\_ALLOWED"or "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 boolean Link to this property transcription\_enabled: optional boolean Link to this property

Link to this property

ui: object {design\_tokens }

design\_tokens: object {border\_radius, border\_width, colors, 5 more }

border\_radius: "sharp"or "rounded"or "extra-rounded"or "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: "none"or "thin"or "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: object {background, brand, danger, 5 more }

background: object {"1000", "600", "700", 2 more }

"1000": string Link to this property "600": string Link to this property "700": string Link to this property "800": string Link to this property "900": string Link to this property

Link to this property

brand: object {"300", "400", "500", 2 more }

"300": string Link to this property "400": string Link to this property "500": string Link to this property "600": string Link to this property "700": 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 text\_on\_brand: string Link to this property video\_bg: string Link to this property warning: string Link to this property

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

theme: "darkest"or "dark"or "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 string Link to this property google\_font: optional string Link to this property logo: optional string formaturi Link to this property

Link to this property

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

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

[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_create_response%20%3E%20(schema)>)

PresetGetPresetByIDResponse object {data, success }

data: object {id, config, created\_at, 4 more } Data returned by the operation

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

config: object {max\_screenshare\_count, max\_video\_streams, media, 2 more }

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

max\_video\_streams: object {desktop, mobile } Maximum number of streams that are visible on a device

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

Link to this property

media: object {screenshare, video, audio } Media configuration options. eg: Video quality

screenshare: object {frame\_rate, quality } Configuration options for participant screen shares

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

quality: "hd"or "vga"or "qvga"or 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

Link to this property

video: object {frame\_rate, quality, simulcast } Configuration options for participant videos

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

quality: "hd"or "vga"or "qvga"or 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 boolean Enable simulcast for participant videos. Link to this property

Link to this property

audio: optional object {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality.

enable\_high\_bitrate: optional boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo: optional boolean Enable Stereo for your meetings Link to this property

Link to this property

Link to this property

view\_type: "GROUP\_CALL"or "WEBINAR"or "AUDIO\_ROOM"or "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 array of number Livestream viewer quality levels. Link to this property

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

permissions: object {accept\_waiting\_requests, can\_accept\_production\_requests, can\_change\_participant\_permissions, 23 more }

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

chat: object {private, public }

private: object {can\_receive, can\_send, files, text }

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

Link to this property

public: object {can\_send, files, text }

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

Link to this property

Link to this property

connected\_meetings: object {can\_alter\_connected\_meetings, can\_switch\_connected\_meetings, can\_switch\_to\_parent\_meeting }

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

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

media: object {audio, screenshare, video } Media permissions

audio: object {can\_produce } Audio permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

Link to this property

screenshare: object {can\_produce } Screenshare permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

Link to this property

video: object {can\_produce } Video permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

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

plugins: object {can\_close, can\_edit\_config, can\_start, config } Plugin permissions

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

config: map\[object {access\_control, handles\_view\_only } ] Plugin configuration keyed by plugin UUID.

access\_control: optional "FULL\_ACCESS"or "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 boolean Link to this property

Link to this property

Link to this property

polls: object {can\_create, can\_view, can\_vote } Poll permissions

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

Link to this property

recorder\_type: "RECORDER"or "LIVESTREAMER"or "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: boolean Link to this property

waiting\_room\_type: "SKIP"or "ON\_PRIVILEGED\_USER\_ENTRY"or "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 boolean Link to this property is\_recorder: optional boolean Link to this property

stage\_access: optional "ALLOWED"or "NOT\_ALLOWED"or "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 boolean Link to this property transcription\_enabled: optional boolean Link to this property

Link to this property

ui: object {design\_tokens }

design\_tokens: object {border\_radius, border\_width, colors, 5 more }

border\_radius: "sharp"or "rounded"or "extra-rounded"or "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: "none"or "thin"or "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: object {background, brand, danger, 5 more }

background: object {"1000", "600", "700", 2 more }

"1000": string Link to this property "600": string Link to this property "700": string Link to this property "800": string Link to this property "900": string Link to this property

Link to this property

brand: object {"300", "400", "500", 2 more }

"300": string Link to this property "400": string Link to this property "500": string Link to this property "600": string Link to this property "700": 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 text\_on\_brand: string Link to this property video\_bg: string Link to this property warning: string Link to this property

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

theme: "darkest"or "dark"or "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 string Link to this property google\_font: optional string Link to this property logo: optional string formaturi Link to this property

Link to this property

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

Link to this property success: boolean 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)>)

PresetDeleteResponse object {data, success }

data: object {id, config, created\_at, 4 more } Data returned by the operation

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

config: object {max\_screenshare\_count, max\_video\_streams, media, 2 more }

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

max\_video\_streams: object {desktop, mobile } Maximum number of streams that are visible on a device

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

Link to this property

media: object {screenshare, video, audio } Media configuration options. eg: Video quality

screenshare: object {frame\_rate, quality } Configuration options for participant screen shares

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

quality: "hd"or "vga"or "qvga"or 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

Link to this property

video: object {frame\_rate, quality, simulcast } Configuration options for participant videos

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

quality: "hd"or "vga"or "qvga"or 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 boolean Enable simulcast for participant videos. Link to this property

Link to this property

audio: optional object {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality.

enable\_high\_bitrate: optional boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo: optional boolean Enable Stereo for your meetings Link to this property

Link to this property

Link to this property

view\_type: "GROUP\_CALL"or "WEBINAR"or "AUDIO\_ROOM"or "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 array of number Livestream viewer quality levels. Link to this property

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

permissions: object {accept\_waiting\_requests, can\_accept\_production\_requests, can\_change\_participant\_permissions, 23 more }

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

chat: object {private, public }

private: object {can\_receive, can\_send, files, text }

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

Link to this property

public: object {can\_send, files, text }

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

Link to this property

Link to this property

connected\_meetings: object {can\_alter\_connected\_meetings, can\_switch\_connected\_meetings, can\_switch\_to\_parent\_meeting }

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

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

media: object {audio, screenshare, video } Media permissions

audio: object {can\_produce } Audio permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

Link to this property

screenshare: object {can\_produce } Screenshare permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

Link to this property

video: object {can\_produce } Video permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

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

plugins: object {can\_close, can\_edit\_config, can\_start, config } Plugin permissions

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

config: map\[object {access\_control, handles\_view\_only } ] Plugin configuration keyed by plugin UUID.

access\_control: optional "FULL\_ACCESS"or "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 boolean Link to this property

Link to this property

Link to this property

polls: object {can\_create, can\_view, can\_vote } Poll permissions

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

Link to this property

recorder\_type: "RECORDER"or "LIVESTREAMER"or "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: boolean Link to this property

waiting\_room\_type: "SKIP"or "ON\_PRIVILEGED\_USER\_ENTRY"or "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 boolean Link to this property is\_recorder: optional boolean Link to this property

stage\_access: optional "ALLOWED"or "NOT\_ALLOWED"or "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 boolean Link to this property transcription\_enabled: optional boolean Link to this property

Link to this property

ui: object {design\_tokens }

design\_tokens: object {border\_radius, border\_width, colors, 5 more }

border\_radius: "sharp"or "rounded"or "extra-rounded"or "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: "none"or "thin"or "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: object {background, brand, danger, 5 more }

background: object {"1000", "600", "700", 2 more }

"1000": string Link to this property "600": string Link to this property "700": string Link to this property "800": string Link to this property "900": string Link to this property

Link to this property

brand: object {"300", "400", "500", 2 more }

"300": string Link to this property "400": string Link to this property "500": string Link to this property "600": string Link to this property "700": 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 text\_on\_brand: string Link to this property video\_bg: string Link to this property warning: string Link to this property

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

theme: "darkest"or "dark"or "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 string Link to this property google\_font: optional string Link to this property logo: optional string formaturi Link to this property

Link to this property

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

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

[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_delete_response%20%3E%20(schema)>)

PresetUpdateResponse object {data, success }

data: object {id, config, created\_at, 4 more } Data returned by the operation

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

config: object {max\_screenshare\_count, max\_video\_streams, media, 2 more }

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

max\_video\_streams: object {desktop, mobile } Maximum number of streams that are visible on a device

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

Link to this property

media: object {screenshare, video, audio } Media configuration options. eg: Video quality

screenshare: object {frame\_rate, quality } Configuration options for participant screen shares

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

quality: "hd"or "vga"or "qvga"or 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

Link to this property

video: object {frame\_rate, quality, simulcast } Configuration options for participant videos

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

quality: "hd"or "vga"or "qvga"or 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 boolean Enable simulcast for participant videos. Link to this property

Link to this property

audio: optional object {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality.

enable\_high\_bitrate: optional boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo: optional boolean Enable Stereo for your meetings Link to this property

Link to this property

Link to this property

view\_type: "GROUP\_CALL"or "WEBINAR"or "AUDIO\_ROOM"or "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 array of number Livestream viewer quality levels. Link to this property

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

permissions: object {accept\_waiting\_requests, can\_accept\_production\_requests, can\_change\_participant\_permissions, 23 more }

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

chat: object {private, public }

private: object {can\_receive, can\_send, files, text }

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

Link to this property

public: object {can\_send, files, text }

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

Link to this property

Link to this property

connected\_meetings: object {can\_alter\_connected\_meetings, can\_switch\_connected\_meetings, can\_switch\_to\_parent\_meeting }

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

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

media: object {audio, screenshare, video } Media permissions

audio: object {can\_produce } Audio permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

Link to this property

screenshare: object {can\_produce } Screenshare permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

Link to this property

video: object {can\_produce } Video permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

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

plugins: object {can\_close, can\_edit\_config, can\_start, config } Plugin permissions

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

config: map\[object {access\_control, handles\_view\_only } ] Plugin configuration keyed by plugin UUID.

access\_control: optional "FULL\_ACCESS"or "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 boolean Link to this property

Link to this property

Link to this property

polls: object {can\_create, can\_view, can\_vote } Poll permissions

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

Link to this property

recorder\_type: "RECORDER"or "LIVESTREAMER"or "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: boolean Link to this property

waiting\_room\_type: "SKIP"or "ON\_PRIVILEGED\_USER\_ENTRY"or "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 boolean Link to this property is\_recorder: optional boolean Link to this property

stage\_access: optional "ALLOWED"or "NOT\_ALLOWED"or "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 boolean Link to this property transcription\_enabled: optional boolean Link to this property

Link to this property

ui: object {design\_tokens }

design\_tokens: object {border\_radius, border\_width, colors, 5 more }

border\_radius: "sharp"or "rounded"or "extra-rounded"or "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: "none"or "thin"or "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: object {background, brand, danger, 5 more }

background: object {"1000", "600", "700", 2 more }

"1000": string Link to this property "600": string Link to this property "700": string Link to this property "800": string Link to this property "900": string Link to this property

Link to this property

brand: object {"300", "400", "500", 2 more }

"300": string Link to this property "400": string Link to this property "500": string Link to this property "600": string Link to this property "700": 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 text\_on\_brand: string Link to this property video\_bg: string Link to this property warning: string Link to this property

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

theme: "darkest"or "dark"or "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 string Link to this property google\_font: optional string Link to this property logo: optional string formaturi Link to this property

Link to this property

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

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

[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_update_response%20%3E%20(schema)>)

PresetReplacePresetByIDResponse object {data, success }

data: object {id, config, created\_at, 4 more } Data returned by the operation

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

config: object {max\_screenshare\_count, max\_video\_streams, media, 2 more }

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

max\_video\_streams: object {desktop, mobile } Maximum number of streams that are visible on a device

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

Link to this property

media: object {screenshare, video, audio } Media configuration options. eg: Video quality

screenshare: object {frame\_rate, quality } Configuration options for participant screen shares

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

quality: "hd"or "vga"or "qvga"or 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

Link to this property

video: object {frame\_rate, quality, simulcast } Configuration options for participant videos

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

quality: "hd"or "vga"or "qvga"or 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 boolean Enable simulcast for participant videos. Link to this property

Link to this property

audio: optional object {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality.

enable\_high\_bitrate: optional boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo: optional boolean Enable Stereo for your meetings Link to this property

Link to this property

Link to this property

view\_type: "GROUP\_CALL"or "WEBINAR"or "AUDIO\_ROOM"or "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 array of number Livestream viewer quality levels. Link to this property

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

permissions: object {accept\_waiting\_requests, can\_accept\_production\_requests, can\_change\_participant\_permissions, 23 more }

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

chat: object {private, public }

private: object {can\_receive, can\_send, files, text }

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

Link to this property

public: object {can\_send, files, text }

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

Link to this property

Link to this property

connected\_meetings: object {can\_alter\_connected\_meetings, can\_switch\_connected\_meetings, can\_switch\_to\_parent\_meeting }

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

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

media: object {audio, screenshare, video } Media permissions

audio: object {can\_produce } Audio permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

Link to this property

screenshare: object {can\_produce } Screenshare permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

Link to this property

video: object {can\_produce } Video permissions

can\_produce: "ALLOWED"or "NOT\_ALLOWED"or "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

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

plugins: object {can\_close, can\_edit\_config, can\_start, config } Plugin permissions

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

config: map\[object {access\_control, handles\_view\_only } ] Plugin configuration keyed by plugin UUID.

access\_control: optional "FULL\_ACCESS"or "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 boolean Link to this property

Link to this property

Link to this property

polls: object {can\_create, can\_view, can\_vote } Poll permissions

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

Link to this property

recorder\_type: "RECORDER"or "LIVESTREAMER"or "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: boolean Link to this property

waiting\_room\_type: "SKIP"or "ON\_PRIVILEGED\_USER\_ENTRY"or "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 boolean Link to this property is\_recorder: optional boolean Link to this property

stage\_access: optional "ALLOWED"or "NOT\_ALLOWED"or "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 boolean Link to this property transcription\_enabled: optional boolean Link to this property

Link to this property

ui: object {design\_tokens }

design\_tokens: object {border\_radius, border\_width, colors, 5 more }

border\_radius: "sharp"or "rounded"or "extra-rounded"or "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: "none"or "thin"or "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: object {background, brand, danger, 5 more }

background: object {"1000", "600", "700", 2 more }

"1000": string Link to this property "600": string Link to this property "700": string Link to this property "800": string Link to this property "900": string Link to this property

Link to this property

brand: object {"300", "400", "500", 2 more }

"300": string Link to this property "400": string Link to this property "500": string Link to this property "600": string Link to this property "700": 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 text\_on\_brand: string Link to this property video\_bg: string Link to this property warning: string Link to this property

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

theme: "darkest"or "dark"or "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 string Link to this property google\_font: optional string Link to this property logo: optional string formaturi Link to this property

Link to this property

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

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

[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_replace_preset_by_id_response%20%3E%20(schema)>) #### Realtime KitSessions ##### [Fetch all sessions of an App](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/sessions/methods/get_sessions) GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions ##### [Fetch details of a session](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/sessions/methods/get_session_details) GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id} ##### [Fetch participants list of a session](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/sessions/methods/get_session_participants) GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/participants ##### [Fetch details of a participant](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/sessions/methods/get_session_participant_details) GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/participants/{participant\_id} ##### [Fetch all chat messages of a session](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/sessions/methods/get_session_chat) GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/chat ##### [Fetch the complete transcript for a session](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/sessions/methods/get_session_transcripts) GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/transcript ##### [Fetch summary of transcripts for a session](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/sessions/methods/get_session_summary) GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/summary ##### [Generate summary of Transcripts for the session](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/sessions/methods/generate_summary_of_transcripts) POST/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/summary ##### [Fetch details of peer](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/sessions/methods/get_participant_data_from_peer_id) GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/peer-report/{peer\_id} ##### ModelsExpand Collapse

SessionGetSessionsResponse object {data, paging, success }

data: optional object {sessions }

sessions: optional array of object {id, associated\_id, created\_at, 11 more }

id: string ID of the session Link to this property associated\_id: string ID of the meeting this session is associated with. In the case of V2 meetings, it is always a UUID. In V1 meetings, it is a room name of the form abcdef-ghijkl Link to this property created\_at: string timestamp when session created Link to this property live\_participants: number number of participants currently in the session Link to this property max\_concurrent\_participants: number number of maximum participants that were in the session Link to this property meeting\_display\_name: string Title of the meeting this session belongs to Link to this property minutes\_consumed: number number of minutes consumed since the session started Link to this property organization\_id: string App id that hosted this session Link to this property started\_at: string timestamp when session started Link to this property

status: "LIVE"or "ENDED" current status of session

One of the following: "LIVE" Link to this property "ENDED" Link to this property

Link to this property

type: "meeting"or "livestream"or "participant" type of session

One of the following: "meeting" Link to this property "livestream" Link to this property "participant" Link to this property

Link to this property updated\_at: string timestamp when session was last updated Link to this property breakout\_rooms: optional array of unknown Link to this property ended\_at: optional string timestamp when session ended Link to this property

Link to this property

Link to this property

paging: optional object {end\_offset, start\_offset, total\_count }

end\_offset: optional number Link to this property start\_offset: optional number Link to this property total\_count: optional number minimum0 Link to this property

Link to this property success: optional boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_sessions_response%20%3E%20(schema)>)

SessionGetSessionDetailsResponse object {data, success }

data: optional object {id, associated\_id, created\_at, 11 more }

id: string ID of the session Link to this property associated\_id: string ID of the meeting this session is associated with. In the case of V2 meetings, it is always a UUID. In V1 meetings, it is a room name of the form abcdef-ghijkl Link to this property created\_at: string timestamp when session created Link to this property live\_participants: number number of participants currently in the session Link to this property max\_concurrent\_participants: number number of maximum participants that were in the session Link to this property meeting\_display\_name: string Title of the meeting this session belongs to Link to this property minutes\_consumed: number number of minutes consumed since the session started Link to this property organization\_id: string App id that hosted this session Link to this property started\_at: string timestamp when session started Link to this property

status: "LIVE"or "ENDED" current status of session

One of the following: "LIVE" Link to this property "ENDED" Link to this property

Link to this property

type: "meeting"or "livestream"or "participant" type of session

One of the following: "meeting" Link to this property "livestream" Link to this property "participant" Link to this property

Link to this property updated\_at: string timestamp when session was last updated Link to this property breakout\_rooms: optional array of unknown Link to this property ended\_at: optional string timestamp when session ended Link to this property

Link to this property success: optional boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_session_details_response%20%3E%20(schema)>)

SessionGetSessionParticipantsResponse object {data, success }

data: optional object {participants }

participants: optional array of object {id, created\_at, custom\_participant\_id, 8 more }

id: optional string Participant ID. This maps to the corresponding peerId. Link to this property created\_at: optional string timestamp when this participant was created. Link to this property custom\_participant\_id: optional string ID passed by client to create this participant. Link to this property display\_name: optional string Display name of participant when joining the session. Link to this property duration: optional number number of minutes for which the participant was in the session. Link to this property joined\_at: optional string timestamp at which participant joined the session. Link to this property left\_at: optional string timestamp at which participant left the session. Link to this property

peer\_events: optional array of object {id, created\_at, event\_name, 7 more } Connection lifecycle events for the participant’s peer. Only included when include_peer_events is true.

id: optional string ID of the peer event. Link to this property created\_at: optional string Timestamp when this peer event was created. Link to this property

event\_name: optional "PEER\_CREATED"or "PEER\_JOINING"or "PEER\_LEAVING" Name of the peer event.

One of the following: "PEER\_CREATED" Link to this property "PEER\_JOINING" Link to this property "PEER\_LEAVING" Link to this property

Link to this property minutes\_consumed: optional number Minutes consumed attributed to this event. Link to this property participant\_id: optional string ID of the participant this event belongs to. Link to this property peer\_id: optional string Peer ID this event belongs to. Link to this property

preset\_view\_type: optional "GROUP\_CALL"or "WEBINAR"or "AUDIO\_ROOM"or 2 more View type of the preset associated with the peer.

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 "CHAT" Link to this property

Link to this property session\_id: optional string ID of the session this event belongs to. Link to this property socket\_session\_id: optional string ID of the socket session associated with this event. Link to this property updated\_at: optional string Timestamp when this peer event was last updated. Link to this property

Link to this property preset\_name: optional string Name of the preset associated with the participant. Link to this property updated\_at: optional string timestamp when this participant’s data was last updated. Link to this property user\_id: optional string User id for this participant. Link to this property

Link to this property

Link to this property success: optional boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_session_participants_response%20%3E%20(schema)>)

SessionGetSessionParticipantDetailsResponse object {data, success }

data: optional object {participant }

participant: optional object {id, created\_at, custom\_participant\_id, 8 more }

id: optional string Participant ID. This maps to the corresponding peerId. Link to this property created\_at: optional string timestamp when this participant was created. Link to this property custom\_participant\_id: optional string ID passed by client to create this participant. Link to this property display\_name: optional string Display name of participant when joining the session. Link to this property duration: optional number number of minutes for which the participant was in the session. Link to this property joined\_at: optional string timestamp at which participant joined the session. Link to this property left\_at: optional string timestamp at which participant left the session. Link to this property

peer\_events: optional array of object {id, created\_at, event\_name, 7 more } Connection lifecycle events for the participant’s peer. Only included when include_peer_events is true.

id: optional string ID of the peer event. Link to this property created\_at: optional string Timestamp when this peer event was created. Link to this property

event\_name: optional "PEER\_CREATED"or "PEER\_JOINING"or "PEER\_LEAVING" Name of the peer event.

One of the following: "PEER\_CREATED" Link to this property "PEER\_JOINING" Link to this property "PEER\_LEAVING" Link to this property

Link to this property minutes\_consumed: optional number Minutes consumed attributed to this event. Link to this property participant\_id: optional string ID of the participant this event belongs to. Link to this property peer\_id: optional string Peer ID this event belongs to. Link to this property

preset\_view\_type: optional "GROUP\_CALL"or "WEBINAR"or "AUDIO\_ROOM"or 2 more View type of the preset associated with the peer.

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 "CHAT" Link to this property

Link to this property session\_id: optional string ID of the session this event belongs to. Link to this property socket\_session\_id: optional string ID of the socket session associated with this event. Link to this property updated\_at: optional string Timestamp when this peer event was last updated. Link to this property

Link to this property preset\_name: optional string Name of the preset associated with the participant. Link to this property updated\_at: optional string timestamp when this participant’s data was last updated. Link to this property user\_id: optional string User id for this participant. Link to this property

Link to this property

Link to this property success: optional boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_session_participant_details_response%20%3E%20(schema)>)

SessionGetSessionChatResponse object {data, success }

data: optional object {chat\_download\_url, chat\_download\_url\_expiry }

chat\_download\_url: string URL where the chat logs can be downloaded Link to this property chat\_download\_url\_expiry: string Time when the download URL will expire Link to this property

Link to this property success: optional boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_session_chat_response%20%3E%20(schema)>)

SessionGetSessionTranscriptsResponse object {data, success }

data: optional object {sessionId, transcript\_download\_url, transcript\_download\_url\_expiry }

sessionId: string Link to this property transcript\_download\_url: string URL where the transcript can be downloaded Link to this property transcript\_download\_url\_expiry: string Time when the download URL will expire Link to this property

Link to this property success: optional boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_session_transcripts_response%20%3E%20(schema)>)

SessionGetSessionSummaryResponse object {data, success }

data: optional object {sessionId, summaryDownloadUrl, summaryDownloadUrlExpiry }

sessionId: string Link to this property summaryDownloadUrl: string URL where the summary of transcripts can be downloaded Link to this property summaryDownloadUrlExpiry: string Time of Expiry before when you need to download the csv file. Link to this property

Link to this property success: optional boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_session_summary_response%20%3E%20(schema)>)

SessionGenerateSummaryOfTranscriptsResponse object {data, success }

data: optional object {session\_id, status }

session\_id: optional string formatuuid Link to this property status: optional string Link to this property

Link to this property success: optional boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_generate_summary_of_transcripts_response%20%3E%20(schema)>)

SessionGetParticipantDataFromPeerIDResponse object {data, success }

data: optional object {participant }

participant: optional object {id, created\_at, custom\_participant\_id, 10 more }

id: optional string ID of the participant. formatuuid Link to this property created\_at: optional string timestamp when this participant was created. Link to this property custom\_participant\_id: optional string ID passed by client to create this participant. Link to this property display\_name: optional string Display name of participant when joining the session. Link to this property duration: optional number number of minutes for which the participant was in the session. Link to this property joined\_at: optional string timestamp at which participant joined the session. Link to this property left\_at: optional string timestamp at which participant left the session. Link to this property

peer\_events: optional array of object {id, created\_at, event\_name, 7 more } Connection lifecycle events for the participant’s peer.

id: optional string ID of the peer event. Link to this property created\_at: optional string Timestamp when this peer event was created. Link to this property

event\_name: optional "PEER\_CREATED"or "PEER\_JOINING"or "PEER\_LEAVING" Name of the peer event.

One of the following: "PEER\_CREATED" Link to this property "PEER\_JOINING" Link to this property "PEER\_LEAVING" Link to this property

Link to this property minutes\_consumed: optional number Minutes consumed attributed to this event. Link to this property participant\_id: optional string ID of the participant this event belongs to. Link to this property peer\_id: optional string Peer ID this event belongs to. Link to this property

preset\_view\_type: optional "GROUP\_CALL"or "WEBINAR"or "AUDIO\_ROOM"or 2 more View type of the preset associated with the peer.

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 "CHAT" Link to this property

Link to this property session\_id: optional string ID of the session this event belongs to. Link to this property socket\_session\_id: optional string ID of the socket session associated with this event. Link to this property updated\_at: optional string Timestamp when this peer event was last updated. Link to this property

Link to this property

peer\_report: optional object {metadata, quality } Peer call statistics report.

metadata: optional object {audio\_devices\_updates, browser\_metadata, candidate\_pairs, 12 more } Connection and device metadata for the participant.

audio\_devices\_updates: optional array of object {added, removed, timestamp }

added: optional array of object {device\_id, kind, label } Devices that became available.

device\_id: optional string ID of the device. Link to this property kind: optional string Kind of device, for example audioinput or videoinput. Link to this property label: optional string Human-readable label of the device. Link to this property

Link to this property

removed: optional array of object {device\_id, kind, label } Devices that became unavailable.

device\_id: optional string ID of the device. Link to this property kind: optional string Kind of device, for example audioinput or videoinput. Link to this property label: optional string Human-readable label of the device. Link to this property

Link to this property timestamp: optional string Timestamp of the device update. Link to this property

Link to this property

browser\_metadata: optional object {browser, browser\_version, engine, 2 more }

browser: optional string Link to this property browser\_version: optional string Link to this property engine: optional string Link to this property user\_agent: optional string Link to this property webgl\_support: optional boolean Link to this property

Link to this property

candidate\_pairs: optional object {consuming\_transport, producing\_transport }

consuming\_transport: optional array of object {available\_incoming\_bitrate, available\_outgoing\_bitrate, bytes\_discarded\_on\_send, 25 more }

available\_incoming\_bitrate: optional number Link to this property available\_outgoing\_bitrate: optional number Link to this property bytes\_discarded\_on\_send: optional number Link to this property bytes\_received: optional number Link to this property bytes\_sent: optional number Link to this property current\_round\_trip\_time: optional number Link to this property last\_packet\_received\_timestamp: optional number Epoch milliseconds when the last packet was received. Link to this property last\_packet\_sent\_timestamp: optional number Epoch milliseconds when the last packet was sent. Link to this property local\_candidate\_address: optional string Link to this property local\_candidate\_id: optional string Link to this property local\_candidate\_network\_type: optional string Link to this property local\_candidate\_port: optional number Link to this property local\_candidate\_protocol: optional string Link to this property local\_candidate\_related\_address: optional string Link to this property local\_candidate\_related\_port: optional number Link to this property local\_candidate\_type: optional string Link to this property local\_candidate\_url: optional string Link to this property nominated: optional boolean Link to this property packets\_discarded\_on\_send: optional number Link to this property packets\_received: optional number Link to this property packets\_sent: optional number Link to this property remote\_candidate\_address: optional string Link to this property remote\_candidate\_id: optional string Link to this property remote\_candidate\_port: optional number Link to this property remote\_candidate\_protocol: optional string Link to this property remote\_candidate\_type: optional string Link to this property remote\_candidate\_url: optional string Link to this property total\_round\_trip\_time: optional number Link to this property

Link to this property

producing\_transport: optional array of object {available\_incoming\_bitrate, available\_outgoing\_bitrate, bytes\_discarded\_on\_send, 25 more }

available\_incoming\_bitrate: optional number Link to this property available\_outgoing\_bitrate: optional number Link to this property bytes\_discarded\_on\_send: optional number Link to this property bytes\_received: optional number Link to this property bytes\_sent: optional number Link to this property current\_round\_trip\_time: optional number Link to this property last\_packet\_received\_timestamp: optional number Epoch milliseconds when the last packet was received. Link to this property last\_packet\_sent\_timestamp: optional number Epoch milliseconds when the last packet was sent. Link to this property local\_candidate\_address: optional string Link to this property local\_candidate\_id: optional string Link to this property local\_candidate\_network\_type: optional string Link to this property local\_candidate\_port: optional number Link to this property local\_candidate\_protocol: optional string Link to this property local\_candidate\_related\_address: optional string Link to this property local\_candidate\_related\_port: optional number Link to this property local\_candidate\_type: optional string Link to this property local\_candidate\_url: optional string Link to this property nominated: optional boolean Link to this property packets\_discarded\_on\_send: optional number Link to this property packets\_received: optional number Link to this property packets\_sent: optional number Link to this property remote\_candidate\_address: optional string Link to this property remote\_candidate\_id: optional string Link to this property remote\_candidate\_port: optional number Link to this property remote\_candidate\_protocol: optional string Link to this property remote\_candidate\_type: optional string Link to this property remote\_candidate\_url: optional string Link to this property total\_round\_trip\_time: optional number Link to this property

Link to this property

Link to this property

device\_info: optional object {cpus, is\_mobile, os, os\_version }

cpus: optional number Link to this property is\_mobile: optional boolean Link to this property os: optional string Link to this property os\_version: optional string Link to this property

Link to this property

events: optional array of object {metadata, name, timestamp }

metadata: optional map\[stringor numberor boolean] Event-specific metadata. Keys vary per event; values are primitive scalars (string, number, boolean, or null).

One of the following: string Link to this property number Link to this property boolean Link to this property

Link to this property name: optional string Name of the event. Link to this property timestamp: optional string Timestamp when the event occurred. Link to this property

Link to this property

ip\_information: optional object {asn, city, country, 4 more }

asn: optional object {asn, domain, name, 2 more }

asn: optional string Link to this property domain: optional string Link to this property name: optional string Link to this property route: optional string Link to this property type: optional string Link to this property

Link to this property city: optional string Link to this property country: optional string Link to this property ipv4: optional string Link to this property org: optional string Link to this property region: optional string Link to this property timezone: optional string Link to this property

Link to this property

native\_metadata: optional object {audio\_encoder, video\_encoder }

audio\_encoder: optional string Link to this property video\_encoder: optional string Link to this property

Link to this property

pc\_metadata: optional array of object {effective\_network\_type, reflexive\_connectivity, relay\_connectivity, 3 more }

effective\_network\_type: optional string Link to this property reflexive\_connectivity: optional boolean Link to this property relay\_connectivity: optional boolean Link to this property sdp: optional array of string Link to this property timestamp: optional string Link to this property turn\_connectivity: optional boolean Link to this property

Link to this property room\_view\_type: optional string Link to this property sdk\_name: optional string Link to this property sdk\_type: optional string Link to this property sdk\_version: optional string Link to this property

selected\_device\_updates: optional array of object {device, timestamp }

device: optional object {device\_id, kind, label } A media device (camera, microphone, or speaker).

device\_id: optional string ID of the device. Link to this property kind: optional string Kind of device, for example audioinput or videoinput. Link to this property label: optional string Human-readable label of the device. Link to this property

Link to this property timestamp: optional string Link to this property

Link to this property

speaker\_devices\_updates: optional array of object {added, removed, timestamp }

added: optional array of object {device\_id, kind, label } Devices that became available.

device\_id: optional string ID of the device. Link to this property kind: optional string Kind of device, for example audioinput or videoinput. Link to this property label: optional string Human-readable label of the device. Link to this property

Link to this property

removed: optional array of object {device\_id, kind, label } Devices that became unavailable.

device\_id: optional string ID of the device. Link to this property kind: optional string Kind of device, for example audioinput or videoinput. Link to this property label: optional string Human-readable label of the device. Link to this property

Link to this property timestamp: optional string Timestamp of the device update. Link to this property

Link to this property

video\_devices\_updates: optional array of object {added, removed, timestamp }

added: optional array of object {device\_id, kind, label } Devices that became available.

device\_id: optional string ID of the device. Link to this property kind: optional string Kind of device, for example audioinput or videoinput. Link to this property label: optional string Human-readable label of the device. Link to this property

Link to this property

removed: optional array of object {device\_id, kind, label } Devices that became unavailable.

device\_id: optional string ID of the device. Link to this property kind: optional string Kind of device, for example audioinput or videoinput. Link to this property label: optional string Human-readable label of the device. Link to this property

Link to this property timestamp: optional string Timestamp of the device update. Link to this property

Link to this property

Link to this property

quality: optional object {audio\_consumer, audio\_consumer\_cumulative, audio\_producer, 13 more } Media quality statistics for the participant.

audio\_consumer: optional array of object {bytes\_received, concealment\_events, consumer\_id, 11 more }

bytes\_received: optional number Link to this property concealment\_events: optional number Link to this property consumer\_id: optional string Link to this property jitter: optional number Link to this property jitter\_buffer\_delay: optional number Link to this property jitter\_buffer\_emitted\_count: optional number Link to this property mid: optional string Link to this property mos\_quality: optional number Link to this property packets\_lost: optional number Link to this property packets\_received: optional number Link to this property peer\_id: optional string Link to this property producer\_id: optional string Link to this property ssrc: optional number Link to this property timestamp: optional string Link to this property

Link to this property

audio\_consumer\_cumulative: optional object {jitter\_buffer\_delay, packet\_loss, quality\_mos } Aggregated inbound (consumer) audio statistics for the session.

jitter\_buffer\_delay: optional object {"100ms\_or\_greater\_event\_fraction", "250ms\_or\_greater\_event\_fraction", "500ms\_or\_greater\_event\_fraction", avg } Cumulative latency distribution (milliseconds-based thresholds).

"100ms\_or\_greater\_event\_fraction": optional number Link to this property "250ms\_or\_greater\_event\_fraction": optional number Link to this property "500ms\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

packet\_loss: optional object {"10\_or\_greater\_event\_fraction", "25\_or\_greater\_event\_fraction", "5\_or\_greater\_event\_fraction", 2 more } Cumulative packet loss distribution.

"10\_or\_greater\_event\_fraction": optional number Link to this property "25\_or\_greater\_event\_fraction": optional number Link to this property "5\_or\_greater\_event\_fraction": optional number Link to this property "50\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

quality\_mos: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

Link to this property

audio\_producer: optional array of object {bytes\_sent, jitter, mid, 7 more }

bytes\_sent: optional number Link to this property jitter: optional number Link to this property mid: optional string Link to this property mos\_quality: optional number Link to this property packets\_lost: optional number Link to this property packets\_sent: optional number Link to this property producer\_id: optional string Link to this property rtt: optional number Link to this property ssrc: optional number Link to this property timestamp: optional string Link to this property

Link to this property

audio\_producer\_cumulative: optional object {packet\_loss, quality\_mos, rtt } Aggregated outbound (producer) audio statistics for the session.

packet\_loss: optional object {"10\_or\_greater\_event\_fraction", "25\_or\_greater\_event\_fraction", "5\_or\_greater\_event\_fraction", 2 more } Cumulative packet loss distribution.

"10\_or\_greater\_event\_fraction": optional number Link to this property "25\_or\_greater\_event\_fraction": optional number Link to this property "5\_or\_greater\_event\_fraction": optional number Link to this property "50\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

quality\_mos: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

rtt: optional object {"100ms\_or\_greater\_event\_fraction", "250ms\_or\_greater\_event\_fraction", "500ms\_or\_greater\_event\_fraction", avg } Cumulative latency distribution (milliseconds-based thresholds).

"100ms\_or\_greater\_event\_fraction": optional number Link to this property "250ms\_or\_greater\_event\_fraction": optional number Link to this property "500ms\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

Link to this property

screenshare\_audio\_consumer: optional array of object {bytes\_received, concealment\_events, consumer\_id, 11 more }

bytes\_received: optional number Link to this property concealment\_events: optional number Link to this property consumer\_id: optional string Link to this property jitter: optional number Link to this property jitter\_buffer\_delay: optional number Link to this property jitter\_buffer\_emitted\_count: optional number Link to this property mid: optional string Link to this property mos\_quality: optional number Link to this property packets\_lost: optional number Link to this property packets\_received: optional number Link to this property peer\_id: optional string Link to this property producer\_id: optional string Link to this property ssrc: optional number Link to this property timestamp: optional string Link to this property

Link to this property

screenshare\_audio\_consumer\_cumulative: optional object {jitter\_buffer\_delay, packet\_loss, quality\_mos } Aggregated inbound (consumer) audio statistics for the session.

jitter\_buffer\_delay: optional object {"100ms\_or\_greater\_event\_fraction", "250ms\_or\_greater\_event\_fraction", "500ms\_or\_greater\_event\_fraction", avg } Cumulative latency distribution (milliseconds-based thresholds).

"100ms\_or\_greater\_event\_fraction": optional number Link to this property "250ms\_or\_greater\_event\_fraction": optional number Link to this property "500ms\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

packet\_loss: optional object {"10\_or\_greater\_event\_fraction", "25\_or\_greater\_event\_fraction", "5\_or\_greater\_event\_fraction", 2 more } Cumulative packet loss distribution.

"10\_or\_greater\_event\_fraction": optional number Link to this property "25\_or\_greater\_event\_fraction": optional number Link to this property "5\_or\_greater\_event\_fraction": optional number Link to this property "50\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

quality\_mos: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

Link to this property

screenshare\_audio\_producer: optional array of object {bytes\_sent, jitter, mid, 7 more }

bytes\_sent: optional number Link to this property jitter: optional number Link to this property mid: optional string Link to this property mos\_quality: optional number Link to this property packets\_lost: optional number Link to this property packets\_sent: optional number Link to this property producer\_id: optional string Link to this property rtt: optional number Link to this property ssrc: optional number Link to this property timestamp: optional string Link to this property

Link to this property

screenshare\_audio\_producer\_cumulative: optional object {packet\_loss, quality\_mos, rtt } Aggregated outbound (producer) audio statistics for the session.

packet\_loss: optional object {"10\_or\_greater\_event\_fraction", "25\_or\_greater\_event\_fraction", "5\_or\_greater\_event\_fraction", 2 more } Cumulative packet loss distribution.

"10\_or\_greater\_event\_fraction": optional number Link to this property "25\_or\_greater\_event\_fraction": optional number Link to this property "5\_or\_greater\_event\_fraction": optional number Link to this property "50\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

quality\_mos: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

rtt: optional object {"100ms\_or\_greater\_event\_fraction", "250ms\_or\_greater\_event\_fraction", "500ms\_or\_greater\_event\_fraction", avg } Cumulative latency distribution (milliseconds-based thresholds).

"100ms\_or\_greater\_event\_fraction": optional number Link to this property "250ms\_or\_greater\_event\_fraction": optional number Link to this property "500ms\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

Link to this property

screenshare\_video\_consumer: optional array of object {bytes\_received, consumer\_id, fir\_count, 17 more }

bytes\_received: optional number Link to this property consumer\_id: optional string Link to this property fir\_count: optional number Link to this property frame\_height: optional number Link to this property frame\_width: optional number Link to this property frames\_decoded: optional number Link to this property frames\_dropped: optional number Link to this property frames\_per\_second: optional number Link to this property jitter: optional number Link to this property jitter\_buffer\_delay: optional number Link to this property jitter\_buffer\_emitted\_count: optional number Link to this property key\_frames\_decoded: optional number Link to this property mid: optional string Link to this property mos\_quality: optional number Link to this property packets\_lost: optional number Link to this property packets\_received: optional number Link to this property peer\_id: optional string Link to this property producer\_id: optional string Link to this property ssrc: optional number Link to this property timestamp: optional string Link to this property

Link to this property

screenshare\_video\_consumer\_cumulative: optional object {frame\_per\_second, frame\_width, issues, 4 more } Aggregated inbound (consumer) video statistics for the session.

frame\_per\_second: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

frame\_width: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

issues: optional object {lag\_fraction, no\_video\_fraction, poor\_resolution\_fraction }

lag\_fraction: optional number Link to this property no\_video\_fraction: optional number Link to this property poor\_resolution\_fraction: optional number Link to this property

Link to this property

jitter\_buffer\_delay: optional object {"100ms\_or\_greater\_event\_fraction", "250ms\_or\_greater\_event\_fraction", "500ms\_or\_greater\_event\_fraction", avg } Cumulative latency distribution (milliseconds-based thresholds).

"100ms\_or\_greater\_event\_fraction": optional number Link to this property "250ms\_or\_greater\_event\_fraction": optional number Link to this property "500ms\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property key\_frames\_decoded\_fraction: optional number Link to this property

packet\_loss: optional object {"10\_or\_greater\_event\_fraction", "25\_or\_greater\_event\_fraction", "5\_or\_greater\_event\_fraction", 2 more } Cumulative packet loss distribution.

"10\_or\_greater\_event\_fraction": optional number Link to this property "25\_or\_greater\_event\_fraction": optional number Link to this property "5\_or\_greater\_event\_fraction": optional number Link to this property "50\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

quality\_mos: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

Link to this property

screenshare\_video\_producer: optional array of object {bytes\_sent, fir\_count, frame\_height, 17 more }

bytes\_sent: optional number Link to this property fir\_count: optional number Link to this property frame\_height: optional number Link to this property frame\_width: optional number Link to this property frames\_encoded: optional number Link to this property frames\_per\_second: optional number Link to this property jitter: optional number Link to this property key\_frames\_encoded: optional number Link to this property mid: optional string Link to this property mos\_quality: optional number Link to this property packets\_lost: optional number Link to this property packets\_sent: optional number Link to this property pli\_count: optional number Link to this property producer\_id: optional string Link to this property

quality\_limitation\_durations: optional object {bandwidth, cpu, none, other }

bandwidth: optional number Link to this property cpu: optional number Link to this property none: optional number Link to this property other: optional number Link to this property

Link to this property

quality\_limitation\_reason: optional "cpu"or "bandwidth"or "none"or "other"

One of the following: "cpu" Link to this property "bandwidth" Link to this property "none" Link to this property "other" Link to this property

Link to this property quality\_limitation\_resolution\_changes: optional number Link to this property rtt: optional number Link to this property ssrc: optional number Link to this property timestamp: optional string Link to this property

Link to this property

screenshare\_video\_producer\_cumulative: optional object {frame\_per\_second, frame\_width, high\_negative\_feedback\_fraction, 5 more } Aggregated outbound (producer) video statistics for the session.

frame\_per\_second: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

frame\_width: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property high\_negative\_feedback\_fraction: optional number Link to this property

issues: optional object {bandwidth\_quality\_limitation\_fraction, cpu\_quality\_limitation\_fraction, no\_video\_fraction, 2 more }

bandwidth\_quality\_limitation\_fraction: optional number Link to this property cpu\_quality\_limitation\_fraction: optional number Link to this property no\_video\_fraction: optional number Link to this property poor\_resolution\_fraction: optional number Link to this property quality\_limitation\_fraction: optional number Link to this property

Link to this property key\_frames\_encoded\_fraction: optional number Link to this property

packet\_loss: optional object {"10\_or\_greater\_event\_fraction", "25\_or\_greater\_event\_fraction", "5\_or\_greater\_event\_fraction", 2 more } Cumulative packet loss distribution.

"10\_or\_greater\_event\_fraction": optional number Link to this property "25\_or\_greater\_event\_fraction": optional number Link to this property "5\_or\_greater\_event\_fraction": optional number Link to this property "50\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

quality\_mos: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

rtt: optional object {"100ms\_or\_greater\_event\_fraction", "250ms\_or\_greater\_event\_fraction", "500ms\_or\_greater\_event\_fraction", avg } Cumulative latency distribution (milliseconds-based thresholds).

"100ms\_or\_greater\_event\_fraction": optional number Link to this property "250ms\_or\_greater\_event\_fraction": optional number Link to this property "500ms\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

Link to this property

video\_consumer: optional array of object {bytes\_received, consumer\_id, fir\_count, 17 more }

bytes\_received: optional number Link to this property consumer\_id: optional string Link to this property fir\_count: optional number Link to this property frame\_height: optional number Link to this property frame\_width: optional number Link to this property frames\_decoded: optional number Link to this property frames\_dropped: optional number Link to this property frames\_per\_second: optional number Link to this property jitter: optional number Link to this property jitter\_buffer\_delay: optional number Link to this property jitter\_buffer\_emitted\_count: optional number Link to this property key\_frames\_decoded: optional number Link to this property mid: optional string Link to this property mos\_quality: optional number Link to this property packets\_lost: optional number Link to this property packets\_received: optional number Link to this property peer\_id: optional string Link to this property producer\_id: optional string Link to this property ssrc: optional number Link to this property timestamp: optional string Link to this property

Link to this property

video\_consumer\_cumulative: optional object {frame\_per\_second, frame\_width, issues, 4 more } Aggregated inbound (consumer) video statistics for the session.

frame\_per\_second: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

frame\_width: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

issues: optional object {lag\_fraction, no\_video\_fraction, poor\_resolution\_fraction }

lag\_fraction: optional number Link to this property no\_video\_fraction: optional number Link to this property poor\_resolution\_fraction: optional number Link to this property

Link to this property

jitter\_buffer\_delay: optional object {"100ms\_or\_greater\_event\_fraction", "250ms\_or\_greater\_event\_fraction", "500ms\_or\_greater\_event\_fraction", avg } Cumulative latency distribution (milliseconds-based thresholds).

"100ms\_or\_greater\_event\_fraction": optional number Link to this property "250ms\_or\_greater\_event\_fraction": optional number Link to this property "500ms\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property key\_frames\_decoded\_fraction: optional number Link to this property

packet\_loss: optional object {"10\_or\_greater\_event\_fraction", "25\_or\_greater\_event\_fraction", "5\_or\_greater\_event\_fraction", 2 more } Cumulative packet loss distribution.

"10\_or\_greater\_event\_fraction": optional number Link to this property "25\_or\_greater\_event\_fraction": optional number Link to this property "5\_or\_greater\_event\_fraction": optional number Link to this property "50\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

quality\_mos: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

Link to this property

video\_producer: optional array of object {bytes\_sent, fir\_count, frame\_height, 17 more }

bytes\_sent: optional number Link to this property fir\_count: optional number Link to this property frame\_height: optional number Link to this property frame\_width: optional number Link to this property frames\_encoded: optional number Link to this property frames\_per\_second: optional number Link to this property jitter: optional number Link to this property key\_frames\_encoded: optional number Link to this property mid: optional string Link to this property mos\_quality: optional number Link to this property packets\_lost: optional number Link to this property packets\_sent: optional number Link to this property pli\_count: optional number Link to this property producer\_id: optional string Link to this property

quality\_limitation\_durations: optional object {bandwidth, cpu, none, other }

bandwidth: optional number Link to this property cpu: optional number Link to this property none: optional number Link to this property other: optional number Link to this property

Link to this property

quality\_limitation\_reason: optional "cpu"or "bandwidth"or "none"or "other"

One of the following: "cpu" Link to this property "bandwidth" Link to this property "none" Link to this property "other" Link to this property

Link to this property quality\_limitation\_resolution\_changes: optional number Link to this property rtt: optional number Link to this property ssrc: optional number Link to this property timestamp: optional string Link to this property

Link to this property

video\_producer\_cumulative: optional object {frame\_per\_second, frame\_width, high\_negative\_feedback\_fraction, 5 more } Aggregated outbound (producer) video statistics for the session.

frame\_per\_second: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

frame\_width: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property high\_negative\_feedback\_fraction: optional number Link to this property

issues: optional object {bandwidth\_quality\_limitation\_fraction, cpu\_quality\_limitation\_fraction, no\_video\_fraction, 2 more }

bandwidth\_quality\_limitation\_fraction: optional number Link to this property cpu\_quality\_limitation\_fraction: optional number Link to this property no\_video\_fraction: optional number Link to this property poor\_resolution\_fraction: optional number Link to this property quality\_limitation\_fraction: optional number Link to this property

Link to this property key\_frames\_encoded\_fraction: optional number Link to this property

packet\_loss: optional object {"10\_or\_greater\_event\_fraction", "25\_or\_greater\_event\_fraction", "5\_or\_greater\_event\_fraction", 2 more } Cumulative packet loss distribution.

"10\_or\_greater\_event\_fraction": optional number Link to this property "25\_or\_greater\_event\_fraction": optional number Link to this property "5\_or\_greater\_event\_fraction": optional number Link to this property "50\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

quality\_mos: optional object {avg, p50, p75, p90 } Distribution summary with average and percentiles.

avg: optional number Link to this property p50: optional number Link to this property p75: optional number Link to this property p90: optional number Link to this property

Link to this property

rtt: optional object {"100ms\_or\_greater\_event\_fraction", "250ms\_or\_greater\_event\_fraction", "500ms\_or\_greater\_event\_fraction", avg } Cumulative latency distribution (milliseconds-based thresholds).

"100ms\_or\_greater\_event\_fraction": optional number Link to this property "250ms\_or\_greater\_event\_fraction": optional number Link to this property "500ms\_or\_greater\_event\_fraction": optional number Link to this property avg: optional number Link to this property

Link to this property

Link to this property

Link to this property

Link to this property role: optional string Name of the preset associated with the participant. Link to this property session\_id: optional string formatuuid Link to this property updated\_at: optional string timestamp when this participant’s data was last updated. Link to this property user\_id: optional string User id for this participant. Link to this property

Link to this property

Link to this property success: optional boolean Link to this property

[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_participant_data_from_peer_id_response%20%3E%20(schema)>) #### Realtime KitRecordings ##### [Fetch all recordings for an App](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/recordings/methods/get_recordings) GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings ##### [Start recording a meeting](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/recordings/methods/start_recordings) POST/accounts/{account\_id}/realtime/kit/{app\_id}/recordings ##### [Fetch active recording](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/recordings/methods/get_active_recordings) GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/active-recording/{meeting\_id} ##### [Fetch details of a recording](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/recordings/methods/get_one_recording) GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/{recording\_id} ##### [Pause/Resume/Stop recording](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/recordings/methods/pause_resume_stop_recording) PUT/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/{recording\_id} ##### [Start recording participant audio tracks](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/recordings/methods/start_track_recording) POST/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/track ##### ModelsExpand Collapse

RecordingGetRecordingsResponse object {data, paging, success }

data: array of object {id, audio\_download\_url, download\_url, 11 more }

id: string ID of the recording formatuuid Link to this property audio\_download\_url: string If the audio\_config is passed, the URL for downloading the audio recording is returned. formaturi Link to this property download\_url: string URL where the recording can be downloaded. formaturi Link to this property download\_url\_expiry: string Timestamp when the download URL expires. formatdate-time Link to this property file\_size: number File size of the recording, in bytes. Link to this property invoked\_time: string Timestamp when this recording was invoked. formatdate-time Link to this property output\_file\_name: string File name of the recording. Link to this property session\_id: string ID of the meeting session this recording is for. formatuuid Link to this property started\_time: string Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time. formatdate-time Link to this property

status: "INVOKED"or "RECORDING"or "UPLOADING"or 3 more Current status of the recording.

One of the following: "INVOKED" Link to this property "RECORDING" Link to this property "UPLOADING" Link to this property "UPLOADED" Link to this property "ERRORED" Link to this property "PAUSED" Link to this property

Link to this property stopped\_time: string Timestamp when this recording was stopped. Optional; is present only when the recording has actually been stopped. formatdate-time Link to this property

meeting: optional object {id, created\_at, updated\_at, 9 more }

id: string ID of the meeting. formatuuid Link to this property created\_at: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property live\_stream\_on\_start: optional boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat: optional boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start: optional boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property

recording\_config: optional object {audio\_config, file\_name\_prefix, live\_streaming\_config, 4 more } Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.

audio\_config: optional object {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.

channel: optional "mono"or "stereo" Audio signal pathway within an audio file that carries a specific sound source.

One of the following: "mono" Link to this property "stereo" Link to this property

Link to this property

codec: optional "MP3"or "AAC" Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

One of the following: "MP3" Link to this property "AAC" Link to this property

Link to this property export\_file: optional boolean Controls whether to export audio file seperately Link to this property

Link to this property file\_name\_prefix: optional string Adds a prefix to the beginning of the file name of the recording. Link to this property

live\_streaming\_config: optional object {rtmp\_url }

rtmp\_url: optional string RTMP URL to stream to formaturi Link to this property

Link to this property max\_seconds: optional number Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property

realtimekit\_bucket\_config: optional object {enabled }

enabled: boolean Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property

Link to this property

storage\_config: optional object {access\_key, auth\_method, bucket, 9 more } or object {access\_key, region, auth\_method, 9 more } or object {private\_key, access\_key, auth\_method, 9 more } or object {password, access\_key, auth\_method, 9 more }

One of the following:

object {access\_key, auth\_method, bucket, 9 more }

access\_key: optional string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property

auth\_method: optional "KEY"or "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: optional string Path relative to the bucket root at which the recording will be placed. Link to this property port: optional number SSH destination server port for SFTP type storage medium Link to this property private\_key: optional string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: optional string Region of the storage medium. Link to this property secret: optional string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: optional "gcs" Link to this property username: optional string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

object {access\_key, region, auth\_method, 9 more }

access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property

auth\_method: optional "KEY"or "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket: optional string Name of the storage medium’s bucket. Link to this property host: optional string SSH destination server host for SFTP type storage medium Link to this property password: optional string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property