--- title: Realtime Kit --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) 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/python/resources/realtime_kit/subresources/apps/methods/get) realtime\_kit.apps.get(AppGetParams\*\*kwargs) -> [AppGetResponse]() GET/accounts/{account\_id}/realtime/kit/apps ##### [Create App](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/apps/methods/post) realtime\_kit.apps.post(AppPostParams\*\*kwargs) -> [AppPostResponse]() POST/accounts/{account\_id}/realtime/kit/apps ##### ModelsExpand Collapse
class AppGetResponse: …
data: Optional\[List\[Data]] id: Optional\[str] formatuuid Link to this property created\_at: Optional\[datetime] formatdate-time Link to this property name: Optional\[str] Link to this property
Link to this property
paging: Optional\[Paging] end\_offset: Optional\[float] Link to this property start\_offset: Optional\[float] Link to this property total\_count: Optional\[float] Link to this property
Link to this property success: Optional\[bool] Link to this property
[Link to this property](<#(resource)%20realtime_kit.apps%20%3E%20(model)%20app_get_response%20%3E%20(schema)>)
class AppPostResponse: …
data: Optional\[Data]
app: Optional\[DataApp] id: Optional\[str] formatuuid Link to this property created\_at: Optional\[datetime] formatdate-time Link to this property name: Optional\[str] Link to this property
Link to this property
Link to this property success: Optional\[bool] 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/python/resources/realtime_kit/subresources/meetings/methods/get) realtime\_kit.meetings.get(strapp\_id, MeetingGetParams\*\*kwargs) -> [MeetingGetResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings ##### [Create a meeting](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/meetings/methods/create) realtime\_kit.meetings.create(strapp\_id, MeetingCreateParams\*\*kwargs) -> [MeetingCreateResponse]() POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings ##### [Fetch a meeting for an App](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/meetings/methods/get_meeting_by_id) realtime\_kit.meetings.get\_meeting\_by\_id(strmeeting\_id, MeetingGetMeetingByIDParams\*\*kwargs) -> [MeetingGetMeetingByIDResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id} ##### [Update a meeting](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/meetings/methods/update_meeting_by_id) realtime\_kit.meetings.update\_meeting\_by\_id(strmeeting\_id, MeetingUpdateMeetingByIDParams\*\*kwargs) -> [MeetingUpdateMeetingByIDResponse]() PATCH/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id} ##### [Replace a meeting](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/meetings/methods/replace_meeting_by_id) realtime\_kit.meetings.replace\_meeting\_by\_id(strmeeting\_id, MeetingReplaceMeetingByIDParams\*\*kwargs) -> [MeetingReplaceMeetingByIDResponse]() PUT/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id} ##### [Fetch all participants of a meeting](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/meetings/methods/get_meeting_participants) realtime\_kit.meetings.get\_meeting\_participants(strmeeting\_id, MeetingGetMeetingParticipantsParams\*\*kwargs) -> [MeetingGetMeetingParticipantsResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants ##### [Add a participant](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/meetings/methods/add_participant) realtime\_kit.meetings.add\_participant(strmeeting\_id, MeetingAddParticipantParams\*\*kwargs) -> [MeetingAddParticipantResponse]() POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants ##### [Fetch a participant's detail](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/meetings/methods/get_meeting_participant) realtime\_kit.meetings.get\_meeting\_participant(strparticipant\_id, MeetingGetMeetingParticipantParams\*\*kwargs) -> [MeetingGetMeetingParticipantResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id} ##### [Edit a participant's detail](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/meetings/methods/edit_participant) realtime\_kit.meetings.edit\_participant(strparticipant\_id, MeetingEditParticipantParams\*\*kwargs) -> [MeetingEditParticipantResponse]() PATCH/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id} ##### [Delete a participant](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/meetings/methods/delete_meeting_participant) realtime\_kit.meetings.delete\_meeting\_participant(strparticipant\_id, MeetingDeleteMeetingParticipantParams\*\*kwargs) -> [MeetingDeleteMeetingParticipantResponse]() DELETE/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id} ##### [Refresh participant's authentication token](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/meetings/methods/refresh_participant_token) realtime\_kit.meetings.refresh\_participant\_token(strparticipant\_id, MeetingRefreshParticipantTokenParams\*\*kwargs) -> [MeetingRefreshParticipantTokenResponse]() POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id}/token ##### ModelsExpand Collapse
class MeetingGetResponse: …
data: List\[Data] id: str ID of the meeting. formatuuid Link to this property created\_at: datetime Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: datetime Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property live\_stream\_on\_start: Optional\[bool] Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat: Optional\[bool] Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start: Optional\[bool] Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config: Optional\[DataRecordingConfig] Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
audio\_config: Optional\[DataRecordingConfigAudioConfig] Object containing configuration regarding the audio that is being recorded.
channel: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[bool] Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix: Optional\[str] Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config: Optional\[DataRecordingConfigLiveStreamingConfig] rtmp\_url: Optional\[str] RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds: Optional\[float] Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property
realtimekit\_bucket\_config: Optional\[DataRecordingConfigRealtimekitBucketConfig] enabled: bool Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property
Link to this property
storage\_config: Optional\[DataRecordingConfigStorageConfig] One of the following:
class DataRecordingConfigStorageConfigUnionMember0: … access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: Optional\[Literal\["gcs"]] Link to this property username: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember1: … access\_key: object minLength1 Link to this property region: object minLength1 Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember2: … private\_key: str Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: Optional\[Literal\["KEY"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember3: … password: str SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: Optional\[Literal\["PASSWORD"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config: Optional\[DataRecordingConfigVideoConfig]
codec: Optional\[Literal\["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: Optional\[bool] Controls whether to export video file seperately Link to this property height: Optional\[int] Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark: Optional\[DataRecordingConfigVideoConfigWatermark] Watermark to be added to the recording
position: Optional\[Literal\["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: Optional\[DataRecordingConfigVideoConfigWatermarkSize] Size of the watermark height: Optional\[int] Height of the watermark in px minimum1 Link to this property width: Optional\[int] Width of the watermark in px minimum1 Link to this property
Link to this property url: Optional\[str] URL of the watermark image formaturi Link to this property
Link to this property width: Optional\[int] Width of the recording video in pixels maximum1920 minimum1 Link to this property
Link to this property
Link to this property session\_keep\_alive\_time\_in\_secs: Optional\[float] Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property
status: Optional\[Literal\["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: Optional\[bool] Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title: Optional\[str] Title of the meeting. Link to this property transcribe\_on\_end: Optional\[bool] Automatically generate transcripts when the meeting ends. Link to this property
Link to this property
paging: Paging end\_offset: float Link to this property start\_offset: float Link to this property total\_count: float minimum0 Link to this property
Link to this property success: bool Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_get_response%20%3E%20(schema)>)
class MeetingCreateResponse: … success: bool Success status of the operation Link to this property
data: Optional\[Data] Data returned by the operation id: str ID of the meeting. formatuuid Link to this property created\_at: datetime Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: datetime Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property
ai\_config: Optional\[DataAIConfig] The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization: Optional\[DataAIConfigSummarization] Summary Config
summary\_type: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[int] Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property
Link to this property
transcription: Optional\[DataAIConfigTranscription] Transcription Configurations keywords: Optional\[List\[str]] Adds specific terms to improve accurate detection during transcription. Link to this property
language: Optional\[Literal\["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: Optional\[bool] Control the inclusion of offensive language in transcriptions. Link to this property
Link to this property
Link to this property live\_stream\_on\_start: Optional\[bool] Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat: Optional\[bool] Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start: Optional\[bool] Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config: Optional\[DataRecordingConfig] Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
audio\_config: Optional\[DataRecordingConfigAudioConfig] Object containing configuration regarding the audio that is being recorded.
channel: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[bool] Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix: Optional\[str] Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config: Optional\[DataRecordingConfigLiveStreamingConfig] rtmp\_url: Optional\[str] RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds: Optional\[float] Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property
realtimekit\_bucket\_config: Optional\[DataRecordingConfigRealtimekitBucketConfig] enabled: bool Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property
Link to this property
storage\_config: Optional\[DataRecordingConfigStorageConfig] One of the following:
class DataRecordingConfigStorageConfigUnionMember0: … access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: Optional\[Literal\["gcs"]] Link to this property username: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember1: … access\_key: object minLength1 Link to this property region: object minLength1 Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember2: … private\_key: str Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: Optional\[Literal\["KEY"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember3: … password: str SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: Optional\[Literal\["PASSWORD"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config: Optional\[DataRecordingConfigVideoConfig]
codec: Optional\[Literal\["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: Optional\[bool] Controls whether to export video file seperately Link to this property height: Optional\[int] Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark: Optional\[DataRecordingConfigVideoConfigWatermark] Watermark to be added to the recording
position: Optional\[Literal\["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: Optional\[DataRecordingConfigVideoConfigWatermarkSize] Size of the watermark height: Optional\[int] Height of the watermark in px minimum1 Link to this property width: Optional\[int] Width of the watermark in px minimum1 Link to this property
Link to this property url: Optional\[str] URL of the watermark image formaturi Link to this property
Link to this property width: Optional\[int] Width of the recording video in pixels maximum1920 minimum1 Link to this property
Link to this property
Link to this property session\_keep\_alive\_time\_in\_secs: Optional\[float] Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property
status: Optional\[Literal\["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: Optional\[bool] Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title: Optional\[str] Title of the meeting. Link to this property transcribe\_on\_end: Optional\[bool] 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)>)
class MeetingGetMeetingByIDResponse: … success: bool Success status of the operation Link to this property
data: Optional\[Data] Data returned by the operation id: str ID of the meeting. formatuuid Link to this property created\_at: datetime Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: datetime Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property
ai\_config: Optional\[DataAIConfig] The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization: Optional\[DataAIConfigSummarization] Summary Config
summary\_type: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[int] Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property
Link to this property
transcription: Optional\[DataAIConfigTranscription] Transcription Configurations keywords: Optional\[List\[str]] Adds specific terms to improve accurate detection during transcription. Link to this property
language: Optional\[Literal\["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: Optional\[bool] Control the inclusion of offensive language in transcriptions. Link to this property
Link to this property
Link to this property live\_stream\_on\_start: Optional\[bool] Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat: Optional\[bool] Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start: Optional\[bool] Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config: Optional\[DataRecordingConfig] Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
audio\_config: Optional\[DataRecordingConfigAudioConfig] Object containing configuration regarding the audio that is being recorded.
channel: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[bool] Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix: Optional\[str] Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config: Optional\[DataRecordingConfigLiveStreamingConfig] rtmp\_url: Optional\[str] RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds: Optional\[float] Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property
realtimekit\_bucket\_config: Optional\[DataRecordingConfigRealtimekitBucketConfig] enabled: bool Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property
Link to this property
storage\_config: Optional\[DataRecordingConfigStorageConfig] One of the following:
class DataRecordingConfigStorageConfigUnionMember0: … access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: Optional\[Literal\["gcs"]] Link to this property username: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember1: … access\_key: object minLength1 Link to this property region: object minLength1 Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember2: … private\_key: str Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: Optional\[Literal\["KEY"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember3: … password: str SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: Optional\[Literal\["PASSWORD"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config: Optional\[DataRecordingConfigVideoConfig]
codec: Optional\[Literal\["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: Optional\[bool] Controls whether to export video file seperately Link to this property height: Optional\[int] Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark: Optional\[DataRecordingConfigVideoConfigWatermark] Watermark to be added to the recording
position: Optional\[Literal\["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: Optional\[DataRecordingConfigVideoConfigWatermarkSize] Size of the watermark height: Optional\[int] Height of the watermark in px minimum1 Link to this property width: Optional\[int] Width of the watermark in px minimum1 Link to this property
Link to this property url: Optional\[str] URL of the watermark image formaturi Link to this property
Link to this property width: Optional\[int] Width of the recording video in pixels maximum1920 minimum1 Link to this property
Link to this property
Link to this property session\_keep\_alive\_time\_in\_secs: Optional\[float] Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property
status: Optional\[Literal\["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: Optional\[bool] Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title: Optional\[str] Title of the meeting. Link to this property transcribe\_on\_end: Optional\[bool] 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)>)
class MeetingUpdateMeetingByIDResponse: … success: bool Success status of the operation Link to this property
data: Optional\[Data] Data returned by the operation id: str ID of the meeting. formatuuid Link to this property created\_at: datetime Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: datetime Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property
ai\_config: Optional\[DataAIConfig] The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization: Optional\[DataAIConfigSummarization] Summary Config
summary\_type: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[int] Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property
Link to this property
transcription: Optional\[DataAIConfigTranscription] Transcription Configurations keywords: Optional\[List\[str]] Adds specific terms to improve accurate detection during transcription. Link to this property
language: Optional\[Literal\["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: Optional\[bool] Control the inclusion of offensive language in transcriptions. Link to this property
Link to this property
Link to this property live\_stream\_on\_start: Optional\[bool] Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat: Optional\[bool] Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start: Optional\[bool] Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config: Optional\[DataRecordingConfig] Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
audio\_config: Optional\[DataRecordingConfigAudioConfig] Object containing configuration regarding the audio that is being recorded.
channel: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[bool] Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix: Optional\[str] Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config: Optional\[DataRecordingConfigLiveStreamingConfig] rtmp\_url: Optional\[str] RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds: Optional\[float] Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property
realtimekit\_bucket\_config: Optional\[DataRecordingConfigRealtimekitBucketConfig] enabled: bool Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property
Link to this property
storage\_config: Optional\[DataRecordingConfigStorageConfig] One of the following:
class DataRecordingConfigStorageConfigUnionMember0: … access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: Optional\[Literal\["gcs"]] Link to this property username: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember1: … access\_key: object minLength1 Link to this property region: object minLength1 Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember2: … private\_key: str Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: Optional\[Literal\["KEY"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember3: … password: str SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: Optional\[Literal\["PASSWORD"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config: Optional\[DataRecordingConfigVideoConfig]
codec: Optional\[Literal\["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: Optional\[bool] Controls whether to export video file seperately Link to this property height: Optional\[int] Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark: Optional\[DataRecordingConfigVideoConfigWatermark] Watermark to be added to the recording
position: Optional\[Literal\["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: Optional\[DataRecordingConfigVideoConfigWatermarkSize] Size of the watermark height: Optional\[int] Height of the watermark in px minimum1 Link to this property width: Optional\[int] Width of the watermark in px minimum1 Link to this property
Link to this property url: Optional\[str] URL of the watermark image formaturi Link to this property
Link to this property width: Optional\[int] Width of the recording video in pixels maximum1920 minimum1 Link to this property
Link to this property
Link to this property session\_keep\_alive\_time\_in\_secs: Optional\[float] Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property
status: Optional\[Literal\["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: Optional\[bool] Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title: Optional\[str] Title of the meeting. Link to this property transcribe\_on\_end: Optional\[bool] 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)>)
class MeetingReplaceMeetingByIDResponse: … success: bool Success status of the operation Link to this property
data: Optional\[Data] Data returned by the operation id: str ID of the meeting. formatuuid Link to this property created\_at: datetime Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: datetime Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property
ai\_config: Optional\[DataAIConfig] The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization: Optional\[DataAIConfigSummarization] Summary Config
summary\_type: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[int] Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property
Link to this property
transcription: Optional\[DataAIConfigTranscription] Transcription Configurations keywords: Optional\[List\[str]] Adds specific terms to improve accurate detection during transcription. Link to this property
language: Optional\[Literal\["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: Optional\[bool] Control the inclusion of offensive language in transcriptions. Link to this property
Link to this property
Link to this property live\_stream\_on\_start: Optional\[bool] Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat: Optional\[bool] Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start: Optional\[bool] Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config: Optional\[DataRecordingConfig] Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
audio\_config: Optional\[DataRecordingConfigAudioConfig] Object containing configuration regarding the audio that is being recorded.
channel: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[bool] Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix: Optional\[str] Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config: Optional\[DataRecordingConfigLiveStreamingConfig] rtmp\_url: Optional\[str] RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds: Optional\[float] Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property
realtimekit\_bucket\_config: Optional\[DataRecordingConfigRealtimekitBucketConfig] enabled: bool Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property
Link to this property
storage\_config: Optional\[DataRecordingConfigStorageConfig] One of the following:
class DataRecordingConfigStorageConfigUnionMember0: … access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: Optional\[Literal\["gcs"]] Link to this property username: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember1: … access\_key: object minLength1 Link to this property region: object minLength1 Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember2: … private\_key: str Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: Optional\[Literal\["KEY"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataRecordingConfigStorageConfigUnionMember3: … password: str SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: Optional\[Literal\["PASSWORD"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config: Optional\[DataRecordingConfigVideoConfig]
codec: Optional\[Literal\["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: Optional\[bool] Controls whether to export video file seperately Link to this property height: Optional\[int] Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark: Optional\[DataRecordingConfigVideoConfigWatermark] Watermark to be added to the recording
position: Optional\[Literal\["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: Optional\[DataRecordingConfigVideoConfigWatermarkSize] Size of the watermark height: Optional\[int] Height of the watermark in px minimum1 Link to this property width: Optional\[int] Width of the watermark in px minimum1 Link to this property
Link to this property url: Optional\[str] URL of the watermark image formaturi Link to this property
Link to this property width: Optional\[int] Width of the recording video in pixels maximum1920 minimum1 Link to this property
Link to this property
Link to this property session\_keep\_alive\_time\_in\_secs: Optional\[float] Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property
status: Optional\[Literal\["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: Optional\[bool] Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title: Optional\[str] Title of the meeting. Link to this property transcribe\_on\_end: Optional\[bool] 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)>)
class MeetingGetMeetingParticipantsResponse: …
data: List\[Data] id: str ID of the participant. formatuuid Link to this property created\_at: datetime When this object was created. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: str A unique participant ID generated by the client. Link to this property preset\_name: str Preset applied to the participant. Link to this property updated\_at: datetime When this object was updated. The time is returned in ISO format. formatdate-time Link to this property name: Optional\[str] Name of the participant. Link to this property picture: Optional\[str] URL to a picture of the participant. formaturi Link to this property
Link to this property
paging: Paging end\_offset: float Link to this property start\_offset: float Link to this property total\_count: float minimum0 Link to this property
Link to this property success: bool 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)>)
class MeetingAddParticipantResponse: … success: bool Success status of the operation Link to this property
data: Optional\[Data] Represents a participant. id: str ID of the participant. formatuuid Link to this property token: str The participant’s auth token that can be used for joining a meeting from the client side. Link to this property created\_at: datetime When this object was created. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: str A unique participant ID generated by the client. Link to this property preset\_name: str Preset applied to the participant. Link to this property updated\_at: datetime When this object was updated. The time is returned in ISO format. formatdate-time Link to this property name: Optional\[str] Name of the participant. Link to this property picture: Optional\[str] 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)>)
class MeetingGetMeetingParticipantResponse: …
data: Data Data returned by the operation id: str ID of the participant. formatuuid Link to this property created\_at: datetime When this object was created. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: str A unique participant ID generated by the client. Link to this property preset\_name: str Preset applied to the participant. Link to this property updated\_at: datetime When this object was updated. The time is returned in ISO format. formatdate-time Link to this property name: Optional\[str] Name of the participant. Link to this property picture: Optional\[str] URL to a picture of the participant. formaturi Link to this property
Link to this property success: bool Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_get_meeting_participant_response%20%3E%20(schema)>)
class MeetingEditParticipantResponse: … success: bool Success status of the operation Link to this property
data: Optional\[Data] Represents a participant. id: str ID of the participant. formatuuid Link to this property token: str The participant’s auth token that can be used for joining a meeting from the client side. Link to this property created\_at: datetime When this object was created. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: str A unique participant ID generated by the client. Link to this property preset\_name: str Preset applied to the participant. Link to this property updated\_at: datetime When this object was updated. The time is returned in ISO format. formatdate-time Link to this property name: Optional\[str] Name of the participant. Link to this property picture: Optional\[str] 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)>)
class MeetingDeleteMeetingParticipantResponse: … success: bool Success status of the operation Link to this property
data: Optional\[Data] Data returned by the operation created\_at: datetime Timestamp this object was created at. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: str A unique participant ID generated by the client. Link to this property preset\_id: str ID of the preset applied to this participant. formatuuid Link to this property updated\_at: datetime 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)>)
class MeetingRefreshParticipantTokenResponse: …
data: Data Data returned by the operation token: str Regenerated participant’s authentication token. Link to this property
Link to this property success: bool Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_refresh_participant_token_response%20%3E%20(schema)>) #### Realtime KitPresets ##### [Fetch all presets](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/presets/methods/get) realtime\_kit.presets.get(strapp\_id, PresetGetParams\*\*kwargs) -> [PresetGetResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/presets ##### [Create a preset](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/presets/methods/create) realtime\_kit.presets.create(strapp\_id, PresetCreateParams\*\*kwargs) -> [PresetCreateResponse]() POST/accounts/{account\_id}/realtime/kit/{app\_id}/presets ##### [Fetch details of a preset](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/presets/methods/get_preset_by_id) realtime\_kit.presets.get\_preset\_by\_id(strpreset\_id, PresetGetPresetByIDParams\*\*kwargs) -> [PresetGetPresetByIDResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### [Delete a preset](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/presets/methods/delete) realtime\_kit.presets.delete(strpreset\_id, PresetDeleteParams\*\*kwargs) -> [PresetDeleteResponse]() DELETE/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### [Update a preset](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/presets/methods/update) realtime\_kit.presets.update(strpreset\_id, PresetUpdateParams\*\*kwargs) -> [PresetUpdateResponse]() PATCH/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### [Replace a preset](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/presets/methods/replace_preset_by_id) realtime\_kit.presets.replace\_preset\_by\_id(strpreset\_id, PresetReplacePresetByIDParams\*\*kwargs) -> [PresetReplacePresetByIDResponse]() PUT/accounts/{account\_id}/realtime/kit/{app\_id}/presets/{preset\_id} ##### ModelsExpand Collapse
class PresetGetResponse: …
data: List\[Data] id: Optional\[str] ID of the preset formatuuid Link to this property created\_at: Optional\[datetime] Timestamp this preset was created at formatdate-time Link to this property name: Optional\[str] Name of the preset Link to this property updated\_at: Optional\[datetime] Timestamp this preset was last updated formatdate-time Link to this property
Link to this property
paging: Paging end\_offset: float Link to this property start\_offset: float Link to this property total\_count: float minimum0 Link to this property
Link to this property success: bool Link to this property
[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_get_response%20%3E%20(schema)>)
class PresetCreateResponse: …
data: Data Data returned by the operation id: str ID of the preset formatuuid Link to this property
config: DataConfig max\_screenshare\_count: float Maximum number of screen shares that can be active at a given time Link to this property
max\_video\_streams: DataConfigMaxVideoStreams Maximum number of streams that are visible on a device desktop: float Maximum number of video streams visible on desktop devices Link to this property mobile: float Maximum number of streams visible on mobile devices Link to this property
Link to this property
media: DataConfigMedia Media configuration options. eg: Video quality
screenshare: DataConfigMediaScreenshare Configuration options for participant screen shares frame\_rate: float Frame rate of screen share Link to this property
quality: Literal\["hd", "vga", "qvga", 2 more] Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: DataConfigMediaVideo Configuration options for participant videos frame\_rate: float Frame rate of participants’ video maximum30 Link to this property
quality: Literal\["hd", "vga", "qvga", 2 more] Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast: Optional\[bool] Enable simulcast for participant videos. Link to this property
Link to this property
audio: Optional\[DataConfigMediaAudio] Control options for Audio quality. enable\_high\_bitrate: Optional\[bool] Enable High Quality Audio for your meetings Link to this property enable\_stereo: Optional\[bool] Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: Literal\["GROUP\_CALL", "WEBINAR", "AUDIO\_ROOM", "LIVESTREAM"] Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities: Optional\[List\[int]] Livestream viewer quality levels. Link to this property
Link to this property created\_at: datetime Timestamp this preset was created at formatdate-time Link to this property name: str Name of the preset Link to this property
permissions: DataPermissions accept\_waiting\_requests: bool Whether this participant can accept waiting requests Link to this property can\_accept\_production\_requests: bool Link to this property can\_change\_participant\_permissions: bool Link to this property can\_edit\_display\_name: bool Link to this property can\_livestream: bool Link to this property can\_record: bool Link to this property can\_spotlight: bool Link to this property
chat: DataPermissionsChat
private: DataPermissionsChatPrivate can\_receive: bool Link to this property can\_send: bool Link to this property files: bool Link to this property text: bool Link to this property
Link to this property
public: DataPermissionsChatPublic can\_send: bool Can send messages in general Link to this property files: bool Can send file messages Link to this property text: bool Can send text messages Link to this property
Link to this property
Link to this property
connected\_meetings: DataPermissionsConnectedMeetings can\_alter\_connected\_meetings: bool Link to this property can\_switch\_connected\_meetings: bool Link to this property can\_switch\_to\_parent\_meeting: bool Link to this property
Link to this property disable\_participant\_audio: bool Link to this property disable\_participant\_screensharing: bool Link to this property disable\_participant\_video: bool Link to this property hidden\_participant: bool Whether this participant is visible to others or not Link to this property kick\_participant: bool Link to this property
media: DataPermissionsMedia Media permissions
audio: DataPermissionsMediaAudio Audio permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: DataPermissionsMediaScreenshare Screenshare permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: DataPermissionsMediaVideo Video permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: bool Link to this property
plugins: DataPermissionsPlugins Plugin permissions can\_close: bool Can close plugins that are already open Link to this property can\_edit\_config: bool Can edit plugin config Link to this property can\_start: bool Can start plugins Link to this property
config: Dict\[str, DataPermissionsPluginsConfig] Plugin configuration keyed by plugin UUID.
access\_control: Optional\[Literal\["FULL\_ACCESS", "VIEW\_ONLY"]] One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only: Optional\[bool] Link to this property
Link to this property
Link to this property
polls: DataPermissionsPolls Poll permissions can\_create: bool Can create polls Link to this property can\_view: bool Can view polls Link to this property can\_vote: bool Can vote on polls Link to this property
Link to this property
recorder\_type: Literal\["RECORDER", "LIVESTREAMER", "NONE"] Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: bool Link to this property
waiting\_room\_type: Literal\["SKIP", "ON\_PRIVILEGED\_USER\_ENTRY", "SKIP\_ON\_ACCEPT"] Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests: Optional\[bool] Link to this property is\_recorder: Optional\[bool] Link to this property
stage\_access: Optional\[Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"]] One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled: Optional\[bool] Link to this property transcription\_enabled: Optional\[bool] Link to this property
Link to this property
ui: DataUI
design\_tokens: DataUIDesignTokens
border\_radius: Literal\["sharp", "rounded", "extra-rounded", "circular"] One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: Literal\["none", "thin", "fat"] One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: DataUIDesignTokensColors
background: DataUIDesignTokensColorsBackground \_1000: str Link to this property \_600: str Link to this property \_700: str Link to this property \_800: str Link to this property \_900: str Link to this property
Link to this property
brand: DataUIDesignTokensColorsBrand \_300: str Link to this property \_400: str Link to this property \_500: str Link to this property \_600: str Link to this property \_700: str Link to this property
Link to this property danger: str Link to this property success: str Link to this property text: str Link to this property text\_on\_brand: str Link to this property video\_bg: str Link to this property warning: str Link to this property
Link to this property spacing\_base: float minimum1 Link to this property
theme: Literal\["darkest", "dark", "light"] One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family: Optional\[str] Link to this property google\_font: Optional\[str] Link to this property logo: Optional\[str] formaturi Link to this property
Link to this property
Link to this property updated\_at: datetime Timestamp this preset was last updated formatdate-time Link to this property
Link to this property success: bool Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_create_response%20%3E%20(schema)>)
class PresetGetPresetByIDResponse: …
data: Data Data returned by the operation id: str ID of the preset formatuuid Link to this property
config: DataConfig max\_screenshare\_count: float Maximum number of screen shares that can be active at a given time Link to this property
max\_video\_streams: DataConfigMaxVideoStreams Maximum number of streams that are visible on a device desktop: float Maximum number of video streams visible on desktop devices Link to this property mobile: float Maximum number of streams visible on mobile devices Link to this property
Link to this property
media: DataConfigMedia Media configuration options. eg: Video quality
screenshare: DataConfigMediaScreenshare Configuration options for participant screen shares frame\_rate: float Frame rate of screen share Link to this property
quality: Literal\["hd", "vga", "qvga", 2 more] Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: DataConfigMediaVideo Configuration options for participant videos frame\_rate: float Frame rate of participants’ video maximum30 Link to this property
quality: Literal\["hd", "vga", "qvga", 2 more] Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast: Optional\[bool] Enable simulcast for participant videos. Link to this property
Link to this property
audio: Optional\[DataConfigMediaAudio] Control options for Audio quality. enable\_high\_bitrate: Optional\[bool] Enable High Quality Audio for your meetings Link to this property enable\_stereo: Optional\[bool] Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: Literal\["GROUP\_CALL", "WEBINAR", "AUDIO\_ROOM", "LIVESTREAM"] Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities: Optional\[List\[int]] Livestream viewer quality levels. Link to this property
Link to this property created\_at: datetime Timestamp this preset was created at formatdate-time Link to this property name: str Name of the preset Link to this property
permissions: DataPermissions accept\_waiting\_requests: bool Whether this participant can accept waiting requests Link to this property can\_accept\_production\_requests: bool Link to this property can\_change\_participant\_permissions: bool Link to this property can\_edit\_display\_name: bool Link to this property can\_livestream: bool Link to this property can\_record: bool Link to this property can\_spotlight: bool Link to this property
chat: DataPermissionsChat
private: DataPermissionsChatPrivate can\_receive: bool Link to this property can\_send: bool Link to this property files: bool Link to this property text: bool Link to this property
Link to this property
public: DataPermissionsChatPublic can\_send: bool Can send messages in general Link to this property files: bool Can send file messages Link to this property text: bool Can send text messages Link to this property
Link to this property
Link to this property
connected\_meetings: DataPermissionsConnectedMeetings can\_alter\_connected\_meetings: bool Link to this property can\_switch\_connected\_meetings: bool Link to this property can\_switch\_to\_parent\_meeting: bool Link to this property
Link to this property disable\_participant\_audio: bool Link to this property disable\_participant\_screensharing: bool Link to this property disable\_participant\_video: bool Link to this property hidden\_participant: bool Whether this participant is visible to others or not Link to this property kick\_participant: bool Link to this property
media: DataPermissionsMedia Media permissions
audio: DataPermissionsMediaAudio Audio permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: DataPermissionsMediaScreenshare Screenshare permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: DataPermissionsMediaVideo Video permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: bool Link to this property
plugins: DataPermissionsPlugins Plugin permissions can\_close: bool Can close plugins that are already open Link to this property can\_edit\_config: bool Can edit plugin config Link to this property can\_start: bool Can start plugins Link to this property
config: Dict\[str, DataPermissionsPluginsConfig] Plugin configuration keyed by plugin UUID.
access\_control: Optional\[Literal\["FULL\_ACCESS", "VIEW\_ONLY"]] One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only: Optional\[bool] Link to this property
Link to this property
Link to this property
polls: DataPermissionsPolls Poll permissions can\_create: bool Can create polls Link to this property can\_view: bool Can view polls Link to this property can\_vote: bool Can vote on polls Link to this property
Link to this property
recorder\_type: Literal\["RECORDER", "LIVESTREAMER", "NONE"] Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: bool Link to this property
waiting\_room\_type: Literal\["SKIP", "ON\_PRIVILEGED\_USER\_ENTRY", "SKIP\_ON\_ACCEPT"] Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests: Optional\[bool] Link to this property is\_recorder: Optional\[bool] Link to this property
stage\_access: Optional\[Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"]] One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled: Optional\[bool] Link to this property transcription\_enabled: Optional\[bool] Link to this property
Link to this property
ui: DataUI
design\_tokens: DataUIDesignTokens
border\_radius: Literal\["sharp", "rounded", "extra-rounded", "circular"] One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: Literal\["none", "thin", "fat"] One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: DataUIDesignTokensColors
background: DataUIDesignTokensColorsBackground \_1000: str Link to this property \_600: str Link to this property \_700: str Link to this property \_800: str Link to this property \_900: str Link to this property
Link to this property
brand: DataUIDesignTokensColorsBrand \_300: str Link to this property \_400: str Link to this property \_500: str Link to this property \_600: str Link to this property \_700: str Link to this property
Link to this property danger: str Link to this property success: str Link to this property text: str Link to this property text\_on\_brand: str Link to this property video\_bg: str Link to this property warning: str Link to this property
Link to this property spacing\_base: float minimum1 Link to this property
theme: Literal\["darkest", "dark", "light"] One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family: Optional\[str] Link to this property google\_font: Optional\[str] Link to this property logo: Optional\[str] formaturi Link to this property
Link to this property
Link to this property updated\_at: datetime Timestamp this preset was last updated formatdate-time Link to this property
Link to this property success: bool Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_get_preset_by_id_response%20%3E%20(schema)>)
class PresetDeleteResponse: …
data: Data Data returned by the operation id: str ID of the preset formatuuid Link to this property
config: DataConfig max\_screenshare\_count: float Maximum number of screen shares that can be active at a given time Link to this property
max\_video\_streams: DataConfigMaxVideoStreams Maximum number of streams that are visible on a device desktop: float Maximum number of video streams visible on desktop devices Link to this property mobile: float Maximum number of streams visible on mobile devices Link to this property
Link to this property
media: DataConfigMedia Media configuration options. eg: Video quality
screenshare: DataConfigMediaScreenshare Configuration options for participant screen shares frame\_rate: float Frame rate of screen share Link to this property
quality: Literal\["hd", "vga", "qvga", 2 more] Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: DataConfigMediaVideo Configuration options for participant videos frame\_rate: float Frame rate of participants’ video maximum30 Link to this property
quality: Literal\["hd", "vga", "qvga", 2 more] Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast: Optional\[bool] Enable simulcast for participant videos. Link to this property
Link to this property
audio: Optional\[DataConfigMediaAudio] Control options for Audio quality. enable\_high\_bitrate: Optional\[bool] Enable High Quality Audio for your meetings Link to this property enable\_stereo: Optional\[bool] Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: Literal\["GROUP\_CALL", "WEBINAR", "AUDIO\_ROOM", "LIVESTREAM"] Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities: Optional\[List\[int]] Livestream viewer quality levels. Link to this property
Link to this property created\_at: datetime Timestamp this preset was created at formatdate-time Link to this property name: str Name of the preset Link to this property
permissions: DataPermissions accept\_waiting\_requests: bool Whether this participant can accept waiting requests Link to this property can\_accept\_production\_requests: bool Link to this property can\_change\_participant\_permissions: bool Link to this property can\_edit\_display\_name: bool Link to this property can\_livestream: bool Link to this property can\_record: bool Link to this property can\_spotlight: bool Link to this property
chat: DataPermissionsChat
private: DataPermissionsChatPrivate can\_receive: bool Link to this property can\_send: bool Link to this property files: bool Link to this property text: bool Link to this property
Link to this property
public: DataPermissionsChatPublic can\_send: bool Can send messages in general Link to this property files: bool Can send file messages Link to this property text: bool Can send text messages Link to this property
Link to this property
Link to this property
connected\_meetings: DataPermissionsConnectedMeetings can\_alter\_connected\_meetings: bool Link to this property can\_switch\_connected\_meetings: bool Link to this property can\_switch\_to\_parent\_meeting: bool Link to this property
Link to this property disable\_participant\_audio: bool Link to this property disable\_participant\_screensharing: bool Link to this property disable\_participant\_video: bool Link to this property hidden\_participant: bool Whether this participant is visible to others or not Link to this property kick\_participant: bool Link to this property
media: DataPermissionsMedia Media permissions
audio: DataPermissionsMediaAudio Audio permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: DataPermissionsMediaScreenshare Screenshare permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: DataPermissionsMediaVideo Video permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: bool Link to this property
plugins: DataPermissionsPlugins Plugin permissions can\_close: bool Can close plugins that are already open Link to this property can\_edit\_config: bool Can edit plugin config Link to this property can\_start: bool Can start plugins Link to this property
config: Dict\[str, DataPermissionsPluginsConfig] Plugin configuration keyed by plugin UUID.
access\_control: Optional\[Literal\["FULL\_ACCESS", "VIEW\_ONLY"]] One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only: Optional\[bool] Link to this property
Link to this property
Link to this property
polls: DataPermissionsPolls Poll permissions can\_create: bool Can create polls Link to this property can\_view: bool Can view polls Link to this property can\_vote: bool Can vote on polls Link to this property
Link to this property
recorder\_type: Literal\["RECORDER", "LIVESTREAMER", "NONE"] Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: bool Link to this property
waiting\_room\_type: Literal\["SKIP", "ON\_PRIVILEGED\_USER\_ENTRY", "SKIP\_ON\_ACCEPT"] Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests: Optional\[bool] Link to this property is\_recorder: Optional\[bool] Link to this property
stage\_access: Optional\[Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"]] One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled: Optional\[bool] Link to this property transcription\_enabled: Optional\[bool] Link to this property
Link to this property
ui: DataUI
design\_tokens: DataUIDesignTokens
border\_radius: Literal\["sharp", "rounded", "extra-rounded", "circular"] One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: Literal\["none", "thin", "fat"] One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: DataUIDesignTokensColors
background: DataUIDesignTokensColorsBackground \_1000: str Link to this property \_600: str Link to this property \_700: str Link to this property \_800: str Link to this property \_900: str Link to this property
Link to this property
brand: DataUIDesignTokensColorsBrand \_300: str Link to this property \_400: str Link to this property \_500: str Link to this property \_600: str Link to this property \_700: str Link to this property
Link to this property danger: str Link to this property success: str Link to this property text: str Link to this property text\_on\_brand: str Link to this property video\_bg: str Link to this property warning: str Link to this property
Link to this property spacing\_base: float minimum1 Link to this property
theme: Literal\["darkest", "dark", "light"] One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family: Optional\[str] Link to this property google\_font: Optional\[str] Link to this property logo: Optional\[str] formaturi Link to this property
Link to this property
Link to this property updated\_at: datetime Timestamp this preset was last updated formatdate-time Link to this property
Link to this property success: bool Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_delete_response%20%3E%20(schema)>)
class PresetUpdateResponse: …
data: Data Data returned by the operation id: str ID of the preset formatuuid Link to this property
config: DataConfig max\_screenshare\_count: float Maximum number of screen shares that can be active at a given time Link to this property
max\_video\_streams: DataConfigMaxVideoStreams Maximum number of streams that are visible on a device desktop: float Maximum number of video streams visible on desktop devices Link to this property mobile: float Maximum number of streams visible on mobile devices Link to this property
Link to this property
media: DataConfigMedia Media configuration options. eg: Video quality
screenshare: DataConfigMediaScreenshare Configuration options for participant screen shares frame\_rate: float Frame rate of screen share Link to this property
quality: Literal\["hd", "vga", "qvga", 2 more] Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: DataConfigMediaVideo Configuration options for participant videos frame\_rate: float Frame rate of participants’ video maximum30 Link to this property
quality: Literal\["hd", "vga", "qvga", 2 more] Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast: Optional\[bool] Enable simulcast for participant videos. Link to this property
Link to this property
audio: Optional\[DataConfigMediaAudio] Control options for Audio quality. enable\_high\_bitrate: Optional\[bool] Enable High Quality Audio for your meetings Link to this property enable\_stereo: Optional\[bool] Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: Literal\["GROUP\_CALL", "WEBINAR", "AUDIO\_ROOM", "LIVESTREAM"] Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities: Optional\[List\[int]] Livestream viewer quality levels. Link to this property
Link to this property created\_at: datetime Timestamp this preset was created at formatdate-time Link to this property name: str Name of the preset Link to this property
permissions: DataPermissions accept\_waiting\_requests: bool Whether this participant can accept waiting requests Link to this property can\_accept\_production\_requests: bool Link to this property can\_change\_participant\_permissions: bool Link to this property can\_edit\_display\_name: bool Link to this property can\_livestream: bool Link to this property can\_record: bool Link to this property can\_spotlight: bool Link to this property
chat: DataPermissionsChat
private: DataPermissionsChatPrivate can\_receive: bool Link to this property can\_send: bool Link to this property files: bool Link to this property text: bool Link to this property
Link to this property
public: DataPermissionsChatPublic can\_send: bool Can send messages in general Link to this property files: bool Can send file messages Link to this property text: bool Can send text messages Link to this property
Link to this property
Link to this property
connected\_meetings: DataPermissionsConnectedMeetings can\_alter\_connected\_meetings: bool Link to this property can\_switch\_connected\_meetings: bool Link to this property can\_switch\_to\_parent\_meeting: bool Link to this property
Link to this property disable\_participant\_audio: bool Link to this property disable\_participant\_screensharing: bool Link to this property disable\_participant\_video: bool Link to this property hidden\_participant: bool Whether this participant is visible to others or not Link to this property kick\_participant: bool Link to this property
media: DataPermissionsMedia Media permissions
audio: DataPermissionsMediaAudio Audio permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: DataPermissionsMediaScreenshare Screenshare permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: DataPermissionsMediaVideo Video permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: bool Link to this property
plugins: DataPermissionsPlugins Plugin permissions can\_close: bool Can close plugins that are already open Link to this property can\_edit\_config: bool Can edit plugin config Link to this property can\_start: bool Can start plugins Link to this property
config: Dict\[str, DataPermissionsPluginsConfig] Plugin configuration keyed by plugin UUID.
access\_control: Optional\[Literal\["FULL\_ACCESS", "VIEW\_ONLY"]] One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only: Optional\[bool] Link to this property
Link to this property
Link to this property
polls: DataPermissionsPolls Poll permissions can\_create: bool Can create polls Link to this property can\_view: bool Can view polls Link to this property can\_vote: bool Can vote on polls Link to this property
Link to this property
recorder\_type: Literal\["RECORDER", "LIVESTREAMER", "NONE"] Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: bool Link to this property
waiting\_room\_type: Literal\["SKIP", "ON\_PRIVILEGED\_USER\_ENTRY", "SKIP\_ON\_ACCEPT"] Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests: Optional\[bool] Link to this property is\_recorder: Optional\[bool] Link to this property
stage\_access: Optional\[Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"]] One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled: Optional\[bool] Link to this property transcription\_enabled: Optional\[bool] Link to this property
Link to this property
ui: DataUI
design\_tokens: DataUIDesignTokens
border\_radius: Literal\["sharp", "rounded", "extra-rounded", "circular"] One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: Literal\["none", "thin", "fat"] One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: DataUIDesignTokensColors
background: DataUIDesignTokensColorsBackground \_1000: str Link to this property \_600: str Link to this property \_700: str Link to this property \_800: str Link to this property \_900: str Link to this property
Link to this property
brand: DataUIDesignTokensColorsBrand \_300: str Link to this property \_400: str Link to this property \_500: str Link to this property \_600: str Link to this property \_700: str Link to this property
Link to this property danger: str Link to this property success: str Link to this property text: str Link to this property text\_on\_brand: str Link to this property video\_bg: str Link to this property warning: str Link to this property
Link to this property spacing\_base: float minimum1 Link to this property
theme: Literal\["darkest", "dark", "light"] One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family: Optional\[str] Link to this property google\_font: Optional\[str] Link to this property logo: Optional\[str] formaturi Link to this property
Link to this property
Link to this property updated\_at: datetime Timestamp this preset was last updated formatdate-time Link to this property
Link to this property success: bool Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_update_response%20%3E%20(schema)>)
class PresetReplacePresetByIDResponse: …
data: Data Data returned by the operation id: str ID of the preset formatuuid Link to this property
config: DataConfig max\_screenshare\_count: float Maximum number of screen shares that can be active at a given time Link to this property
max\_video\_streams: DataConfigMaxVideoStreams Maximum number of streams that are visible on a device desktop: float Maximum number of video streams visible on desktop devices Link to this property mobile: float Maximum number of streams visible on mobile devices Link to this property
Link to this property
media: DataConfigMedia Media configuration options. eg: Video quality
screenshare: DataConfigMediaScreenshare Configuration options for participant screen shares frame\_rate: float Frame rate of screen share Link to this property
quality: Literal\["hd", "vga", "qvga", 2 more] Quality of screen share One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property
Link to this property
video: DataConfigMediaVideo Configuration options for participant videos frame\_rate: float Frame rate of participants’ video maximum30 Link to this property
quality: Literal\["hd", "vga", "qvga", 2 more] Video quality of participants One of the following: "hd" Link to this property "vga" Link to this property "qvga" Link to this property "fhd" Link to this property "uhd" Link to this property
Link to this property simulcast: Optional\[bool] Enable simulcast for participant videos. Link to this property
Link to this property
audio: Optional\[DataConfigMediaAudio] Control options for Audio quality. enable\_high\_bitrate: Optional\[bool] Enable High Quality Audio for your meetings Link to this property enable\_stereo: Optional\[bool] Enable Stereo for your meetings Link to this property
Link to this property
Link to this property
view\_type: Literal\["GROUP\_CALL", "WEBINAR", "AUDIO\_ROOM", "LIVESTREAM"] Type of the meeting One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property
Link to this property livestream\_viewer\_qualities: Optional\[List\[int]] Livestream viewer quality levels. Link to this property
Link to this property created\_at: datetime Timestamp this preset was created at formatdate-time Link to this property name: str Name of the preset Link to this property
permissions: DataPermissions accept\_waiting\_requests: bool Whether this participant can accept waiting requests Link to this property can\_accept\_production\_requests: bool Link to this property can\_change\_participant\_permissions: bool Link to this property can\_edit\_display\_name: bool Link to this property can\_livestream: bool Link to this property can\_record: bool Link to this property can\_spotlight: bool Link to this property
chat: DataPermissionsChat
private: DataPermissionsChatPrivate can\_receive: bool Link to this property can\_send: bool Link to this property files: bool Link to this property text: bool Link to this property
Link to this property
public: DataPermissionsChatPublic can\_send: bool Can send messages in general Link to this property files: bool Can send file messages Link to this property text: bool Can send text messages Link to this property
Link to this property
Link to this property
connected\_meetings: DataPermissionsConnectedMeetings can\_alter\_connected\_meetings: bool Link to this property can\_switch\_connected\_meetings: bool Link to this property can\_switch\_to\_parent\_meeting: bool Link to this property
Link to this property disable\_participant\_audio: bool Link to this property disable\_participant\_screensharing: bool Link to this property disable\_participant\_video: bool Link to this property hidden\_participant: bool Whether this participant is visible to others or not Link to this property kick\_participant: bool Link to this property
media: DataPermissionsMedia Media permissions
audio: DataPermissionsMediaAudio Audio permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce audio One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
screenshare: DataPermissionsMediaScreenshare Screenshare permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce screen share video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
video: DataPermissionsMediaVideo Video permissions
can\_produce: Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"] Can produce video One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property
Link to this property
Link to this property pin\_participant: bool Link to this property
plugins: DataPermissionsPlugins Plugin permissions can\_close: bool Can close plugins that are already open Link to this property can\_edit\_config: bool Can edit plugin config Link to this property can\_start: bool Can start plugins Link to this property
config: Dict\[str, DataPermissionsPluginsConfig] Plugin configuration keyed by plugin UUID.
access\_control: Optional\[Literal\["FULL\_ACCESS", "VIEW\_ONLY"]] One of the following: "FULL\_ACCESS" Link to this property "VIEW\_ONLY" Link to this property
Link to this property handles\_view\_only: Optional\[bool] Link to this property
Link to this property
Link to this property
polls: DataPermissionsPolls Poll permissions can\_create: bool Can create polls Link to this property can\_view: bool Can view polls Link to this property can\_vote: bool Can vote on polls Link to this property
Link to this property
recorder\_type: Literal\["RECORDER", "LIVESTREAMER", "NONE"] Type of the recording peer One of the following: "RECORDER" Link to this property "LIVESTREAMER" Link to this property "NONE" Link to this property
Link to this property show\_participant\_list: bool Link to this property
waiting\_room\_type: Literal\["SKIP", "ON\_PRIVILEGED\_USER\_ENTRY", "SKIP\_ON\_ACCEPT"] Waiting room type One of the following: "SKIP" Link to this property "ON\_PRIVILEGED\_USER\_ENTRY" Link to this property "SKIP\_ON\_ACCEPT" Link to this property
Link to this property accept\_stage\_requests: Optional\[bool] Link to this property is\_recorder: Optional\[bool] Link to this property
stage\_access: Optional\[Literal\["ALLOWED", "NOT\_ALLOWED", "CAN\_REQUEST"]] One of the following: "ALLOWED" Link to this property "NOT\_ALLOWED" Link to this property "CAN\_REQUEST" Link to this property
Link to this property stage\_enabled: Optional\[bool] Link to this property transcription\_enabled: Optional\[bool] Link to this property
Link to this property
ui: DataUI
design\_tokens: DataUIDesignTokens
border\_radius: Literal\["sharp", "rounded", "extra-rounded", "circular"] One of the following: "sharp" Link to this property "rounded" Link to this property "extra-rounded" Link to this property "circular" Link to this property
Link to this property
border\_width: Literal\["none", "thin", "fat"] One of the following: "none" Link to this property "thin" Link to this property "fat" Link to this property
Link to this property
colors: DataUIDesignTokensColors
background: DataUIDesignTokensColorsBackground \_1000: str Link to this property \_600: str Link to this property \_700: str Link to this property \_800: str Link to this property \_900: str Link to this property
Link to this property
brand: DataUIDesignTokensColorsBrand \_300: str Link to this property \_400: str Link to this property \_500: str Link to this property \_600: str Link to this property \_700: str Link to this property
Link to this property danger: str Link to this property success: str Link to this property text: str Link to this property text\_on\_brand: str Link to this property video\_bg: str Link to this property warning: str Link to this property
Link to this property spacing\_base: float minimum1 Link to this property
theme: Literal\["darkest", "dark", "light"] One of the following: "darkest" Link to this property "dark" Link to this property "light" Link to this property
Link to this property font\_family: Optional\[str] Link to this property google\_font: Optional\[str] Link to this property logo: Optional\[str] formaturi Link to this property
Link to this property
Link to this property updated\_at: datetime Timestamp this preset was last updated formatdate-time Link to this property
Link to this property success: bool Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.presets%20%3E%20(model)%20preset_replace_preset_by_id_response%20%3E%20(schema)>) #### Realtime KitSessions ##### [Fetch all sessions of an App](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/sessions/methods/get_sessions) realtime\_kit.sessions.get\_sessions(strapp\_id, SessionGetSessionsParams\*\*kwargs) -> [SessionGetSessionsResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions ##### [Fetch details of a session](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/sessions/methods/get_session_details) realtime\_kit.sessions.get\_session\_details(strsession\_id, SessionGetSessionDetailsParams\*\*kwargs) -> [SessionGetSessionDetailsResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id} ##### [Fetch participants list of a session](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/sessions/methods/get_session_participants) realtime\_kit.sessions.get\_session\_participants(strsession\_id, SessionGetSessionParticipantsParams\*\*kwargs) -> [SessionGetSessionParticipantsResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/participants ##### [Fetch details of a participant](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/sessions/methods/get_session_participant_details) realtime\_kit.sessions.get\_session\_participant\_details(strparticipant\_id, SessionGetSessionParticipantDetailsParams\*\*kwargs) -> [SessionGetSessionParticipantDetailsResponse]() 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/python/resources/realtime_kit/subresources/sessions/methods/get_session_chat) realtime\_kit.sessions.get\_session\_chat(strsession\_id, SessionGetSessionChatParams\*\*kwargs) -> [SessionGetSessionChatResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/chat ##### [Fetch the complete transcript for a session](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/sessions/methods/get_session_transcripts) realtime\_kit.sessions.get\_session\_transcripts(strsession\_id, SessionGetSessionTranscriptsParams\*\*kwargs) -> [SessionGetSessionTranscriptsResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/transcript ##### [Fetch summary of transcripts for a session](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/sessions/methods/get_session_summary) realtime\_kit.sessions.get\_session\_summary(strsession\_id, SessionGetSessionSummaryParams\*\*kwargs) -> [SessionGetSessionSummaryResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/summary ##### [Generate summary of Transcripts for the session](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/sessions/methods/generate_summary_of_transcripts) realtime\_kit.sessions.generate\_summary\_of\_transcripts(strsession\_id, SessionGenerateSummaryOfTranscriptsParams\*\*kwargs) -> [SessionGenerateSummaryOfTranscriptsResponse]() POST/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/{session\_id}/summary ##### [Fetch details of peer](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/sessions/methods/get_participant_data_from_peer_id) realtime\_kit.sessions.get\_participant\_data\_from\_peer\_id(strpeer\_id, SessionGetParticipantDataFromPeerIDParams\*\*kwargs) -> [SessionGetParticipantDataFromPeerIDResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/sessions/peer-report/{peer\_id} ##### ModelsExpand Collapse
class SessionGetSessionsResponse: …
data: Optional\[Data]
sessions: Optional\[List\[DataSession]] id: str ID of the session Link to this property associated\_id: str 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: str timestamp when session created Link to this property live\_participants: float number of participants currently in the session Link to this property max\_concurrent\_participants: float number of maximum participants that were in the session Link to this property meeting\_display\_name: str Title of the meeting this session belongs to Link to this property minutes\_consumed: float number of minutes consumed since the session started Link to this property organization\_id: str App id that hosted this session Link to this property started\_at: str timestamp when session started Link to this property
status: Literal\["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: Literal\["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: str timestamp when session was last updated Link to this property breakout\_rooms: Optional\[List\[object]] Link to this property ended\_at: Optional\[str] timestamp when session ended Link to this property
Link to this property
Link to this property
paging: Optional\[Paging] end\_offset: Optional\[float] Link to this property start\_offset: Optional\[float] Link to this property total\_count: Optional\[float] minimum0 Link to this property
Link to this property success: Optional\[bool] Link to this property
[Link to this property](<#(resource)%20realtime_kit.sessions%20%3E%20(model)%20session_get_sessions_response%20%3E%20(schema)>)
class SessionGetSessionDetailsResponse: …
data: Optional\[Data] id: str ID of the session Link to this property associated\_id: str 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: str timestamp when session created Link to this property live\_participants: float number of participants currently in the session Link to this property max\_concurrent\_participants: float number of maximum participants that were in the session Link to this property meeting\_display\_name: str Title of the meeting this session belongs to Link to this property minutes\_consumed: float number of minutes consumed since the session started Link to this property organization\_id: str App id that hosted this session Link to this property started\_at: str timestamp when session started Link to this property
status: Literal\["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: Literal\["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: str timestamp when session was last updated Link to this property breakout\_rooms: Optional\[List\[object]] Link to this property ended\_at: Optional\[str] timestamp when session ended Link to this property
Link to this property success: Optional\[bool] 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)>)
class SessionGetSessionParticipantsResponse: …
data: Optional\[Data]
participants: Optional\[List\[DataParticipant]] id: Optional\[str] Participant ID. This maps to the corresponding peerId. Link to this property created\_at: Optional\[str] timestamp when this participant was created. Link to this property custom\_participant\_id: Optional\[str] ID passed by client to create this participant. Link to this property display\_name: Optional\[str] Display name of participant when joining the session. Link to this property duration: Optional\[float] number of minutes for which the participant was in the session. Link to this property joined\_at: Optional\[str] timestamp at which participant joined the session. Link to this property left\_at: Optional\[str] timestamp at which participant left the session. Link to this property
peer\_events: Optional\[List\[DataParticipantPeerEvent]] Connection lifecycle events for the participant’s peer. Only included when include_peer_events is true. id: Optional\[str] ID of the peer event. Link to this property created\_at: Optional\[str] Timestamp when this peer event was created. Link to this property
event\_name: Optional\[Literal\["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: Optional\[float] Minutes consumed attributed to this event. Link to this property participant\_id: Optional\[str] ID of the participant this event belongs to. Link to this property peer\_id: Optional\[str] Peer ID this event belongs to. Link to this property
preset\_view\_type: Optional\[Literal\["GROUP\_CALL", "WEBINAR", "AUDIO\_ROOM", 2 more]] View type of the preset associated with the peer. One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property "CHAT" Link to this property
Link to this property session\_id: Optional\[str] ID of the session this event belongs to. Link to this property socket\_session\_id: Optional\[str] ID of the socket session associated with this event. Link to this property updated\_at: Optional\[str] Timestamp when this peer event was last updated. Link to this property
Link to this property preset\_name: Optional\[str] Name of the preset associated with the participant. Link to this property updated\_at: Optional\[str] timestamp when this participant’s data was last updated. Link to this property user\_id: Optional\[str] User id for this participant. Link to this property
Link to this property
Link to this property success: Optional\[bool] 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)>)
class SessionGetSessionParticipantDetailsResponse: …
data: Optional\[Data]
participant: Optional\[DataParticipant] id: Optional\[str] Participant ID. This maps to the corresponding peerId. Link to this property created\_at: Optional\[str] timestamp when this participant was created. Link to this property custom\_participant\_id: Optional\[str] ID passed by client to create this participant. Link to this property display\_name: Optional\[str] Display name of participant when joining the session. Link to this property duration: Optional\[float] number of minutes for which the participant was in the session. Link to this property joined\_at: Optional\[str] timestamp at which participant joined the session. Link to this property left\_at: Optional\[str] timestamp at which participant left the session. Link to this property
peer\_events: Optional\[List\[DataParticipantPeerEvent]] Connection lifecycle events for the participant’s peer. Only included when include_peer_events is true. id: Optional\[str] ID of the peer event. Link to this property created\_at: Optional\[str] Timestamp when this peer event was created. Link to this property
event\_name: Optional\[Literal\["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: Optional\[float] Minutes consumed attributed to this event. Link to this property participant\_id: Optional\[str] ID of the participant this event belongs to. Link to this property peer\_id: Optional\[str] Peer ID this event belongs to. Link to this property
preset\_view\_type: Optional\[Literal\["GROUP\_CALL", "WEBINAR", "AUDIO\_ROOM", 2 more]] View type of the preset associated with the peer. One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property "CHAT" Link to this property
Link to this property session\_id: Optional\[str] ID of the session this event belongs to. Link to this property socket\_session\_id: Optional\[str] ID of the socket session associated with this event. Link to this property updated\_at: Optional\[str] Timestamp when this peer event was last updated. Link to this property
Link to this property preset\_name: Optional\[str] Name of the preset associated with the participant. Link to this property updated\_at: Optional\[str] timestamp when this participant’s data was last updated. Link to this property user\_id: Optional\[str] User id for this participant. Link to this property
Link to this property
Link to this property success: Optional\[bool] 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)>)
class SessionGetSessionChatResponse: …
data: Optional\[Data] chat\_download\_url: str URL where the chat logs can be downloaded Link to this property chat\_download\_url\_expiry: str Time when the download URL will expire Link to this property
Link to this property success: Optional\[bool] 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)>)
class SessionGetSessionTranscriptsResponse: …
data: Optional\[Data] session\_id: str Link to this property transcript\_download\_url: str URL where the transcript can be downloaded Link to this property transcript\_download\_url\_expiry: str Time when the download URL will expire Link to this property
Link to this property success: Optional\[bool] 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)>)
class SessionGetSessionSummaryResponse: …
data: Optional\[Data] session\_id: str Link to this property summary\_download\_url: str URL where the summary of transcripts can be downloaded Link to this property summary\_download\_url\_expiry: str Time of Expiry before when you need to download the csv file. Link to this property
Link to this property success: Optional\[bool] 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)>)
class SessionGenerateSummaryOfTranscriptsResponse: …
data: Optional\[Data] session\_id: Optional\[str] formatuuid Link to this property status: Optional\[str] Link to this property
Link to this property success: Optional\[bool] 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)>)
class SessionGetParticipantDataFromPeerIDResponse: …
data: Optional\[Data]
participant: Optional\[DataParticipant] id: Optional\[str] ID of the participant. formatuuid Link to this property created\_at: Optional\[str] timestamp when this participant was created. Link to this property custom\_participant\_id: Optional\[str] ID passed by client to create this participant. Link to this property display\_name: Optional\[str] Display name of participant when joining the session. Link to this property duration: Optional\[float] number of minutes for which the participant was in the session. Link to this property joined\_at: Optional\[str] timestamp at which participant joined the session. Link to this property left\_at: Optional\[str] timestamp at which participant left the session. Link to this property
peer\_events: Optional\[List\[DataParticipantPeerEvent]] Connection lifecycle events for the participant’s peer. id: Optional\[str] ID of the peer event. Link to this property created\_at: Optional\[str] Timestamp when this peer event was created. Link to this property
event\_name: Optional\[Literal\["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: Optional\[float] Minutes consumed attributed to this event. Link to this property participant\_id: Optional\[str] ID of the participant this event belongs to. Link to this property peer\_id: Optional\[str] Peer ID this event belongs to. Link to this property
preset\_view\_type: Optional\[Literal\["GROUP\_CALL", "WEBINAR", "AUDIO\_ROOM", 2 more]] View type of the preset associated with the peer. One of the following: "GROUP\_CALL" Link to this property "WEBINAR" Link to this property "AUDIO\_ROOM" Link to this property "LIVESTREAM" Link to this property "CHAT" Link to this property
Link to this property session\_id: Optional\[str] ID of the session this event belongs to. Link to this property socket\_session\_id: Optional\[str] ID of the socket session associated with this event. Link to this property updated\_at: Optional\[str] Timestamp when this peer event was last updated. Link to this property
Link to this property
peer\_report: Optional\[DataParticipantPeerReport] Peer call statistics report.
metadata: Optional\[DataParticipantPeerReportMetadata] Connection and device metadata for the participant.
audio\_devices\_updates: Optional\[List\[DataParticipantPeerReportMetadataAudioDevicesUpdate]]
added: Optional\[List\[DataParticipantPeerReportMetadataAudioDevicesUpdateAdded]] Devices that became available. device\_id: Optional\[str] ID of the device. Link to this property kind: Optional\[str] Kind of device, for example audioinput or videoinput. Link to this property label: Optional\[str] Human-readable label of the device. Link to this property
Link to this property
removed: Optional\[List\[DataParticipantPeerReportMetadataAudioDevicesUpdateRemoved]] Devices that became unavailable. device\_id: Optional\[str] ID of the device. Link to this property kind: Optional\[str] Kind of device, for example audioinput or videoinput. Link to this property label: Optional\[str] Human-readable label of the device. Link to this property
Link to this property timestamp: Optional\[str] Timestamp of the device update. Link to this property
Link to this property
browser\_metadata: Optional\[DataParticipantPeerReportMetadataBrowserMetadata] browser: Optional\[str] Link to this property browser\_version: Optional\[str] Link to this property engine: Optional\[str] Link to this property user\_agent: Optional\[str] Link to this property webgl\_support: Optional\[bool] Link to this property
Link to this property
candidate\_pairs: Optional\[DataParticipantPeerReportMetadataCandidatePairs]
consuming\_transport: Optional\[List\[DataParticipantPeerReportMetadataCandidatePairsConsumingTransport]] available\_incoming\_bitrate: Optional\[float] Link to this property available\_outgoing\_bitrate: Optional\[float] Link to this property bytes\_discarded\_on\_send: Optional\[float] Link to this property bytes\_received: Optional\[float] Link to this property bytes\_sent: Optional\[float] Link to this property current\_round\_trip\_time: Optional\[float] Link to this property last\_packet\_received\_timestamp: Optional\[float] Epoch milliseconds when the last packet was received. Link to this property last\_packet\_sent\_timestamp: Optional\[float] Epoch milliseconds when the last packet was sent. Link to this property local\_candidate\_address: Optional\[str] Link to this property local\_candidate\_id: Optional\[str] Link to this property local\_candidate\_network\_type: Optional\[str] Link to this property local\_candidate\_port: Optional\[float] Link to this property local\_candidate\_protocol: Optional\[str] Link to this property local\_candidate\_related\_address: Optional\[str] Link to this property local\_candidate\_related\_port: Optional\[float] Link to this property local\_candidate\_type: Optional\[str] Link to this property local\_candidate\_url: Optional\[str] Link to this property nominated: Optional\[bool] Link to this property packets\_discarded\_on\_send: Optional\[float] Link to this property packets\_received: Optional\[float] Link to this property packets\_sent: Optional\[float] Link to this property remote\_candidate\_address: Optional\[str] Link to this property remote\_candidate\_id: Optional\[str] Link to this property remote\_candidate\_port: Optional\[float] Link to this property remote\_candidate\_protocol: Optional\[str] Link to this property remote\_candidate\_type: Optional\[str] Link to this property remote\_candidate\_url: Optional\[str] Link to this property total\_round\_trip\_time: Optional\[float] Link to this property
Link to this property
producing\_transport: Optional\[List\[DataParticipantPeerReportMetadataCandidatePairsProducingTransport]] available\_incoming\_bitrate: Optional\[float] Link to this property available\_outgoing\_bitrate: Optional\[float] Link to this property bytes\_discarded\_on\_send: Optional\[float] Link to this property bytes\_received: Optional\[float] Link to this property bytes\_sent: Optional\[float] Link to this property current\_round\_trip\_time: Optional\[float] Link to this property last\_packet\_received\_timestamp: Optional\[float] Epoch milliseconds when the last packet was received. Link to this property last\_packet\_sent\_timestamp: Optional\[float] Epoch milliseconds when the last packet was sent. Link to this property local\_candidate\_address: Optional\[str] Link to this property local\_candidate\_id: Optional\[str] Link to this property local\_candidate\_network\_type: Optional\[str] Link to this property local\_candidate\_port: Optional\[float] Link to this property local\_candidate\_protocol: Optional\[str] Link to this property local\_candidate\_related\_address: Optional\[str] Link to this property local\_candidate\_related\_port: Optional\[float] Link to this property local\_candidate\_type: Optional\[str] Link to this property local\_candidate\_url: Optional\[str] Link to this property nominated: Optional\[bool] Link to this property packets\_discarded\_on\_send: Optional\[float] Link to this property packets\_received: Optional\[float] Link to this property packets\_sent: Optional\[float] Link to this property remote\_candidate\_address: Optional\[str] Link to this property remote\_candidate\_id: Optional\[str] Link to this property remote\_candidate\_port: Optional\[float] Link to this property remote\_candidate\_protocol: Optional\[str] Link to this property remote\_candidate\_type: Optional\[str] Link to this property remote\_candidate\_url: Optional\[str] Link to this property total\_round\_trip\_time: Optional\[float] Link to this property
Link to this property
Link to this property
device\_info: Optional\[DataParticipantPeerReportMetadataDeviceInfo] cpus: Optional\[float] Link to this property is\_mobile: Optional\[bool] Link to this property os: Optional\[str] Link to this property os\_version: Optional\[str] Link to this property
Link to this property
events: Optional\[List\[DataParticipantPeerReportMetadataEvent]]
metadata: Optional\[Dict\[str, Union\[str, float, bool, null]]] Event-specific metadata. Keys vary per event; values are primitive scalars (string, number, boolean, or null). One of the following: str Link to this property float Link to this property bool Link to this property
Link to this property name: Optional\[str] Name of the event. Link to this property timestamp: Optional\[str] Timestamp when the event occurred. Link to this property
Link to this property
ip\_information: Optional\[DataParticipantPeerReportMetadataIPInformation]
asn: Optional\[DataParticipantPeerReportMetadataIPInformationASN] asn: Optional\[str] Link to this property domain: Optional\[str] Link to this property name: Optional\[str] Link to this property route: Optional\[str] Link to this property type: Optional\[str] Link to this property
Link to this property city: Optional\[str] Link to this property country: Optional\[str] Link to this property ipv4: Optional\[str] Link to this property org: Optional\[str] Link to this property region: Optional\[str] Link to this property timezone: Optional\[str] Link to this property
Link to this property
native\_metadata: Optional\[DataParticipantPeerReportMetadataNativeMetadata] audio\_encoder: Optional\[str] Link to this property video\_encoder: Optional\[str] Link to this property
Link to this property
pc\_metadata: Optional\[List\[DataParticipantPeerReportMetadataPcMetadata]] effective\_network\_type: Optional\[str] Link to this property reflexive\_connectivity: Optional\[bool] Link to this property relay\_connectivity: Optional\[bool] Link to this property sdp: Optional\[List\[str]] Link to this property timestamp: Optional\[str] Link to this property turn\_connectivity: Optional\[bool] Link to this property
Link to this property room\_view\_type: Optional\[str] Link to this property sdk\_name: Optional\[str] Link to this property sdk\_type: Optional\[str] Link to this property sdk\_version: Optional\[str] Link to this property
selected\_device\_updates: Optional\[List\[DataParticipantPeerReportMetadataSelectedDeviceUpdate]]
device: Optional\[DataParticipantPeerReportMetadataSelectedDeviceUpdateDevice] A media device (camera, microphone, or speaker). device\_id: Optional\[str] ID of the device. Link to this property kind: Optional\[str] Kind of device, for example audioinput or videoinput. Link to this property label: Optional\[str] Human-readable label of the device. Link to this property
Link to this property timestamp: Optional\[str] Link to this property
Link to this property
speaker\_devices\_updates: Optional\[List\[DataParticipantPeerReportMetadataSpeakerDevicesUpdate]]
added: Optional\[List\[DataParticipantPeerReportMetadataSpeakerDevicesUpdateAdded]] Devices that became available. device\_id: Optional\[str] ID of the device. Link to this property kind: Optional\[str] Kind of device, for example audioinput or videoinput. Link to this property label: Optional\[str] Human-readable label of the device. Link to this property
Link to this property
removed: Optional\[List\[DataParticipantPeerReportMetadataSpeakerDevicesUpdateRemoved]] Devices that became unavailable. device\_id: Optional\[str] ID of the device. Link to this property kind: Optional\[str] Kind of device, for example audioinput or videoinput. Link to this property label: Optional\[str] Human-readable label of the device. Link to this property
Link to this property timestamp: Optional\[str] Timestamp of the device update. Link to this property
Link to this property
video\_devices\_updates: Optional\[List\[DataParticipantPeerReportMetadataVideoDevicesUpdate]]
added: Optional\[List\[DataParticipantPeerReportMetadataVideoDevicesUpdateAdded]] Devices that became available. device\_id: Optional\[str] ID of the device. Link to this property kind: Optional\[str] Kind of device, for example audioinput or videoinput. Link to this property label: Optional\[str] Human-readable label of the device. Link to this property
Link to this property
removed: Optional\[List\[DataParticipantPeerReportMetadataVideoDevicesUpdateRemoved]] Devices that became unavailable. device\_id: Optional\[str] ID of the device. Link to this property kind: Optional\[str] Kind of device, for example audioinput or videoinput. Link to this property label: Optional\[str] Human-readable label of the device. Link to this property
Link to this property timestamp: Optional\[str] Timestamp of the device update. Link to this property
Link to this property
Link to this property
quality: Optional\[DataParticipantPeerReportQuality] Media quality statistics for the participant.
audio\_consumer: Optional\[List\[DataParticipantPeerReportQualityAudioConsumer]] bytes\_received: Optional\[float] Link to this property concealment\_events: Optional\[float] Link to this property consumer\_id: Optional\[str] Link to this property jitter: Optional\[float] Link to this property jitter\_buffer\_delay: Optional\[float] Link to this property jitter\_buffer\_emitted\_count: Optional\[float] Link to this property mid: Optional\[str] Link to this property mos\_quality: Optional\[float] Link to this property packets\_lost: Optional\[float] Link to this property packets\_received: Optional\[float] Link to this property peer\_id: Optional\[str] Link to this property producer\_id: Optional\[str] Link to this property ssrc: Optional\[float] Link to this property timestamp: Optional\[str] Link to this property
Link to this property
audio\_consumer\_cumulative: Optional\[DataParticipantPeerReportQualityAudioConsumerCumulative] Aggregated inbound (consumer) audio statistics for the session.
jitter\_buffer\_delay: Optional\[DataParticipantPeerReportQualityAudioConsumerCumulativeJitterBufferDelay] Cumulative latency distribution (milliseconds-based thresholds). \_100ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_250ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_500ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
packet\_loss: Optional\[DataParticipantPeerReportQualityAudioConsumerCumulativePacketLoss] Cumulative packet loss distribution. \_10\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_25\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_5\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_50\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
quality\_mos: Optional\[DataParticipantPeerReportQualityAudioConsumerCumulativeQualityMos] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
Link to this property
audio\_producer: Optional\[List\[DataParticipantPeerReportQualityAudioProducer]] bytes\_sent: Optional\[float] Link to this property jitter: Optional\[float] Link to this property mid: Optional\[str] Link to this property mos\_quality: Optional\[float] Link to this property packets\_lost: Optional\[float] Link to this property packets\_sent: Optional\[float] Link to this property producer\_id: Optional\[str] Link to this property rtt: Optional\[float] Link to this property ssrc: Optional\[float] Link to this property timestamp: Optional\[str] Link to this property
Link to this property
audio\_producer\_cumulative: Optional\[DataParticipantPeerReportQualityAudioProducerCumulative] Aggregated outbound (producer) audio statistics for the session.
packet\_loss: Optional\[DataParticipantPeerReportQualityAudioProducerCumulativePacketLoss] Cumulative packet loss distribution. \_10\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_25\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_5\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_50\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
quality\_mos: Optional\[DataParticipantPeerReportQualityAudioProducerCumulativeQualityMos] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
rtt: Optional\[DataParticipantPeerReportQualityAudioProducerCumulativeRTT] Cumulative latency distribution (milliseconds-based thresholds). \_100ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_250ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_500ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
Link to this property
screenshare\_audio\_consumer: Optional\[List\[DataParticipantPeerReportQualityScreenshareAudioConsumer]] bytes\_received: Optional\[float] Link to this property concealment\_events: Optional\[float] Link to this property consumer\_id: Optional\[str] Link to this property jitter: Optional\[float] Link to this property jitter\_buffer\_delay: Optional\[float] Link to this property jitter\_buffer\_emitted\_count: Optional\[float] Link to this property mid: Optional\[str] Link to this property mos\_quality: Optional\[float] Link to this property packets\_lost: Optional\[float] Link to this property packets\_received: Optional\[float] Link to this property peer\_id: Optional\[str] Link to this property producer\_id: Optional\[str] Link to this property ssrc: Optional\[float] Link to this property timestamp: Optional\[str] Link to this property
Link to this property
screenshare\_audio\_consumer\_cumulative: Optional\[DataParticipantPeerReportQualityScreenshareAudioConsumerCumulative] Aggregated inbound (consumer) audio statistics for the session.
jitter\_buffer\_delay: Optional\[DataParticipantPeerReportQualityScreenshareAudioConsumerCumulativeJitterBufferDelay] Cumulative latency distribution (milliseconds-based thresholds). \_100ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_250ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_500ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
packet\_loss: Optional\[DataParticipantPeerReportQualityScreenshareAudioConsumerCumulativePacketLoss] Cumulative packet loss distribution. \_10\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_25\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_5\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_50\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
quality\_mos: Optional\[DataParticipantPeerReportQualityScreenshareAudioConsumerCumulativeQualityMos] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
Link to this property
screenshare\_audio\_producer: Optional\[List\[DataParticipantPeerReportQualityScreenshareAudioProducer]] bytes\_sent: Optional\[float] Link to this property jitter: Optional\[float] Link to this property mid: Optional\[str] Link to this property mos\_quality: Optional\[float] Link to this property packets\_lost: Optional\[float] Link to this property packets\_sent: Optional\[float] Link to this property producer\_id: Optional\[str] Link to this property rtt: Optional\[float] Link to this property ssrc: Optional\[float] Link to this property timestamp: Optional\[str] Link to this property
Link to this property
screenshare\_audio\_producer\_cumulative: Optional\[DataParticipantPeerReportQualityScreenshareAudioProducerCumulative] Aggregated outbound (producer) audio statistics for the session.
packet\_loss: Optional\[DataParticipantPeerReportQualityScreenshareAudioProducerCumulativePacketLoss] Cumulative packet loss distribution. \_10\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_25\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_5\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_50\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
quality\_mos: Optional\[DataParticipantPeerReportQualityScreenshareAudioProducerCumulativeQualityMos] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
rtt: Optional\[DataParticipantPeerReportQualityScreenshareAudioProducerCumulativeRTT] Cumulative latency distribution (milliseconds-based thresholds). \_100ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_250ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_500ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
Link to this property
screenshare\_video\_consumer: Optional\[List\[DataParticipantPeerReportQualityScreenshareVideoConsumer]] bytes\_received: Optional\[float] Link to this property consumer\_id: Optional\[str] Link to this property fir\_count: Optional\[float] Link to this property frame\_height: Optional\[float] Link to this property frame\_width: Optional\[float] Link to this property frames\_decoded: Optional\[float] Link to this property frames\_dropped: Optional\[float] Link to this property frames\_per\_second: Optional\[float] Link to this property jitter: Optional\[float] Link to this property jitter\_buffer\_delay: Optional\[float] Link to this property jitter\_buffer\_emitted\_count: Optional\[float] Link to this property key\_frames\_decoded: Optional\[float] Link to this property mid: Optional\[str] Link to this property mos\_quality: Optional\[float] Link to this property packets\_lost: Optional\[float] Link to this property packets\_received: Optional\[float] Link to this property peer\_id: Optional\[str] Link to this property producer\_id: Optional\[str] Link to this property ssrc: Optional\[float] Link to this property timestamp: Optional\[str] Link to this property
Link to this property
screenshare\_video\_consumer\_cumulative: Optional\[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulative] Aggregated inbound (consumer) video statistics for the session.
frame\_per\_second: Optional\[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulativeFramePerSecond] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
frame\_width: Optional\[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulativeFrameWidth] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
issues: Optional\[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulativeIssues] lag\_fraction: Optional\[float] Link to this property no\_video\_fraction: Optional\[float] Link to this property poor\_resolution\_fraction: Optional\[float] Link to this property
Link to this property
jitter\_buffer\_delay: Optional\[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulativeJitterBufferDelay] Cumulative latency distribution (milliseconds-based thresholds). \_100ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_250ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_500ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property key\_frames\_decoded\_fraction: Optional\[float] Link to this property
packet\_loss: Optional\[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulativePacketLoss] Cumulative packet loss distribution. \_10\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_25\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_5\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_50\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
quality\_mos: Optional\[DataParticipantPeerReportQualityScreenshareVideoConsumerCumulativeQualityMos] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
Link to this property
screenshare\_video\_producer: Optional\[List\[DataParticipantPeerReportQualityScreenshareVideoProducer]] bytes\_sent: Optional\[float] Link to this property fir\_count: Optional\[float] Link to this property frame\_height: Optional\[float] Link to this property frame\_width: Optional\[float] Link to this property frames\_encoded: Optional\[float] Link to this property frames\_per\_second: Optional\[float] Link to this property jitter: Optional\[float] Link to this property key\_frames\_encoded: Optional\[float] Link to this property mid: Optional\[str] Link to this property mos\_quality: Optional\[float] Link to this property packets\_lost: Optional\[float] Link to this property packets\_sent: Optional\[float] Link to this property pli\_count: Optional\[float] Link to this property producer\_id: Optional\[str] Link to this property
quality\_limitation\_durations: Optional\[DataParticipantPeerReportQualityScreenshareVideoProducerQualityLimitationDurations] bandwidth: Optional\[float] Link to this property cpu: Optional\[float] Link to this property none: Optional\[float] Link to this property other: Optional\[float] Link to this property
Link to this property
quality\_limitation\_reason: Optional\[Literal\["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: Optional\[float] Link to this property rtt: Optional\[float] Link to this property ssrc: Optional\[float] Link to this property timestamp: Optional\[str] Link to this property
Link to this property
screenshare\_video\_producer\_cumulative: Optional\[DataParticipantPeerReportQualityScreenshareVideoProducerCumulative] Aggregated outbound (producer) video statistics for the session.
frame\_per\_second: Optional\[DataParticipantPeerReportQualityScreenshareVideoProducerCumulativeFramePerSecond] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
frame\_width: Optional\[DataParticipantPeerReportQualityScreenshareVideoProducerCumulativeFrameWidth] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property high\_negative\_feedback\_fraction: Optional\[float] Link to this property
issues: Optional\[DataParticipantPeerReportQualityScreenshareVideoProducerCumulativeIssues] bandwidth\_quality\_limitation\_fraction: Optional\[float] Link to this property cpu\_quality\_limitation\_fraction: Optional\[float] Link to this property no\_video\_fraction: Optional\[float] Link to this property poor\_resolution\_fraction: Optional\[float] Link to this property quality\_limitation\_fraction: Optional\[float] Link to this property
Link to this property key\_frames\_encoded\_fraction: Optional\[float] Link to this property
packet\_loss: Optional\[DataParticipantPeerReportQualityScreenshareVideoProducerCumulativePacketLoss] Cumulative packet loss distribution. \_10\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_25\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_5\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_50\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
quality\_mos: Optional\[DataParticipantPeerReportQualityScreenshareVideoProducerCumulativeQualityMos] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
rtt: Optional\[DataParticipantPeerReportQualityScreenshareVideoProducerCumulativeRTT] Cumulative latency distribution (milliseconds-based thresholds). \_100ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_250ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_500ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
Link to this property
video\_consumer: Optional\[List\[DataParticipantPeerReportQualityVideoConsumer]] bytes\_received: Optional\[float] Link to this property consumer\_id: Optional\[str] Link to this property fir\_count: Optional\[float] Link to this property frame\_height: Optional\[float] Link to this property frame\_width: Optional\[float] Link to this property frames\_decoded: Optional\[float] Link to this property frames\_dropped: Optional\[float] Link to this property frames\_per\_second: Optional\[float] Link to this property jitter: Optional\[float] Link to this property jitter\_buffer\_delay: Optional\[float] Link to this property jitter\_buffer\_emitted\_count: Optional\[float] Link to this property key\_frames\_decoded: Optional\[float] Link to this property mid: Optional\[str] Link to this property mos\_quality: Optional\[float] Link to this property packets\_lost: Optional\[float] Link to this property packets\_received: Optional\[float] Link to this property peer\_id: Optional\[str] Link to this property producer\_id: Optional\[str] Link to this property ssrc: Optional\[float] Link to this property timestamp: Optional\[str] Link to this property
Link to this property
video\_consumer\_cumulative: Optional\[DataParticipantPeerReportQualityVideoConsumerCumulative] Aggregated inbound (consumer) video statistics for the session.
frame\_per\_second: Optional\[DataParticipantPeerReportQualityVideoConsumerCumulativeFramePerSecond] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
frame\_width: Optional\[DataParticipantPeerReportQualityVideoConsumerCumulativeFrameWidth] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
issues: Optional\[DataParticipantPeerReportQualityVideoConsumerCumulativeIssues] lag\_fraction: Optional\[float] Link to this property no\_video\_fraction: Optional\[float] Link to this property poor\_resolution\_fraction: Optional\[float] Link to this property
Link to this property
jitter\_buffer\_delay: Optional\[DataParticipantPeerReportQualityVideoConsumerCumulativeJitterBufferDelay] Cumulative latency distribution (milliseconds-based thresholds). \_100ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_250ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_500ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property key\_frames\_decoded\_fraction: Optional\[float] Link to this property
packet\_loss: Optional\[DataParticipantPeerReportQualityVideoConsumerCumulativePacketLoss] Cumulative packet loss distribution. \_10\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_25\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_5\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_50\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
quality\_mos: Optional\[DataParticipantPeerReportQualityVideoConsumerCumulativeQualityMos] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
Link to this property
video\_producer: Optional\[List\[DataParticipantPeerReportQualityVideoProducer]] bytes\_sent: Optional\[float] Link to this property fir\_count: Optional\[float] Link to this property frame\_height: Optional\[float] Link to this property frame\_width: Optional\[float] Link to this property frames\_encoded: Optional\[float] Link to this property frames\_per\_second: Optional\[float] Link to this property jitter: Optional\[float] Link to this property key\_frames\_encoded: Optional\[float] Link to this property mid: Optional\[str] Link to this property mos\_quality: Optional\[float] Link to this property packets\_lost: Optional\[float] Link to this property packets\_sent: Optional\[float] Link to this property pli\_count: Optional\[float] Link to this property producer\_id: Optional\[str] Link to this property
quality\_limitation\_durations: Optional\[DataParticipantPeerReportQualityVideoProducerQualityLimitationDurations] bandwidth: Optional\[float] Link to this property cpu: Optional\[float] Link to this property none: Optional\[float] Link to this property other: Optional\[float] Link to this property
Link to this property
quality\_limitation\_reason: Optional\[Literal\["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: Optional\[float] Link to this property rtt: Optional\[float] Link to this property ssrc: Optional\[float] Link to this property timestamp: Optional\[str] Link to this property
Link to this property
video\_producer\_cumulative: Optional\[DataParticipantPeerReportQualityVideoProducerCumulative] Aggregated outbound (producer) video statistics for the session.
frame\_per\_second: Optional\[DataParticipantPeerReportQualityVideoProducerCumulativeFramePerSecond] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
frame\_width: Optional\[DataParticipantPeerReportQualityVideoProducerCumulativeFrameWidth] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property high\_negative\_feedback\_fraction: Optional\[float] Link to this property
issues: Optional\[DataParticipantPeerReportQualityVideoProducerCumulativeIssues] bandwidth\_quality\_limitation\_fraction: Optional\[float] Link to this property cpu\_quality\_limitation\_fraction: Optional\[float] Link to this property no\_video\_fraction: Optional\[float] Link to this property poor\_resolution\_fraction: Optional\[float] Link to this property quality\_limitation\_fraction: Optional\[float] Link to this property
Link to this property key\_frames\_encoded\_fraction: Optional\[float] Link to this property
packet\_loss: Optional\[DataParticipantPeerReportQualityVideoProducerCumulativePacketLoss] Cumulative packet loss distribution. \_10\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_25\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_5\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_50\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
quality\_mos: Optional\[DataParticipantPeerReportQualityVideoProducerCumulativeQualityMos] Distribution summary with average and percentiles. avg: Optional\[float] Link to this property p50: Optional\[float] Link to this property p75: Optional\[float] Link to this property p90: Optional\[float] Link to this property
Link to this property
rtt: Optional\[DataParticipantPeerReportQualityVideoProducerCumulativeRTT] Cumulative latency distribution (milliseconds-based thresholds). \_100ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_250ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property \_500ms\_or\_greater\_event\_fraction: Optional\[float] Link to this property avg: Optional\[float] Link to this property
Link to this property
Link to this property
Link to this property
Link to this property role: Optional\[str] Name of the preset associated with the participant. Link to this property session\_id: Optional\[str] formatuuid Link to this property updated\_at: Optional\[str] timestamp when this participant’s data was last updated. Link to this property user\_id: Optional\[str] User id for this participant. Link to this property
Link to this property
Link to this property success: Optional\[bool] 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/python/resources/realtime_kit/subresources/recordings/methods/get_recordings) realtime\_kit.recordings.get\_recordings(strapp\_id, RecordingGetRecordingsParams\*\*kwargs) -> [RecordingGetRecordingsResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings ##### [Start recording a meeting](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/recordings/methods/start_recordings) realtime\_kit.recordings.start\_recordings(strapp\_id, RecordingStartRecordingsParams\*\*kwargs) -> [RecordingStartRecordingsResponse]() POST/accounts/{account\_id}/realtime/kit/{app\_id}/recordings ##### [Fetch active recording](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/recordings/methods/get_active_recordings) realtime\_kit.recordings.get\_active\_recordings(strmeeting\_id, RecordingGetActiveRecordingsParams\*\*kwargs) -> [RecordingGetActiveRecordingsResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/active-recording/{meeting\_id} ##### [Fetch details of a recording](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/recordings/methods/get_one_recording) realtime\_kit.recordings.get\_one\_recording(strrecording\_id, RecordingGetOneRecordingParams\*\*kwargs) -> [RecordingGetOneRecordingResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/{recording\_id} ##### [Pause/Resume/Stop recording](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/recordings/methods/pause_resume_stop_recording) realtime\_kit.recordings.pause\_resume\_stop\_recording(strrecording\_id, RecordingPauseResumeStopRecordingParams\*\*kwargs) -> [RecordingPauseResumeStopRecordingResponse]() PUT/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/{recording\_id} ##### [Start recording participant audio tracks](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/recordings/methods/start_track_recording) realtime\_kit.recordings.start\_track\_recording(strapp\_id, RecordingStartTrackRecordingParams\*\*kwargs) -> [RecordingStartTrackRecordingResponse]() POST/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/track ##### ModelsExpand Collapse
class RecordingGetRecordingsResponse: …
data: List\[Data] id: str ID of the recording formatuuid Link to this property audio\_download\_url: Optional\[str] If the audio\_config is passed, the URL for downloading the audio recording is returned. formaturi Link to this property download\_url: Optional\[str] URL where the recording can be downloaded. formaturi Link to this property download\_url\_expiry: Optional\[datetime] Timestamp when the download URL expires. formatdate-time Link to this property file\_size: Optional\[float] File size of the recording, in bytes. Link to this property invoked\_time: datetime Timestamp when this recording was invoked. formatdate-time Link to this property output\_file\_name: str File name of the recording. Link to this property session\_id: Optional\[str] ID of the meeting session this recording is for. formatuuid Link to this property started\_time: Optional\[datetime] Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time. formatdate-time Link to this property
status: Literal\["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: Optional\[datetime] Timestamp when this recording was stopped. Optional; is present only when the recording has actually been stopped. formatdate-time Link to this property
meeting: Optional\[DataMeeting] id: str ID of the meeting. formatuuid Link to this property created\_at: datetime Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: datetime Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property live\_stream\_on\_start: Optional\[bool] Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat: Optional\[bool] Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start: Optional\[bool] Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config: Optional\[DataMeetingRecordingConfig] Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
audio\_config: Optional\[DataMeetingRecordingConfigAudioConfig] Object containing configuration regarding the audio that is being recorded.
channel: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[bool] Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix: Optional\[str] Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config: Optional\[DataMeetingRecordingConfigLiveStreamingConfig] rtmp\_url: Optional\[str] RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds: Optional\[float] Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property
realtimekit\_bucket\_config: Optional\[DataMeetingRecordingConfigRealtimekitBucketConfig] enabled: bool Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property
Link to this property
storage\_config: Optional\[DataMeetingRecordingConfigStorageConfig] One of the following:
class DataMeetingRecordingConfigStorageConfigUnionMember0: … access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: Optional\[Literal\["gcs"]] Link to this property username: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataMeetingRecordingConfigStorageConfigUnionMember1: … access\_key: object minLength1 Link to this property region: object minLength1 Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataMeetingRecordingConfigStorageConfigUnionMember2: … private\_key: str Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key: Optional\[str] Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method: Optional\[Literal\["KEY"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property region: Optional\[str] Region of the storage medium.