--- title: Realtime Kit --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) 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/typescript/resources/realtime_kit/subresources/apps/methods/get) client.realtimeKit.apps.get(AppGetParams {account\_id, page\_no, per\_page, 2 more } params, RequestOptionsoptions?): [AppGetResponse]() {data, paging, success } GET/accounts/{account\_id}/realtime/kit/apps ##### [Create App](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/apps/methods/post) client.realtimeKit.apps.post(AppPostParams {account\_id, name } params, RequestOptionsoptions?): [AppPostResponse]() {data, success } POST/accounts/{account\_id}/realtime/kit/apps ##### ModelsExpand Collapse
AppGetResponse {data, paging, success }
data?: Array<Data> id?: string formatuuid Link to this property created\_at?: string formatdate-time Link to this property name?: string Link to this property
Link to this property
paging?: Paging {end\_offset, start\_offset, total\_count } end\_offset?: number Link to this property start\_offset?: number Link to this property total\_count?: number Link to this property
Link to this property success?: 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 {data, success }
data?: Data {app }
app?: App {id, created\_at, name } id?: string formatuuid Link to this property created\_at?: string formatdate-time Link to this property name?: string Link to this property
Link to this property
Link to this property success?: 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/typescript/resources/realtime_kit/subresources/meetings/methods/get) client.realtimeKit.meetings.get(stringappID, MeetingGetParams {account\_id, end\_time, page\_no, 4 more } params, RequestOptionsoptions?): [MeetingGetResponse]() {data, paging, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings ##### [Create a meeting](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/create) client.realtimeKit.meetings.create(stringappID, MeetingCreateParams {account\_id, ai\_config, live\_stream\_on\_start, 7 more } params, RequestOptionsoptions?): [MeetingCreateResponse]() {success, data } POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings ##### [Fetch a meeting for an App](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/get_meeting_by_id) client.realtimeKit.meetings.getMeetingByID(stringmeetingID, MeetingGetMeetingByIDParams {account\_id, app\_id, name } params, RequestOptionsoptions?): [MeetingGetMeetingByIDResponse]() {success, data } GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id} ##### [Update a meeting](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/update_meeting_by_id) client.realtimeKit.meetings.updateMeetingByID(stringmeetingID, MeetingUpdateMeetingByIDParams {account\_id, app\_id, ai\_config, 9 more } params, RequestOptionsoptions?): [MeetingUpdateMeetingByIDResponse]() {success, data } PATCH/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id} ##### [Replace a meeting](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/replace_meeting_by_id) client.realtimeKit.meetings.replaceMeetingByID(stringmeetingID, MeetingReplaceMeetingByIDParams {account\_id, app\_id, ai\_config, 8 more } params, RequestOptionsoptions?): [MeetingReplaceMeetingByIDResponse]() {success, data } PUT/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id} ##### [Fetch all participants of a meeting](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/get_meeting_participants) client.realtimeKit.meetings.getMeetingParticipants(stringmeetingID, MeetingGetMeetingParticipantsParams {account\_id, app\_id, page\_no, per\_page } params, RequestOptionsoptions?): [MeetingGetMeetingParticipantsResponse]() {data, paging, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants ##### [Add a participant](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/add_participant) client.realtimeKit.meetings.addParticipant(stringmeetingID, MeetingAddParticipantParams {account\_id, app\_id, custom\_participant\_id, 3 more } params, RequestOptionsoptions?): [MeetingAddParticipantResponse]() {success, data } POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants ##### [Fetch a participant's detail](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/get_meeting_participant) client.realtimeKit.meetings.getMeetingParticipant(stringparticipantID, MeetingGetMeetingParticipantParams {account\_id, app\_id, meeting\_id } params, RequestOptionsoptions?): [MeetingGetMeetingParticipantResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id} ##### [Edit a participant's detail](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/edit_participant) client.realtimeKit.meetings.editParticipant(stringparticipantID, MeetingEditParticipantParams {account\_id, app\_id, meeting\_id, 3 more } params, RequestOptionsoptions?): [MeetingEditParticipantResponse]() {success, data } PATCH/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id} ##### [Delete a participant](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/delete_meeting_participant) client.realtimeKit.meetings.deleteMeetingParticipant(stringparticipantID, MeetingDeleteMeetingParticipantParams {account\_id, app\_id, meeting\_id } params, RequestOptionsoptions?): [MeetingDeleteMeetingParticipantResponse]() {success, data } DELETE/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id} ##### [Refresh participant's authentication token](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/refresh_participant_token) client.realtimeKit.meetings.refreshParticipantToken(stringparticipantID, MeetingRefreshParticipantTokenParams {account\_id, app\_id, meeting\_id } params, RequestOptionsoptions?): [MeetingRefreshParticipantTokenResponse]() {data, success } POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id}/token ##### ModelsExpand Collapse
MeetingGetResponse {data, paging, success }
data: Array<Data> 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?: boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat?: boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start?: boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config?: RecordingConfig {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?: AudioConfig {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.
channel?: "mono"| "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?: "MP3"| "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?: boolean Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix?: string Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config?: LiveStreamingConfig {rtmp\_url } rtmp\_url?: string RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds?: 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?: RealtimekitBucketConfig {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?: UnionMember0 {access\_key, auth\_method, bucket, 9 more } | UnionMember1 {access\_key, region, auth\_method, 9 more } | UnionMember2 {private\_key, access\_key, auth\_method, 9 more } | UnionMember3 {password, access\_key, auth\_method, 9 more } | null One of the following:
UnionMember0 {access\_key, auth\_method, bucket, 9 more } access\_key?: 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?: "KEY"| "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?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type?: "gcs" Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember1 {access\_key, region, auth\_method, 9 more } access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property
auth\_method?: "KEY"| "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?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember2 {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?: 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?: "KEY" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember3 {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?: 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?: "PASSWORD" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config?: VideoConfig {codec, export\_file, height, 2 more }
codec?: "H264"| "VP8"| "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?: boolean Controls whether to export video file seperately Link to this property height?: number Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark?: Watermark {position, size, url } Watermark to be added to the recording
position?: "left top"| "right top"| "left bottom"| "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?: Size {height, width } Size of the watermark height?: number Height of the watermark in px minimum1 Link to this property width?: number Width of the watermark in px minimum1 Link to this property
Link to this property url?: string URL of the watermark image formaturi Link to this property
Link to this property width?: 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?: 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?: "ACTIVE"| "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?: 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?: string Title of the meeting. Link to this property transcribe\_on\_end?: boolean Automatically generate transcripts when the meeting ends. Link to this property
Link to this property
paging: Paging {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 {success, data } success: boolean Success status of the operation Link to this property
data?: Data {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?: AIConfig {summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization?: Summarization {summary\_type, text\_format, word\_limit } Summary Config
summary\_type?: "general"| "team\_meeting"| "sales\_call"| 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?: "plain\_text"| "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?: number Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property
Link to this property
transcription?: Transcription {keywords, language, profanity\_filter } Transcription Configurations keywords?: Array<string> Adds specific terms to improve accurate detection during transcription. Link to this property
language?: "en-US"| "en-IN"| "de"| 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?: 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?: boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat?: boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start?: boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config?: RecordingConfig {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?: AudioConfig {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.
channel?: "mono"| "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?: "MP3"| "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?: boolean Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix?: string Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config?: LiveStreamingConfig {rtmp\_url } rtmp\_url?: string RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds?: 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?: RealtimekitBucketConfig {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?: UnionMember0 {access\_key, auth\_method, bucket, 9 more } | UnionMember1 {access\_key, region, auth\_method, 9 more } | UnionMember2 {private\_key, access\_key, auth\_method, 9 more } | UnionMember3 {password, access\_key, auth\_method, 9 more } | null One of the following:
UnionMember0 {access\_key, auth\_method, bucket, 9 more } access\_key?: 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?: "KEY"| "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?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type?: "gcs" Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember1 {access\_key, region, auth\_method, 9 more } access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property
auth\_method?: "KEY"| "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?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember2 {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?: 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?: "KEY" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember3 {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?: 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?: "PASSWORD" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config?: VideoConfig {codec, export\_file, height, 2 more }
codec?: "H264"| "VP8"| "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?: boolean Controls whether to export video file seperately Link to this property height?: number Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark?: Watermark {position, size, url } Watermark to be added to the recording
position?: "left top"| "right top"| "left bottom"| "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?: Size {height, width } Size of the watermark height?: number Height of the watermark in px minimum1 Link to this property width?: number Width of the watermark in px minimum1 Link to this property
Link to this property url?: string URL of the watermark image formaturi Link to this property
Link to this property width?: 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?: 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?: "ACTIVE"| "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?: 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?: string Title of the meeting. Link to this property transcribe\_on\_end?: 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 {success, data } success: boolean Success status of the operation Link to this property
data?: Data {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?: AIConfig {summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization?: Summarization {summary\_type, text\_format, word\_limit } Summary Config
summary\_type?: "general"| "team\_meeting"| "sales\_call"| 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?: "plain\_text"| "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?: number Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property
Link to this property
transcription?: Transcription {keywords, language, profanity\_filter } Transcription Configurations keywords?: Array<string> Adds specific terms to improve accurate detection during transcription. Link to this property
language?: "en-US"| "en-IN"| "de"| 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?: 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?: boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat?: boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start?: boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config?: RecordingConfig {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?: AudioConfig {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.
channel?: "mono"| "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?: "MP3"| "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?: boolean Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix?: string Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config?: LiveStreamingConfig {rtmp\_url } rtmp\_url?: string RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds?: 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?: RealtimekitBucketConfig {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?: UnionMember0 {access\_key, auth\_method, bucket, 9 more } | UnionMember1 {access\_key, region, auth\_method, 9 more } | UnionMember2 {private\_key, access\_key, auth\_method, 9 more } | UnionMember3 {password, access\_key, auth\_method, 9 more } | null One of the following:
UnionMember0 {access\_key, auth\_method, bucket, 9 more } access\_key?: 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?: "KEY"| "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?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type?: "gcs" Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember1 {access\_key, region, auth\_method, 9 more } access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property
auth\_method?: "KEY"| "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?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember2 {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?: 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?: "KEY" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember3 {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?: 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?: "PASSWORD" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config?: VideoConfig {codec, export\_file, height, 2 more }
codec?: "H264"| "VP8"| "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?: boolean Controls whether to export video file seperately Link to this property height?: number Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark?: Watermark {position, size, url } Watermark to be added to the recording
position?: "left top"| "right top"| "left bottom"| "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?: Size {height, width } Size of the watermark height?: number Height of the watermark in px minimum1 Link to this property width?: number Width of the watermark in px minimum1 Link to this property
Link to this property url?: string URL of the watermark image formaturi Link to this property
Link to this property width?: 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?: 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?: "ACTIVE"| "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?: 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?: string Title of the meeting. Link to this property transcribe\_on\_end?: 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 {success, data } success: boolean Success status of the operation Link to this property
data?: Data {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?: AIConfig {summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization?: Summarization {summary\_type, text\_format, word\_limit } Summary Config
summary\_type?: "general"| "team\_meeting"| "sales\_call"| 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?: "plain\_text"| "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?: number Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property
Link to this property
transcription?: Transcription {keywords, language, profanity\_filter } Transcription Configurations keywords?: Array<string> Adds specific terms to improve accurate detection during transcription. Link to this property
language?: "en-US"| "en-IN"| "de"| 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?: 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?: boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat?: boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start?: boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config?: RecordingConfig {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?: AudioConfig {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.
channel?: "mono"| "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?: "MP3"| "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?: boolean Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix?: string Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config?: LiveStreamingConfig {rtmp\_url } rtmp\_url?: string RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds?: 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?: RealtimekitBucketConfig {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?: UnionMember0 {access\_key, auth\_method, bucket, 9 more } | UnionMember1 {access\_key, region, auth\_method, 9 more } | UnionMember2 {private\_key, access\_key, auth\_method, 9 more } | UnionMember3 {password, access\_key, auth\_method, 9 more } | null One of the following:
UnionMember0 {access\_key, auth\_method, bucket, 9 more } access\_key?: 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?: "KEY"| "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?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type?: "gcs" Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember1 {access\_key, region, auth\_method, 9 more } access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property
auth\_method?: "KEY"| "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?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember2 {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?: 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?: "KEY" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember3 {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?: 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?: "PASSWORD" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config?: VideoConfig {codec, export\_file, height, 2 more }
codec?: "H264"| "VP8"| "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?: boolean Controls whether to export video file seperately Link to this property height?: number Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark?: Watermark {position, size, url } Watermark to be added to the recording
position?: "left top"| "right top"| "left bottom"| "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?: Size {height, width } Size of the watermark height?: number Height of the watermark in px minimum1 Link to this property width?: number Width of the watermark in px minimum1 Link to this property
Link to this property url?: string URL of the watermark image formaturi Link to this property
Link to this property width?: 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?: 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?: "ACTIVE"| "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?: 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?: string Title of the meeting. Link to this property transcribe\_on\_end?: 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 {success, data } success: boolean Success status of the operation Link to this property
data?: Data {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?: AIConfig {summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization?: Summarization {summary\_type, text\_format, word\_limit } Summary Config
summary\_type?: "general"| "team\_meeting"| "sales\_call"| 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?: "plain\_text"| "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?: number Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property
Link to this property
transcription?: Transcription {keywords, language, profanity\_filter } Transcription Configurations keywords?: Array<string> Adds specific terms to improve accurate detection during transcription. Link to this property
language?: "en-US"| "en-IN"| "de"| 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?: 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?: boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat?: boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start?: boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config?: RecordingConfig {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?: AudioConfig {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.
channel?: "mono"| "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?: "MP3"| "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?: boolean Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix?: string Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config?: LiveStreamingConfig {rtmp\_url } rtmp\_url?: string RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds?: 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?: RealtimekitBucketConfig {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?: UnionMember0 {access\_key, auth\_method, bucket, 9 more } | UnionMember1 {access\_key, region, auth\_method, 9 more } | UnionMember2 {private\_key, access\_key, auth\_method, 9 more } | UnionMember3 {password, access\_key, auth\_method, 9 more } | null One of the following:
UnionMember0 {access\_key, auth\_method, bucket, 9 more } access\_key?: 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?: "KEY"| "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?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type?: "gcs" Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember1 {access\_key, region, auth\_method, 9 more } access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property
auth\_method?: "KEY"| "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?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember2 {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?: 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?: "KEY" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property 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 path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember3 {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?: 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?: "PASSWORD" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property 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 region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 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?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config?: VideoConfig {codec, export\_file, height, 2 more }
codec?: "H264"| "VP8"| "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?: boolean Controls whether to export video file seperately Link to this property height?: number Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark?: Watermark {position, size, url } Watermark to be added to the recording
position?: "left top"| "right top"| "left bottom"| "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?: Size {height, width } Size of the watermark height?: number Height of the watermark in px minimum1 Link to this property width?: number Width of the watermark in px minimum1 Link to this property
Link to this property url?: string URL of the watermark image formaturi Link to this property
Link to this property width?: 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?: 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?: "ACTIVE"| "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?: 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?: string Title of the meeting. Link to this property transcribe\_on\_end?: 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 {data, paging, success }
data: Array<Data> 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?: string| null Name of the participant. Link to this property picture?: string| null URL to a picture of the participant. formaturi Link to this property
Link to this property
paging: Paging {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 {success, data } success: boolean Success status of the operation Link to this property
data?: Data {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?: string| null Name of the participant. Link to this property picture?: string| null 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 {data, success }
data: Data {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?: string| null Name of the participant. Link to this property picture?: string| null 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 {success, data } success: boolean Success status of the operation Link to this property
data?: Data {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?: string| null Name of the participant. Link to this property picture?: string| null 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 {success, data } success: boolean Success status of the operation Link to this property
data?: Data {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 {data, success }
data: Data {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/typescript/resources/realtime_kit/subresources/presets/methods/get) client.realtimeKit.presets.get(stringappID, PresetGetParams {account\_id, page\_no, per\_page, search } params, RequestOptionsoptions?): [PresetGetResponse]() {data, paging, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/presets ##### [Create a preset](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/presets/methods/create) client.realtimeKit.presets.create(stringappID, PresetCreateParams {account\_id, config, name, 2 more } params, RequestOptionsoptions?): [PresetCreateResponse]() {data, success } POST/accounts/{account\_id}/realtime/kit/{app\_id}/presets ##### [Fetch details of a preset](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/presets/methods/get_preset_by_id) client.realtimeKit.presets.getPresetByID(stringpresetID, PresetGetPresetByIDParams {account\_id, app\_id } params, RequestOptionsoptions?): [PresetGetPresetByIDResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### [Delete a preset](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/presets/methods/delete) client.realtimeKit.presets.delete(stringpresetID, PresetDeleteParams {account\_id, app\_id } params, RequestOptionsoptions?): [PresetDeleteResponse]() {data, success } DELETE/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### [Update a preset](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/presets/methods/update) client.realtimeKit.presets.update(stringpresetID, PresetUpdateParams {account\_id, app\_id, config, 3 more } params, RequestOptionsoptions?): [PresetUpdateResponse]() {data, success } PATCH/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### [Replace a preset](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/presets/methods/replace_preset_by_id) client.realtimeKit.presets.replacePresetByID(stringpresetID, PresetReplacePresetByIDParams {account\_id, app\_id, config, 3 more } params, RequestOptionsoptions?): [PresetReplacePresetByIDResponse]() {data, success } PUT/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### ModelsExpand Collapse
PresetGetResponse {data, paging, success }
data: Array<Data> id?: string ID of the preset formatuuid 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 updated\_at?: string Timestamp this preset was last updated formatdate-time Link to this property
Link to this property
paging: Paging {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 {data, success }
data: Data {id, config, created\_at, 4 more } Data returned by the operation id: string ID of the preset formatuuid Link to this property
config: Config {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: MaxVideoStreams {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: Media {screenshare, video, audio } Media configuration options. eg: Video quality
screenshare: Screenshare {frame\_rate, quality } Configuration options for participant screen shares frame\_rate: number Frame rate of screen share Link to this property
quality: "hd"| "vga"| "qvga"| 2 more Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: Video {frame\_rate, quality, simulcast } Configuration options for participant videos frame\_rate: number Frame rate of participants’ video maximum30 Link to this property
quality: "hd"| "vga"| "qvga"| 2 more Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast?: boolean Enable simulcast for participant videos. Link to this property
Link to this property
audio?: Audio {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality. enable\_high\_bitrate?: boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo?: boolean Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: "GROUP\_CALL"| "WEBINAR"| "AUDIO\_ROOM"| "LIVESTREAM" Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities?: Array<number>| null 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: Permissions {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: Chat {private, public }
private: Private {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: Public {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: ConnectedMeetings {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: Media {audio, screenshare, video } Media permissions
audio: Audio {can\_produce } Audio permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: Screenshare {can\_produce } Screenshare permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: Video {can\_produce } Video permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: boolean Link to this property
plugins: Plugins {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: Record<string, Config> Plugin configuration keyed by plugin UUID.
access\_control?: "FULL\_ACCESS"| "VIEW\_ONLY" One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only?: boolean Link to this property
Link to this property
Link to this property
polls: Polls {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"| "LIVESTREAMER"| "NONE" Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: boolean Link to this property
waiting\_room\_type: "SKIP"| "ON\_PRIVILEGED\_USER\_ENTRY"| "SKIP\_ON\_ACCEPT" Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests?: boolean Link to this property is\_recorder?: boolean Link to this property
stage\_access?: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled?: boolean Link to this property transcription\_enabled?: boolean Link to this property
Link to this property
ui: UI {design\_tokens }
design\_tokens: DesignTokens {border\_radius, border\_width, colors, 5 more }
border\_radius: "sharp"| "rounded"| "extra-rounded"| "circular" One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: "none"| "thin"| "fat" One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: Colors {background, brand, danger, 5 more }
background: Background {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: Brand {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"| "dark"| "light" One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family?: string Link to this property google\_font?: string Link to this property logo?: 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 {data, success }
data: Data {id, config, created\_at, 4 more } Data returned by the operation id: string ID of the preset formatuuid Link to this property
config: Config {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: MaxVideoStreams {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: Media {screenshare, video, audio } Media configuration options. eg: Video quality
screenshare: Screenshare {frame\_rate, quality } Configuration options for participant screen shares frame\_rate: number Frame rate of screen share Link to this property
quality: "hd"| "vga"| "qvga"| 2 more Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: Video {frame\_rate, quality, simulcast } Configuration options for participant videos frame\_rate: number Frame rate of participants’ video maximum30 Link to this property
quality: "hd"| "vga"| "qvga"| 2 more Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast?: boolean Enable simulcast for participant videos. Link to this property
Link to this property
audio?: Audio {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality. enable\_high\_bitrate?: boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo?: boolean Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: "GROUP\_CALL"| "WEBINAR"| "AUDIO\_ROOM"| "LIVESTREAM" Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities?: Array<number>| null 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: Permissions {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: Chat {private, public }
private: Private {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: Public {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: ConnectedMeetings {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: Media {audio, screenshare, video } Media permissions
audio: Audio {can\_produce } Audio permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: Screenshare {can\_produce } Screenshare permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: Video {can\_produce } Video permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: boolean Link to this property
plugins: Plugins {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: Record<string, Config> Plugin configuration keyed by plugin UUID.
access\_control?: "FULL\_ACCESS"| "VIEW\_ONLY" One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only?: boolean Link to this property
Link to this property
Link to this property
polls: Polls {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"| "LIVESTREAMER"| "NONE" Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: boolean Link to this property
waiting\_room\_type: "SKIP"| "ON\_PRIVILEGED\_USER\_ENTRY"| "SKIP\_ON\_ACCEPT" Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests?: boolean Link to this property is\_recorder?: boolean Link to this property
stage\_access?: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled?: boolean Link to this property transcription\_enabled?: boolean Link to this property
Link to this property
ui: UI {design\_tokens }
design\_tokens: DesignTokens {border\_radius, border\_width, colors, 5 more }
border\_radius: "sharp"| "rounded"| "extra-rounded"| "circular" One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: "none"| "thin"| "fat" One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: Colors {background, brand, danger, 5 more }
background: Background {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: Brand {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"| "dark"| "light" One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family?: string Link to this property google\_font?: string Link to this property logo?: 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 {data, success }
data: Data {id, config, created\_at, 4 more } Data returned by the operation id: string ID of the preset formatuuid Link to this property
config: Config {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: MaxVideoStreams {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: Media {screenshare, video, audio } Media configuration options. eg: Video quality
screenshare: Screenshare {frame\_rate, quality } Configuration options for participant screen shares frame\_rate: number Frame rate of screen share Link to this property
quality: "hd"| "vga"| "qvga"| 2 more Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: Video {frame\_rate, quality, simulcast } Configuration options for participant videos frame\_rate: number Frame rate of participants’ video maximum30 Link to this property
quality: "hd"| "vga"| "qvga"| 2 more Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast?: boolean Enable simulcast for participant videos. Link to this property
Link to this property
audio?: Audio {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality. enable\_high\_bitrate?: boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo?: boolean Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: "GROUP\_CALL"| "WEBINAR"| "AUDIO\_ROOM"| "LIVESTREAM" Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities?: Array<number>| null 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: Permissions {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: Chat {private, public }
private: Private {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: Public {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: ConnectedMeetings {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: Media {audio, screenshare, video } Media permissions
audio: Audio {can\_produce } Audio permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: Screenshare {can\_produce } Screenshare permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: Video {can\_produce } Video permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: boolean Link to this property
plugins: Plugins {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: Record<string, Config> Plugin configuration keyed by plugin UUID.
access\_control?: "FULL\_ACCESS"| "VIEW\_ONLY" One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only?: boolean Link to this property
Link to this property
Link to this property
polls: Polls {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"| "LIVESTREAMER"| "NONE" Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: boolean Link to this property
waiting\_room\_type: "SKIP"| "ON\_PRIVILEGED\_USER\_ENTRY"| "SKIP\_ON\_ACCEPT" Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests?: boolean Link to this property is\_recorder?: boolean Link to this property
stage\_access?: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled?: boolean Link to this property transcription\_enabled?: boolean Link to this property
Link to this property
ui: UI {design\_tokens }
design\_tokens: DesignTokens {border\_radius, border\_width, colors, 5 more }
border\_radius: "sharp"| "rounded"| "extra-rounded"| "circular" One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: "none"| "thin"| "fat" One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: Colors {background, brand, danger, 5 more }
background: Background {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: Brand {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"| "dark"| "light" One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family?: string Link to this property google\_font?: string Link to this property logo?: 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 {data, success }
data: Data {id, config, created\_at, 4 more } Data returned by the operation id: string ID of the preset formatuuid Link to this property
config: Config {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: MaxVideoStreams {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: Media {screenshare, video, audio } Media configuration options. eg: Video quality
screenshare: Screenshare {frame\_rate, quality } Configuration options for participant screen shares frame\_rate: number Frame rate of screen share Link to this property
quality: "hd"| "vga"| "qvga"| 2 more Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: Video {frame\_rate, quality, simulcast } Configuration options for participant videos frame\_rate: number Frame rate of participants’ video maximum30 Link to this property
quality: "hd"| "vga"| "qvga"| 2 more Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast?: boolean Enable simulcast for participant videos. Link to this property
Link to this property
audio?: Audio {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality. enable\_high\_bitrate?: boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo?: boolean Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: "GROUP\_CALL"| "WEBINAR"| "AUDIO\_ROOM"| "LIVESTREAM" Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities?: Array<number>| null 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: Permissions {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: Chat {private, public }
private: Private {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: Public {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: ConnectedMeetings {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: Media {audio, screenshare, video } Media permissions
audio: Audio {can\_produce } Audio permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: Screenshare {can\_produce } Screenshare permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: Video {can\_produce } Video permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: boolean Link to this property
plugins: Plugins {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: Record<string, Config> Plugin configuration keyed by plugin UUID.
access\_control?: "FULL\_ACCESS"| "VIEW\_ONLY" One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only?: boolean Link to this property
Link to this property
Link to this property
polls: Polls {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"| "LIVESTREAMER"| "NONE" Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: boolean Link to this property
waiting\_room\_type: "SKIP"| "ON\_PRIVILEGED\_USER\_ENTRY"| "SKIP\_ON\_ACCEPT" Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests?: boolean Link to this property is\_recorder?: boolean Link to this property
stage\_access?: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled?: boolean Link to this property transcription\_enabled?: boolean Link to this property
Link to this property
ui: UI {design\_tokens }
design\_tokens: DesignTokens {border\_radius, border\_width, colors, 5 more }
border\_radius: "sharp"| "rounded"| "extra-rounded"| "circular" One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: "none"| "thin"| "fat" One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: Colors {background, brand, danger, 5 more }
background: Background {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: Brand {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"| "dark"| "light" One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family?: string Link to this property google\_font?: string Link to this property logo?: 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 {data, success }
data: Data {id, config, created\_at, 4 more } Data returned by the operation id: string ID of the preset formatuuid Link to this property
config: Config {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: MaxVideoStreams {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: Media {screenshare, video, audio } Media configuration options. eg: Video quality
screenshare: Screenshare {frame\_rate, quality } Configuration options for participant screen shares frame\_rate: number Frame rate of screen share Link to this property
quality: "hd"| "vga"| "qvga"| 2 more Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: Video {frame\_rate, quality, simulcast } Configuration options for participant videos frame\_rate: number Frame rate of participants’ video maximum30 Link to this property
quality: "hd"| "vga"| "qvga"| 2 more Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast?: boolean Enable simulcast for participant videos. Link to this property
Link to this property
audio?: Audio {enable\_high\_bitrate, enable\_stereo } Control options for Audio quality. enable\_high\_bitrate?: boolean Enable High Quality Audio for your meetings Link to this property enable\_stereo?: boolean Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: "GROUP\_CALL"| "WEBINAR"| "AUDIO\_ROOM"| "LIVESTREAM" Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities?: Array<number>| null 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: Permissions {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: Chat {private, public }
private: Private {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: Public {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: ConnectedMeetings {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: Media {audio, screenshare, video } Media permissions
audio: Audio {can\_produce } Audio permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: Screenshare {can\_produce } Screenshare permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: Video {can\_produce } Video permissions
can\_produce: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: boolean Link to this property
plugins: Plugins {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: Record<string, Config> Plugin configuration keyed by plugin UUID.
access\_control?: "FULL\_ACCESS"| "VIEW\_ONLY" One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only?: boolean Link to this property
Link to this property
Link to this property
polls: Polls {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"| "LIVESTREAMER"| "NONE" Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: boolean Link to this property
waiting\_room\_type: "SKIP"| "ON\_PRIVILEGED\_USER\_ENTRY"| "SKIP\_ON\_ACCEPT" Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests?: boolean Link to this property is\_recorder?: boolean Link to this property
stage\_access?: "ALLOWED"| "NOT\_ALLOWED"| "CAN\_REQUEST" One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled?: boolean Link to this property transcription\_enabled?: boolean Link to this property
Link to this property
ui: UI {design\_tokens }
design\_tokens: DesignTokens {border\_radius, border\_width, colors, 5 more }
border\_radius: "sharp"| "rounded"| "extra-rounded"| "circular" One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: "none"| "thin"| "fat" One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: Colors {background, brand, danger, 5 more }
background: Background {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: Brand {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"| "dark"| "light" One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family?: string Link to this property google\_font?: string Link to this property logo?: 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/typescript/resources/realtime_kit/subresources/sessions/methods/get_sessions) client.realtimeKit.sessions.getSessions(stringappID, SessionGetSessionsParams {account\_id, associated\_id, end\_time, 8 more } params, RequestOptionsoptions?): [SessionGetSessionsResponse]() {data, paging, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions ##### [Fetch details of a session](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_session_details) client.realtimeKit.sessions.getSessionDetails(stringsessionID, SessionGetSessionDetailsParams {account\_id, app\_id, include\_breakout\_rooms } params, RequestOptionsoptions?): [SessionGetSessionDetailsResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id} ##### [Fetch participants list of a session](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_session_participants) client.realtimeKit.sessions.getSessionParticipants(stringsessionID, SessionGetSessionParticipantsParams {account\_id, app\_id, include\_peer\_events, 6 more } params, RequestOptionsoptions?): [SessionGetSessionParticipantsResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/participants ##### [Fetch details of a participant](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_session_participant_details) client.realtimeKit.sessions.getSessionParticipantDetails(stringparticipantID, SessionGetSessionParticipantDetailsParams {account\_id, app\_id, session\_id, include\_peer\_events } params, RequestOptionsoptions?): [SessionGetSessionParticipantDetailsResponse]() {data, success } 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/typescript/resources/realtime_kit/subresources/sessions/methods/get_session_chat) client.realtimeKit.sessions.getSessionChat(stringsessionID, SessionGetSessionChatParams {account\_id, app\_id } params, RequestOptionsoptions?): [SessionGetSessionChatResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/chat ##### [Fetch the complete transcript for a session](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_session_transcripts) client.realtimeKit.sessions.getSessionTranscripts(stringsessionID, SessionGetSessionTranscriptsParams {account\_id, app\_id, format } params, RequestOptionsoptions?): [SessionGetSessionTranscriptsResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/transcript ##### [Fetch summary of transcripts for a session](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_session_summary) client.realtimeKit.sessions.getSessionSummary(stringsessionID, SessionGetSessionSummaryParams {account\_id, app\_id } params, RequestOptionsoptions?): [SessionGetSessionSummaryResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/summary ##### [Generate summary of Transcripts for the session](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/generate_summary_of_transcripts) client.realtimeKit.sessions.generateSummaryOfTranscripts(stringsessionID, SessionGenerateSummaryOfTranscriptsParams {account\_id, app\_id } params, RequestOptionsoptions?): [SessionGenerateSummaryOfTranscriptsResponse]() {data, success } POST/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/summary ##### [Fetch details of peer](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/sessions/methods/get_participant_data_from_peer_id) client.realtimeKit.sessions.getParticipantDataFromPeerID(stringpeerID, SessionGetParticipantDataFromPeerIDParams {account\_id, app\_id, filters, include\_peer\_events } params, RequestOptionsoptions?): [SessionGetParticipantDataFromPeerIDResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/peer-report/{peer\_id} ##### ModelsExpand Collapse
SessionGetSessionsResponse {data, paging, success }
data?: Data {sessions }
sessions?: Array<Session> 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"| "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"| "livestream"| "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?: Array<unknown> Link to this property ended\_at?: string timestamp when session ended Link to this property
Link to this property
Link to this property
paging?: Paging {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.sessions%20%3E%20(model)%20session_get_sessions_response%20%3E%20(schema)>)
SessionGetSessionDetailsResponse {data, success }
data?: Data {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"| "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"| "livestream"| "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?: Array<unknown> Link to this property ended\_at?: string timestamp when session ended Link to this property
Link to this property success?: 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 {data, success }
data?: Data {participants }
participants?: Array<Participant> id?: string Participant ID. This maps to the corresponding peerId. Link to this property created\_at?: string timestamp when this participant was created. Link to this property custom\_participant\_id?: string ID passed by client to create this participant. Link to this property display\_name?: string Display name of participant when joining the session. Link to this property duration?: number number of minutes for which the participant was in the session. Link to this property joined\_at?: string timestamp at which participant joined the session. Link to this property left\_at?: string timestamp at which participant left the session. Link to this property
peer\_events?: Array<PeerEvent> Connection lifecycle events for the participant’s peer. Only included when include_peer_events is true. id?: string ID of the peer event. Link to this property created\_at?: string Timestamp when this peer event was created. Link to this property
event\_name?: "PEER\_CREATED"| "PEER\_JOINING"| "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?: number Minutes consumed attributed to this event. Link to this property participant\_id?: string| null ID of the participant this event belongs to. Link to this property peer\_id?: string Peer ID this event belongs to. Link to this property
preset\_view\_type?: "GROUP\_CALL"| "WEBINAR"| "AUDIO\_ROOM"| 2 more| null 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?: string| null ID of the session this event belongs to. Link to this property socket\_session\_id?: string| null ID of the socket session associated with this event. Link to this property updated\_at?: string Timestamp when this peer event was last updated. Link to this property
Link to this property preset\_name?: string Name of the preset associated with the participant. Link to this property updated\_at?: string timestamp when this participant’s data was last updated. Link to this property user\_id?: string User id for this participant. Link to this property
Link to this property
Link to this property success?: 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 {data, success }
data?: Data {participant }
participant?: Participant {id, created\_at, custom\_participant\_id, 8 more } id?: string Participant ID. This maps to the corresponding peerId. Link to this property created\_at?: string timestamp when this participant was created. Link to this property custom\_participant\_id?: string ID passed by client to create this participant. Link to this property display\_name?: string Display name of participant when joining the session. Link to this property duration?: number number of minutes for which the participant was in the session. Link to this property joined\_at?: string timestamp at which participant joined the session. Link to this property left\_at?: string timestamp at which participant left the session. Link to this property
peer\_events?: Array<PeerEvent> Connection lifecycle events for the participant’s peer. Only included when include_peer_events is true. id?: string ID of the peer event. Link to this property created\_at?: string Timestamp when this peer event was created. Link to this property
event\_name?: "PEER\_CREATED"| "PEER\_JOINING"| "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?: number Minutes consumed attributed to this event. Link to this property participant\_id?: string| null ID of the participant this event belongs to. Link to this property peer\_id?: string Peer ID this event belongs to. Link to this property
preset\_view\_type?: "GROUP\_CALL"| "WEBINAR"| "AUDIO\_ROOM"| 2 more| null 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?: string| null ID of the session this event belongs to. Link to this property socket\_session\_id?: string| null ID of the socket session associated with this event. Link to this property updated\_at?: string Timestamp when this peer event was last updated. Link to this property
Link to this property preset\_name?: string Name of the preset associated with the participant. Link to this property updated\_at?: string timestamp when this participant’s data was last updated. Link to this property user\_id?: string User id for this participant. Link to this property
Link to this property
Link to this property success?: 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 {data, success }
data?: Data {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?: 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 {data, success }
data?: Data {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?: 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 {data, success }
data?: Data {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?: 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 {data, success }
data?: Data {session\_id, status } session\_id?: string formatuuid Link to this property status?: string Link to this property
Link to this property success?: 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 {data, success }
data?: Data {participant }
participant?: Participant {id, created\_at, custom\_participant\_id, 10 more } id?: string ID of the participant. formatuuid Link to this property created\_at?: string timestamp when this participant was created. Link to this property custom\_participant\_id?: string ID passed by client to create this participant. Link to this property display\_name?: string Display name of participant when joining the session. Link to this property duration?: number number of minutes for which the participant was in the session. Link to this property joined\_at?: string timestamp at which participant joined the session. Link to this property left\_at?: string timestamp at which participant left the session. Link to this property
peer\_events?: Array<PeerEvent> Connection lifecycle events for the participant’s peer. id?: string ID of the peer event. Link to this property created\_at?: string Timestamp when this peer event was created. Link to this property
event\_name?: "PEER\_CREATED"| "PEER\_JOINING"| "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?: number Minutes consumed attributed to this event. Link to this property participant\_id?: string| null ID of the participant this event belongs to. Link to this property peer\_id?: string Peer ID this event belongs to. Link to this property
preset\_view\_type?: "GROUP\_CALL"| "WEBINAR"| "AUDIO\_ROOM"| 2 more| null 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?: string| null ID of the session this event belongs to. Link to this property socket\_session\_id?: string| null ID of the socket session associated with this event. Link to this property updated\_at?: string Timestamp when this peer event was last updated. Link to this property
Link to this property
peer\_report?: PeerReport {metadata, quality } Peer call statistics report.
metadata?: Metadata {audio\_devices\_updates, browser\_metadata, candidate\_pairs, 12 more } Connection and device metadata for the participant.
audio\_devices\_updates?: Array<AudioDevicesUpdate>
added?: Array<Added> Devices that became available. device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property
removed?: Array<Removed> Devices that became unavailable. device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property timestamp?: string Timestamp of the device update. Link to this property
Link to this property
browser\_metadata?: BrowserMetadata {browser, browser\_version, engine, 2 more } browser?: string Link to this property browser\_version?: string Link to this property engine?: string Link to this property user\_agent?: string Link to this property webgl\_support?: boolean| null Link to this property
Link to this property
candidate\_pairs?: CandidatePairs {consuming\_transport, producing\_transport }
consuming\_transport?: Array<ConsumingTransport> available\_incoming\_bitrate?: number Link to this property available\_outgoing\_bitrate?: number Link to this property bytes\_discarded\_on\_send?: number Link to this property bytes\_received?: number Link to this property bytes\_sent?: number Link to this property current\_round\_trip\_time?: number Link to this property last\_packet\_received\_timestamp?: number Epoch milliseconds when the last packet was received. Link to this property last\_packet\_sent\_timestamp?: number Epoch milliseconds when the last packet was sent. Link to this property local\_candidate\_address?: string Link to this property local\_candidate\_id?: string Link to this property local\_candidate\_network\_type?: string Link to this property local\_candidate\_port?: number Link to this property local\_candidate\_protocol?: string Link to this property local\_candidate\_related\_address?: string Link to this property local\_candidate\_related\_port?: number Link to this property local\_candidate\_type?: string Link to this property local\_candidate\_url?: string Link to this property nominated?: boolean Link to this property packets\_discarded\_on\_send?: number Link to this property packets\_received?: number Link to this property packets\_sent?: number Link to this property remote\_candidate\_address?: string Link to this property remote\_candidate\_id?: string Link to this property remote\_candidate\_port?: number Link to this property remote\_candidate\_protocol?: string Link to this property remote\_candidate\_type?: string Link to this property remote\_candidate\_url?: string Link to this property total\_round\_trip\_time?: number Link to this property
Link to this property
producing\_transport?: Array<ProducingTransport> available\_incoming\_bitrate?: number Link to this property available\_outgoing\_bitrate?: number Link to this property bytes\_discarded\_on\_send?: number Link to this property bytes\_received?: number Link to this property bytes\_sent?: number Link to this property current\_round\_trip\_time?: number Link to this property last\_packet\_received\_timestamp?: number Epoch milliseconds when the last packet was received. Link to this property last\_packet\_sent\_timestamp?: number Epoch milliseconds when the last packet was sent. Link to this property local\_candidate\_address?: string Link to this property local\_candidate\_id?: string Link to this property local\_candidate\_network\_type?: string Link to this property local\_candidate\_port?: number Link to this property local\_candidate\_protocol?: string Link to this property local\_candidate\_related\_address?: string Link to this property local\_candidate\_related\_port?: number Link to this property local\_candidate\_type?: string Link to this property local\_candidate\_url?: string Link to this property nominated?: boolean Link to this property packets\_discarded\_on\_send?: number Link to this property packets\_received?: number Link to this property packets\_sent?: number Link to this property remote\_candidate\_address?: string Link to this property remote\_candidate\_id?: string Link to this property remote\_candidate\_port?: number Link to this property remote\_candidate\_protocol?: string Link to this property remote\_candidate\_type?: string Link to this property remote\_candidate\_url?: string Link to this property total\_round\_trip\_time?: number Link to this property
Link to this property
Link to this property
device\_info?: DeviceInfo {cpus, is\_mobile, os, os\_version } cpus?: number Link to this property is\_mobile?: boolean Link to this property os?: string Link to this property os\_version?: string Link to this property
Link to this property
events?: Array<Event>
metadata?: Record<string, string| number| boolean| null> 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?: string Name of the event. Link to this property timestamp?: string Timestamp when the event occurred. Link to this property
Link to this property
ip\_information?: IPInformation {asn, city, country, 4 more }
asn?: ASN {asn, domain, name, 2 more } asn?: string Link to this property domain?: string Link to this property name?: string Link to this property route?: string Link to this property type?: string Link to this property
Link to this property city?: string Link to this property country?: string Link to this property ipv4?: string Link to this property org?: string Link to this property region?: string Link to this property timezone?: string Link to this property
Link to this property
native\_metadata?: NativeMetadata {audio\_encoder, video\_encoder } audio\_encoder?: string Link to this property video\_encoder?: string Link to this property
Link to this property
pc\_metadata?: Array<PcMetadata> effective\_network\_type?: string Link to this property reflexive\_connectivity?: boolean Link to this property relay\_connectivity?: boolean Link to this property sdp?: Array<string> Link to this property timestamp?: string Link to this property turn\_connectivity?: boolean Link to this property
Link to this property room\_view\_type?: string Link to this property sdk\_name?: string Link to this property sdk\_type?: string Link to this property sdk\_version?: string Link to this property
selected\_device\_updates?: Array<SelectedDeviceUpdate>
device?: Device {device\_id, kind, label } A media device (camera, microphone, or speaker). device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property timestamp?: string Link to this property
Link to this property
speaker\_devices\_updates?: Array<SpeakerDevicesUpdate>
added?: Array<Added> Devices that became available. device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property
removed?: Array<Removed> Devices that became unavailable. device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property timestamp?: string Timestamp of the device update. Link to this property
Link to this property
video\_devices\_updates?: Array<VideoDevicesUpdate>
added?: Array<Added> Devices that became available. device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property
removed?: Array<Removed> Devices that became unavailable. device\_id?: string ID of the device. Link to this property kind?: string Kind of device, for example audioinput or videoinput. Link to this property label?: string Human-readable label of the device. Link to this property
Link to this property timestamp?: string Timestamp of the device update. Link to this property
Link to this property
Link to this property
quality?: Quality {audio\_consumer, audio\_consumer\_cumulative, audio\_producer, 13 more } Media quality statistics for the participant.
audio\_consumer?: Array<AudioConsumer> bytes\_received?: number Link to this property concealment\_events?: number Link to this property consumer\_id?: string Link to this property jitter?: number Link to this property jitter\_buffer\_delay?: number Link to this property jitter\_buffer\_emitted\_count?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_received?: number Link to this property peer\_id?: string Link to this property producer\_id?: string Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
audio\_consumer\_cumulative?: AudioConsumerCumulative {jitter\_buffer\_delay, packet\_loss, quality\_mos } Aggregated inbound (consumer) audio statistics for the session.
jitter\_buffer\_delay?: JitterBufferDelay {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"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
packet\_loss?: PacketLoss {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"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
Link to this property
audio\_producer?: Array<AudioProducer> bytes\_sent?: number Link to this property jitter?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_sent?: number Link to this property producer\_id?: string Link to this property rtt?: number Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
audio\_producer\_cumulative?: AudioProducerCumulative {packet\_loss, quality\_mos, rtt } Aggregated outbound (producer) audio statistics for the session.
packet\_loss?: PacketLoss {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"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
rtt?: RTT {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"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
Link to this property
screenshare\_audio\_consumer?: Array<ScreenshareAudioConsumer> bytes\_received?: number Link to this property concealment\_events?: number Link to this property consumer\_id?: string Link to this property jitter?: number Link to this property jitter\_buffer\_delay?: number Link to this property jitter\_buffer\_emitted\_count?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_received?: number Link to this property peer\_id?: string Link to this property producer\_id?: string Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
screenshare\_audio\_consumer\_cumulative?: ScreenshareAudioConsumerCumulative {jitter\_buffer\_delay, packet\_loss, quality\_mos } Aggregated inbound (consumer) audio statistics for the session.
jitter\_buffer\_delay?: JitterBufferDelay {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"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
packet\_loss?: PacketLoss {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"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
Link to this property
screenshare\_audio\_producer?: Array<ScreenshareAudioProducer> bytes\_sent?: number Link to this property jitter?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_sent?: number Link to this property producer\_id?: string Link to this property rtt?: number Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
screenshare\_audio\_producer\_cumulative?: ScreenshareAudioProducerCumulative {packet\_loss, quality\_mos, rtt } Aggregated outbound (producer) audio statistics for the session.
packet\_loss?: PacketLoss {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"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
rtt?: RTT {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"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
Link to this property
screenshare\_video\_consumer?: Array<ScreenshareVideoConsumer> bytes\_received?: number Link to this property consumer\_id?: string Link to this property fir\_count?: number Link to this property frame\_height?: number Link to this property frame\_width?: number Link to this property frames\_decoded?: number Link to this property frames\_dropped?: number Link to this property frames\_per\_second?: number Link to this property jitter?: number Link to this property jitter\_buffer\_delay?: number Link to this property jitter\_buffer\_emitted\_count?: number Link to this property key\_frames\_decoded?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_received?: number Link to this property peer\_id?: string Link to this property producer\_id?: string Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
screenshare\_video\_consumer\_cumulative?: ScreenshareVideoConsumerCumulative {frame\_per\_second, frame\_width, issues, 4 more } Aggregated inbound (consumer) video statistics for the session.
frame\_per\_second?: FramePerSecond {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
frame\_width?: FrameWidth {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
issues?: Issues {lag\_fraction, no\_video\_fraction, poor\_resolution\_fraction } lag\_fraction?: number Link to this property no\_video\_fraction?: number Link to this property poor\_resolution\_fraction?: number Link to this property
Link to this property
jitter\_buffer\_delay?: JitterBufferDelay {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"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property key\_frames\_decoded\_fraction?: number Link to this property
packet\_loss?: PacketLoss {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"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
Link to this property
screenshare\_video\_producer?: Array<ScreenshareVideoProducer> bytes\_sent?: number Link to this property fir\_count?: number Link to this property frame\_height?: number Link to this property frame\_width?: number Link to this property frames\_encoded?: number Link to this property frames\_per\_second?: number Link to this property jitter?: number Link to this property key\_frames\_encoded?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_sent?: number Link to this property pli\_count?: number Link to this property producer\_id?: string Link to this property
quality\_limitation\_durations?: QualityLimitationDurations {bandwidth, cpu, none, other } bandwidth?: number Link to this property cpu?: number Link to this property none?: number Link to this property other?: number Link to this property
Link to this property
quality\_limitation\_reason?: "cpu"| "bandwidth"| "none"| "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?: number Link to this property rtt?: number Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
screenshare\_video\_producer\_cumulative?: ScreenshareVideoProducerCumulative {frame\_per\_second, frame\_width, high\_negative\_feedback\_fraction, 5 more } Aggregated outbound (producer) video statistics for the session.
frame\_per\_second?: FramePerSecond {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
frame\_width?: FrameWidth {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property high\_negative\_feedback\_fraction?: number Link to this property
issues?: Issues {bandwidth\_quality\_limitation\_fraction, cpu\_quality\_limitation\_fraction, no\_video\_fraction, 2 more } bandwidth\_quality\_limitation\_fraction?: number Link to this property cpu\_quality\_limitation\_fraction?: number Link to this property no\_video\_fraction?: number Link to this property poor\_resolution\_fraction?: number Link to this property quality\_limitation\_fraction?: number Link to this property
Link to this property key\_frames\_encoded\_fraction?: number Link to this property
packet\_loss?: PacketLoss {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"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
rtt?: RTT {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"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
Link to this property
video\_consumer?: Array<VideoConsumer> bytes\_received?: number Link to this property consumer\_id?: string Link to this property fir\_count?: number Link to this property frame\_height?: number Link to this property frame\_width?: number Link to this property frames\_decoded?: number Link to this property frames\_dropped?: number Link to this property frames\_per\_second?: number Link to this property jitter?: number Link to this property jitter\_buffer\_delay?: number Link to this property jitter\_buffer\_emitted\_count?: number Link to this property key\_frames\_decoded?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_received?: number Link to this property peer\_id?: string Link to this property producer\_id?: string Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
video\_consumer\_cumulative?: VideoConsumerCumulative {frame\_per\_second, frame\_width, issues, 4 more } Aggregated inbound (consumer) video statistics for the session.
frame\_per\_second?: FramePerSecond {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
frame\_width?: FrameWidth {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
issues?: Issues {lag\_fraction, no\_video\_fraction, poor\_resolution\_fraction } lag\_fraction?: number Link to this property no\_video\_fraction?: number Link to this property poor\_resolution\_fraction?: number Link to this property
Link to this property
jitter\_buffer\_delay?: JitterBufferDelay {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"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property key\_frames\_decoded\_fraction?: number Link to this property
packet\_loss?: PacketLoss {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"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
Link to this property
video\_producer?: Array<VideoProducer> bytes\_sent?: number Link to this property fir\_count?: number Link to this property frame\_height?: number Link to this property frame\_width?: number Link to this property frames\_encoded?: number Link to this property frames\_per\_second?: number Link to this property jitter?: number Link to this property key\_frames\_encoded?: number Link to this property mid?: string Link to this property mos\_quality?: number Link to this property packets\_lost?: number Link to this property packets\_sent?: number Link to this property pli\_count?: number Link to this property producer\_id?: string Link to this property
quality\_limitation\_durations?: QualityLimitationDurations {bandwidth, cpu, none, other } bandwidth?: number Link to this property cpu?: number Link to this property none?: number Link to this property other?: number Link to this property
Link to this property
quality\_limitation\_reason?: "cpu"| "bandwidth"| "none"| "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?: number Link to this property rtt?: number Link to this property ssrc?: number Link to this property timestamp?: string Link to this property
Link to this property
video\_producer\_cumulative?: VideoProducerCumulative {frame\_per\_second, frame\_width, high\_negative\_feedback\_fraction, 5 more } Aggregated outbound (producer) video statistics for the session.
frame\_per\_second?: FramePerSecond {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
frame\_width?: FrameWidth {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property high\_negative\_feedback\_fraction?: number Link to this property
issues?: Issues {bandwidth\_quality\_limitation\_fraction, cpu\_quality\_limitation\_fraction, no\_video\_fraction, 2 more } bandwidth\_quality\_limitation\_fraction?: number Link to this property cpu\_quality\_limitation\_fraction?: number Link to this property no\_video\_fraction?: number Link to this property poor\_resolution\_fraction?: number Link to this property quality\_limitation\_fraction?: number Link to this property
Link to this property key\_frames\_encoded\_fraction?: number Link to this property
packet\_loss?: PacketLoss {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"?: number Link to this property "25\_or\_greater\_event\_fraction"?: number Link to this property "5\_or\_greater\_event\_fraction"?: number Link to this property "50\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
quality\_mos?: QualityMos {avg, p50, p75, p90 } Distribution summary with average and percentiles. avg?: number Link to this property p50?: number Link to this property p75?: number Link to this property p90?: number Link to this property
Link to this property
rtt?: RTT {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"?: number Link to this property "250ms\_or\_greater\_event\_fraction"?: number Link to this property "500ms\_or\_greater\_event\_fraction"?: number Link to this property avg?: number Link to this property
Link to this property
Link to this property
Link to this property
Link to this property role?: string Name of the preset associated with the participant. Link to this property session\_id?: string formatuuid Link to this property updated\_at?: string timestamp when this participant’s data was last updated. Link to this property user\_id?: string User id for this participant. Link to this property
Link to this property
Link to this property success?: 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/typescript/resources/realtime_kit/subresources/recordings/methods/get_recordings) client.realtimeKit.recordings.getRecordings(stringappID, RecordingGetRecordingsParams {account\_id, end\_time, expired, 8 more } params, RequestOptionsoptions?): [RecordingGetRecordingsResponse]() {data, paging, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings ##### [Start recording a meeting](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/recordings/methods/start_recordings) client.realtimeKit.recordings.startRecordings(stringappID, RecordingStartRecordingsParams {account\_id, meeting\_id, allow\_multiple\_recordings, 9 more } params, RequestOptionsoptions?): [RecordingStartRecordingsResponse]() {success, data } POST/accounts/{account\_id}/realtime/kit/{app\_id}/recordings ##### [Fetch active recording](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/recordings/methods/get_active_recordings) client.realtimeKit.recordings.getActiveRecordings(stringmeetingID, RecordingGetActiveRecordingsParams {account\_id, app\_id } params, RequestOptionsoptions?): [RecordingGetActiveRecordingsResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/active-recording/{meeting\_id} ##### [Fetch details of a recording](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/recordings/methods/get_one_recording) client.realtimeKit.recordings.getOneRecording(stringrecordingID, RecordingGetOneRecordingParams {account\_id, app\_id } params, RequestOptionsoptions?): [RecordingGetOneRecordingResponse]() {success, data } GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/{recording\_id} ##### [Pause/Resume/Stop recording](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/recordings/methods/pause_resume_stop_recording) client.realtimeKit.recordings.pauseResumeStopRecording(stringrecordingID, RecordingPauseResumeStopRecordingParams {account\_id, app\_id, action } params, RequestOptionsoptions?): [RecordingPauseResumeStopRecordingResponse]() {success, data } PUT/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/{recording\_id} ##### [Start recording participant audio tracks](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/recordings/methods/start_track_recording) client.realtimeKit.recordings.startTrackRecording(stringappID, RecordingStartTrackRecordingParams {account\_id, meeting\_id, layers, user\_ids } params, RequestOptionsoptions?): [RecordingStartTrackRecordingResponse]() {success, data } POST/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/track ##### ModelsExpand Collapse
RecordingGetRecordingsResponse {data, paging, success }
data: Array<Data> id: string ID of the recording formatuuid Link to this property audio\_download\_url: string| null If the audio\_config is passed, the URL for downloading the audio recording is returned. formaturi Link to this property download\_url: string| null URL where the recording can be downloaded. formaturi Link to this property download\_url\_expiry: string| null Timestamp when the download URL expires. formatdate-time Link to this property file\_size: number| null 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| null ID of the meeting session this recording is for. formatuuid Link to this property started\_time: string| null Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time. formatdate-time Link to this property
status: "INVOKED"| "RECORDING"| "UPLOADING"| 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| null Timestamp when this recording was stopped. Optional; is present only when the recording has actually been stopped. formatdate-time Link to this property
meeting?: Meeting {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?: boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat?: boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start?: boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config?: RecordingConfig {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?: AudioConfig {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.
channel?: "mono"| "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?: "MP3"| "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