--- title: Meetings --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Realtime Kit](https://developers.cloudflare.com/api/typescript/resources/realtime_kit) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Meetings ##### [Fetch all meetings for an App](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/get) client.realtimeKit.meetings.get(stringappID, MeetingGetParams {account\_id, end\_time, page\_no, 4 more } params, RequestOptionsoptions?): [MeetingGetResponse]() {data, paging, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings ##### [Create a meeting](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/create) client.realtimeKit.meetings.create(stringappID, MeetingCreateParams {account\_id, ai\_config, live\_stream\_on\_start, 7 more } params, RequestOptionsoptions?): [MeetingCreateResponse]() {success, data } POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings ##### [Fetch a meeting for an App](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/get_meeting_by_id) client.realtimeKit.meetings.getMeetingByID(stringmeetingID, MeetingGetMeetingByIDParams {account\_id, app\_id, name } params, RequestOptionsoptions?): [MeetingGetMeetingByIDResponse]() {success, data } GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id} ##### [Update a meeting](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/update_meeting_by_id) client.realtimeKit.meetings.updateMeetingByID(stringmeetingID, MeetingUpdateMeetingByIDParams {account\_id, app\_id, ai\_config, 9 more } params, RequestOptionsoptions?): [MeetingUpdateMeetingByIDResponse]() {success, data } PATCH/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id} ##### [Replace a meeting](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/replace_meeting_by_id) client.realtimeKit.meetings.replaceMeetingByID(stringmeetingID, MeetingReplaceMeetingByIDParams {account\_id, app\_id, ai\_config, 8 more } params, RequestOptionsoptions?): [MeetingReplaceMeetingByIDResponse]() {success, data } PUT/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id} ##### [Fetch all participants of a meeting](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/get_meeting_participants) client.realtimeKit.meetings.getMeetingParticipants(stringmeetingID, MeetingGetMeetingParticipantsParams {account\_id, app\_id, page\_no, per\_page } params, RequestOptionsoptions?): [MeetingGetMeetingParticipantsResponse]() {data, paging, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants ##### [Add a participant](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/add_participant) client.realtimeKit.meetings.addParticipant(stringmeetingID, MeetingAddParticipantParams {account\_id, app\_id, custom\_participant\_id, 3 more } params, RequestOptionsoptions?): [MeetingAddParticipantResponse]() {success, data } POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants ##### [Fetch a participant's detail](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/get_meeting_participant) client.realtimeKit.meetings.getMeetingParticipant(stringparticipantID, MeetingGetMeetingParticipantParams {account\_id, app\_id, meeting\_id } params, RequestOptionsoptions?): [MeetingGetMeetingParticipantResponse]() {data, success } GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id} ##### [Edit a participant's detail](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/edit_participant) client.realtimeKit.meetings.editParticipant(stringparticipantID, MeetingEditParticipantParams {account\_id, app\_id, meeting\_id, 3 more } params, RequestOptionsoptions?): [MeetingEditParticipantResponse]() {success, data } PATCH/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id} ##### [Delete a participant](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/delete_meeting_participant) client.realtimeKit.meetings.deleteMeetingParticipant(stringparticipantID, MeetingDeleteMeetingParticipantParams {account\_id, app\_id, meeting\_id } params, RequestOptionsoptions?): [MeetingDeleteMeetingParticipantResponse]() {success, data } DELETE/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id} ##### [Refresh participant's authentication token](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/meetings/methods/refresh_participant_token) client.realtimeKit.meetings.refreshParticipantToken(stringparticipantID, MeetingRefreshParticipantTokenParams {account\_id, app\_id, meeting\_id } params, RequestOptionsoptions?): [MeetingRefreshParticipantTokenResponse]() {data, success } POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/participants/{participant\_id}/token ##### ModelsExpand Collapse
MeetingGetResponse {data, paging, success }
data: Array<Data> id: string ID of the meeting. formatuuid Link to this property created\_at: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property live\_stream\_on\_start?: boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat?: boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start?: boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config?: RecordingConfig {audio\_config, file\_name\_prefix, live\_streaming\_config, 4 more } Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
audio\_config?: AudioConfig {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.
channel?: "mono"| "stereo" Audio signal pathway within an audio file that carries a specific sound source. One of the following: "mono" Link to this property "stereo" Link to this property
Link to this property
codec?: "MP3"| "AAC" Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis. One of the following: "MP3" Link to this property "AAC" Link to this property
Link to this property export\_file?: boolean Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix?: string Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config?: LiveStreamingConfig {rtmp\_url } rtmp\_url?: string RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds?: number Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property
realtimekit\_bucket\_config?: RealtimekitBucketConfig {enabled } enabled: boolean Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property
Link to this property
storage\_config?: UnionMember0 {access\_key, auth\_method, bucket, 9 more } | UnionMember1 {access\_key, region, auth\_method, 9 more } | UnionMember2 {private\_key, access\_key, auth\_method, 9 more } | UnionMember3 {password, access\_key, auth\_method, 9 more } | null One of the following:
UnionMember0 {access\_key, auth\_method, bucket, 9 more } access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property
auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium One of the following: "KEY" Link to this property "PASSWORD" Link to this property
Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type?: "gcs" Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember1 {access\_key, region, auth\_method, 9 more } access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property
auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium One of the following: "KEY" Link to this property "PASSWORD" Link to this property
Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean" One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember2 {private\_key, access\_key, auth\_method, 9 more } private\_key: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method?: "KEY" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media. One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember3 {password, access\_key, auth\_method, 9 more } password: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method?: "PASSWORD" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media. One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config?: VideoConfig {codec, export\_file, height, 2 more }
codec?: "H264"| "VP8"| "VP9" Codec using which the recording will be encoded. One of the following: "H264" Link to this property "VP8" Link to this property "VP9" Link to this property
Link to this property export\_file?: boolean Controls whether to export video file seperately Link to this property height?: number Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark?: Watermark {position, size, url } Watermark to be added to the recording
position?: "left top"| "right top"| "left bottom"| "right bottom" Position of the watermark One of the following: "left top" Link to this property "right top" Link to this property "left bottom" Link to this property "right bottom" Link to this property
Link to this property
size?: Size {height, width } Size of the watermark height?: number Height of the watermark in px minimum1 Link to this property width?: number Width of the watermark in px minimum1 Link to this property
Link to this property url?: string URL of the watermark image formaturi Link to this property
Link to this property width?: number Width of the recording video in pixels maximum1920 minimum1 Link to this property
Link to this property
Link to this property session\_keep\_alive\_time\_in\_secs?: number Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property
status?: "ACTIVE"| "INACTIVE" Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting. One of the following: "ACTIVE" Link to this property "INACTIVE" Link to this property
Link to this property summarize\_on\_end?: boolean Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title?: string Title of the meeting. Link to this property transcribe\_on\_end?: boolean Automatically generate transcripts when the meeting ends. Link to this property
Link to this property
paging: Paging {end\_offset, start\_offset, total\_count } end\_offset: number Link to this property start\_offset: number Link to this property total\_count: number minimum0 Link to this property
Link to this property success: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_get_response%20%3E%20(schema)>)
MeetingCreateResponse {success, data } success: boolean Success status of the operation Link to this property
data?: Data {id, created\_at, updated\_at, 10 more } Data returned by the operation id: string ID of the meeting. formatuuid Link to this property created\_at: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property
ai\_config?: AIConfig {summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization?: Summarization {summary\_type, text\_format, word\_limit } Summary Config
summary\_type?: "general"| "team\_meeting"| "sales\_call"| 6 more Defines the style of the summary, such as general, team meeting, or sales call. One of the following: "general" Link to this property "team\_meeting" Link to this property "sales\_call" Link to this property "client\_check\_in" Link to this property "interview" Link to this property "daily\_standup" Link to this property "one\_on\_one\_meeting" Link to this property "lecture" Link to this property "code\_review" Link to this property
Link to this property
text\_format?: "plain\_text"| "markdown" Determines the text format of the summary, such as plain text or markdown. One of the following: "plain\_text" Link to this property "markdown" Link to this property
Link to this property word\_limit?: number Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property
Link to this property
transcription?: Transcription {keywords, language, profanity\_filter } Transcription Configurations keywords?: Array<string> Adds specific terms to improve accurate detection during transcription. Link to this property
language?: "en-US"| "en-IN"| "de"| 7 more Specifies the language code for transcription to ensure accurate results. One of the following: "en-US" Link to this property "en-IN" Link to this property "de" Link to this property "hi" Link to this property "sv" Link to this property "ru" Link to this property "pl" Link to this property "el" Link to this property "fr" Link to this property "nl" Link to this property
Link to this property profanity\_filter?: boolean Control the inclusion of offensive language in transcriptions. Link to this property
Link to this property
Link to this property live\_stream\_on\_start?: boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat?: boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start?: boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config?: RecordingConfig {audio\_config, file\_name\_prefix, live\_streaming\_config, 4 more } Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
audio\_config?: AudioConfig {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.
channel?: "mono"| "stereo" Audio signal pathway within an audio file that carries a specific sound source. One of the following: "mono" Link to this property "stereo" Link to this property
Link to this property
codec?: "MP3"| "AAC" Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis. One of the following: "MP3" Link to this property "AAC" Link to this property
Link to this property export\_file?: boolean Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix?: string Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config?: LiveStreamingConfig {rtmp\_url } rtmp\_url?: string RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds?: number Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property
realtimekit\_bucket\_config?: RealtimekitBucketConfig {enabled } enabled: boolean Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property
Link to this property
storage\_config?: UnionMember0 {access\_key, auth\_method, bucket, 9 more } | UnionMember1 {access\_key, region, auth\_method, 9 more } | UnionMember2 {private\_key, access\_key, auth\_method, 9 more } | UnionMember3 {password, access\_key, auth\_method, 9 more } | null One of the following:
UnionMember0 {access\_key, auth\_method, bucket, 9 more } access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property
auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium One of the following: "KEY" Link to this property "PASSWORD" Link to this property
Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type?: "gcs" Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember1 {access\_key, region, auth\_method, 9 more } access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property
auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium One of the following: "KEY" Link to this property "PASSWORD" Link to this property
Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean" One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember2 {private\_key, access\_key, auth\_method, 9 more } private\_key: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method?: "KEY" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media. One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember3 {password, access\_key, auth\_method, 9 more } password: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method?: "PASSWORD" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media. One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config?: VideoConfig {codec, export\_file, height, 2 more }
codec?: "H264"| "VP8"| "VP9" Codec using which the recording will be encoded. One of the following: "H264" Link to this property "VP8" Link to this property "VP9" Link to this property
Link to this property export\_file?: boolean Controls whether to export video file seperately Link to this property height?: number Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark?: Watermark {position, size, url } Watermark to be added to the recording
position?: "left top"| "right top"| "left bottom"| "right bottom" Position of the watermark One of the following: "left top" Link to this property "right top" Link to this property "left bottom" Link to this property "right bottom" Link to this property
Link to this property
size?: Size {height, width } Size of the watermark height?: number Height of the watermark in px minimum1 Link to this property width?: number Width of the watermark in px minimum1 Link to this property
Link to this property url?: string URL of the watermark image formaturi Link to this property
Link to this property width?: number Width of the recording video in pixels maximum1920 minimum1 Link to this property
Link to this property
Link to this property session\_keep\_alive\_time\_in\_secs?: number Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property
status?: "ACTIVE"| "INACTIVE" Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting. One of the following: "ACTIVE" Link to this property "INACTIVE" Link to this property
Link to this property summarize\_on\_end?: boolean Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title?: string Title of the meeting. Link to this property transcribe\_on\_end?: boolean Automatically generate transcripts when the meeting ends. Link to this property
Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_create_response%20%3E%20(schema)>)
MeetingGetMeetingByIDResponse {success, data } success: boolean Success status of the operation Link to this property
data?: Data {id, created\_at, updated\_at, 10 more } Data returned by the operation id: string ID of the meeting. formatuuid Link to this property created\_at: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property
ai\_config?: AIConfig {summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization?: Summarization {summary\_type, text\_format, word\_limit } Summary Config
summary\_type?: "general"| "team\_meeting"| "sales\_call"| 6 more Defines the style of the summary, such as general, team meeting, or sales call. One of the following: "general" Link to this property "team\_meeting" Link to this property "sales\_call" Link to this property "client\_check\_in" Link to this property "interview" Link to this property "daily\_standup" Link to this property "one\_on\_one\_meeting" Link to this property "lecture" Link to this property "code\_review" Link to this property
Link to this property
text\_format?: "plain\_text"| "markdown" Determines the text format of the summary, such as plain text or markdown. One of the following: "plain\_text" Link to this property "markdown" Link to this property
Link to this property word\_limit?: number Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property
Link to this property
transcription?: Transcription {keywords, language, profanity\_filter } Transcription Configurations keywords?: Array<string> Adds specific terms to improve accurate detection during transcription. Link to this property
language?: "en-US"| "en-IN"| "de"| 7 more Specifies the language code for transcription to ensure accurate results. One of the following: "en-US" Link to this property "en-IN" Link to this property "de" Link to this property "hi" Link to this property "sv" Link to this property "ru" Link to this property "pl" Link to this property "el" Link to this property "fr" Link to this property "nl" Link to this property
Link to this property profanity\_filter?: boolean Control the inclusion of offensive language in transcriptions. Link to this property
Link to this property
Link to this property live\_stream\_on\_start?: boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat?: boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start?: boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config?: RecordingConfig {audio\_config, file\_name\_prefix, live\_streaming\_config, 4 more } Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
audio\_config?: AudioConfig {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.
channel?: "mono"| "stereo" Audio signal pathway within an audio file that carries a specific sound source. One of the following: "mono" Link to this property "stereo" Link to this property
Link to this property
codec?: "MP3"| "AAC" Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis. One of the following: "MP3" Link to this property "AAC" Link to this property
Link to this property export\_file?: boolean Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix?: string Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config?: LiveStreamingConfig {rtmp\_url } rtmp\_url?: string RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds?: number Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property
realtimekit\_bucket\_config?: RealtimekitBucketConfig {enabled } enabled: boolean Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property
Link to this property
storage\_config?: UnionMember0 {access\_key, auth\_method, bucket, 9 more } | UnionMember1 {access\_key, region, auth\_method, 9 more } | UnionMember2 {private\_key, access\_key, auth\_method, 9 more } | UnionMember3 {password, access\_key, auth\_method, 9 more } | null One of the following:
UnionMember0 {access\_key, auth\_method, bucket, 9 more } access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property
auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium One of the following: "KEY" Link to this property "PASSWORD" Link to this property
Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type?: "gcs" Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember1 {access\_key, region, auth\_method, 9 more } access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property
auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium One of the following: "KEY" Link to this property "PASSWORD" Link to this property
Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean" One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember2 {private\_key, access\_key, auth\_method, 9 more } private\_key: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method?: "KEY" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media. One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember3 {password, access\_key, auth\_method, 9 more } password: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method?: "PASSWORD" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media. One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config?: VideoConfig {codec, export\_file, height, 2 more }
codec?: "H264"| "VP8"| "VP9" Codec using which the recording will be encoded. One of the following: "H264" Link to this property "VP8" Link to this property "VP9" Link to this property
Link to this property export\_file?: boolean Controls whether to export video file seperately Link to this property height?: number Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark?: Watermark {position, size, url } Watermark to be added to the recording
position?: "left top"| "right top"| "left bottom"| "right bottom" Position of the watermark One of the following: "left top" Link to this property "right top" Link to this property "left bottom" Link to this property "right bottom" Link to this property
Link to this property
size?: Size {height, width } Size of the watermark height?: number Height of the watermark in px minimum1 Link to this property width?: number Width of the watermark in px minimum1 Link to this property
Link to this property url?: string URL of the watermark image formaturi Link to this property
Link to this property width?: number Width of the recording video in pixels maximum1920 minimum1 Link to this property
Link to this property
Link to this property session\_keep\_alive\_time\_in\_secs?: number Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property
status?: "ACTIVE"| "INACTIVE" Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting. One of the following: "ACTIVE" Link to this property "INACTIVE" Link to this property
Link to this property summarize\_on\_end?: boolean Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title?: string Title of the meeting. Link to this property transcribe\_on\_end?: boolean Automatically generate transcripts when the meeting ends. Link to this property
Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_get_meeting_by_id_response%20%3E%20(schema)>)
MeetingUpdateMeetingByIDResponse {success, data } success: boolean Success status of the operation Link to this property
data?: Data {id, created\_at, updated\_at, 10 more } Data returned by the operation id: string ID of the meeting. formatuuid Link to this property created\_at: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property
ai\_config?: AIConfig {summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization?: Summarization {summary\_type, text\_format, word\_limit } Summary Config
summary\_type?: "general"| "team\_meeting"| "sales\_call"| 6 more Defines the style of the summary, such as general, team meeting, or sales call. One of the following: "general" Link to this property "team\_meeting" Link to this property "sales\_call" Link to this property "client\_check\_in" Link to this property "interview" Link to this property "daily\_standup" Link to this property "one\_on\_one\_meeting" Link to this property "lecture" Link to this property "code\_review" Link to this property
Link to this property
text\_format?: "plain\_text"| "markdown" Determines the text format of the summary, such as plain text or markdown. One of the following: "plain\_text" Link to this property "markdown" Link to this property
Link to this property word\_limit?: number Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property
Link to this property
transcription?: Transcription {keywords, language, profanity\_filter } Transcription Configurations keywords?: Array<string> Adds specific terms to improve accurate detection during transcription. Link to this property
language?: "en-US"| "en-IN"| "de"| 7 more Specifies the language code for transcription to ensure accurate results. One of the following: "en-US" Link to this property "en-IN" Link to this property "de" Link to this property "hi" Link to this property "sv" Link to this property "ru" Link to this property "pl" Link to this property "el" Link to this property "fr" Link to this property "nl" Link to this property
Link to this property profanity\_filter?: boolean Control the inclusion of offensive language in transcriptions. Link to this property
Link to this property
Link to this property live\_stream\_on\_start?: boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat?: boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start?: boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config?: RecordingConfig {audio\_config, file\_name\_prefix, live\_streaming\_config, 4 more } Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
audio\_config?: AudioConfig {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.
channel?: "mono"| "stereo" Audio signal pathway within an audio file that carries a specific sound source. One of the following: "mono" Link to this property "stereo" Link to this property
Link to this property
codec?: "MP3"| "AAC" Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis. One of the following: "MP3" Link to this property "AAC" Link to this property
Link to this property export\_file?: boolean Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix?: string Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config?: LiveStreamingConfig {rtmp\_url } rtmp\_url?: string RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds?: number Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property
realtimekit\_bucket\_config?: RealtimekitBucketConfig {enabled } enabled: boolean Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property
Link to this property
storage\_config?: UnionMember0 {access\_key, auth\_method, bucket, 9 more } | UnionMember1 {access\_key, region, auth\_method, 9 more } | UnionMember2 {private\_key, access\_key, auth\_method, 9 more } | UnionMember3 {password, access\_key, auth\_method, 9 more } | null One of the following:
UnionMember0 {access\_key, auth\_method, bucket, 9 more } access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property
auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium One of the following: "KEY" Link to this property "PASSWORD" Link to this property
Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type?: "gcs" Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember1 {access\_key, region, auth\_method, 9 more } access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property
auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium One of the following: "KEY" Link to this property "PASSWORD" Link to this property
Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean" One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember2 {private\_key, access\_key, auth\_method, 9 more } private\_key: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method?: "KEY" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media. One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember3 {password, access\_key, auth\_method, 9 more } password: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method?: "PASSWORD" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media. One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config?: VideoConfig {codec, export\_file, height, 2 more }
codec?: "H264"| "VP8"| "VP9" Codec using which the recording will be encoded. One of the following: "H264" Link to this property "VP8" Link to this property "VP9" Link to this property
Link to this property export\_file?: boolean Controls whether to export video file seperately Link to this property height?: number Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark?: Watermark {position, size, url } Watermark to be added to the recording
position?: "left top"| "right top"| "left bottom"| "right bottom" Position of the watermark One of the following: "left top" Link to this property "right top" Link to this property "left bottom" Link to this property "right bottom" Link to this property
Link to this property
size?: Size {height, width } Size of the watermark height?: number Height of the watermark in px minimum1 Link to this property width?: number Width of the watermark in px minimum1 Link to this property
Link to this property url?: string URL of the watermark image formaturi Link to this property
Link to this property width?: number Width of the recording video in pixels maximum1920 minimum1 Link to this property
Link to this property
Link to this property session\_keep\_alive\_time\_in\_secs?: number Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property
status?: "ACTIVE"| "INACTIVE" Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting. One of the following: "ACTIVE" Link to this property "INACTIVE" Link to this property
Link to this property summarize\_on\_end?: boolean Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title?: string Title of the meeting. Link to this property transcribe\_on\_end?: boolean Automatically generate transcripts when the meeting ends. Link to this property
Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_update_meeting_by_id_response%20%3E%20(schema)>)
MeetingReplaceMeetingByIDResponse {success, data } success: boolean Success status of the operation Link to this property
data?: Data {id, created\_at, updated\_at, 10 more } Data returned by the operation id: string ID of the meeting. formatuuid Link to this property created\_at: string Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: string Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property
ai\_config?: AIConfig {summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization?: Summarization {summary\_type, text\_format, word\_limit } Summary Config
summary\_type?: "general"| "team\_meeting"| "sales\_call"| 6 more Defines the style of the summary, such as general, team meeting, or sales call. One of the following: "general" Link to this property "team\_meeting" Link to this property "sales\_call" Link to this property "client\_check\_in" Link to this property "interview" Link to this property "daily\_standup" Link to this property "one\_on\_one\_meeting" Link to this property "lecture" Link to this property "code\_review" Link to this property
Link to this property
text\_format?: "plain\_text"| "markdown" Determines the text format of the summary, such as plain text or markdown. One of the following: "plain\_text" Link to this property "markdown" Link to this property
Link to this property word\_limit?: number Sets the maximum number of words in the meeting summary. maximum1000 minimum150 Link to this property
Link to this property
transcription?: Transcription {keywords, language, profanity\_filter } Transcription Configurations keywords?: Array<string> Adds specific terms to improve accurate detection during transcription. Link to this property
language?: "en-US"| "en-IN"| "de"| 7 more Specifies the language code for transcription to ensure accurate results. One of the following: "en-US" Link to this property "en-IN" Link to this property "de" Link to this property "hi" Link to this property "sv" Link to this property "ru" Link to this property "pl" Link to this property "el" Link to this property "fr" Link to this property "nl" Link to this property
Link to this property profanity\_filter?: boolean Control the inclusion of offensive language in transcriptions. Link to this property
Link to this property
Link to this property live\_stream\_on\_start?: boolean Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat?: boolean Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start?: boolean Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config?: RecordingConfig {audio\_config, file\_name\_prefix, live\_streaming\_config, 4 more } Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
audio\_config?: AudioConfig {channel, codec, export\_file } Object containing configuration regarding the audio that is being recorded.
channel?: "mono"| "stereo" Audio signal pathway within an audio file that carries a specific sound source. One of the following: "mono" Link to this property "stereo" Link to this property
Link to this property
codec?: "MP3"| "AAC" Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis. One of the following: "MP3" Link to this property "AAC" Link to this property
Link to this property export\_file?: boolean Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix?: string Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config?: LiveStreamingConfig {rtmp\_url } rtmp\_url?: string RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds?: number Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property
realtimekit\_bucket\_config?: RealtimekitBucketConfig {enabled } enabled: boolean Controls whether recordings are uploaded to RealtimeKit’s bucket. If set to false, download_url, audio_download_url, download_url_expiry won’t be generated for a recording. Link to this property
Link to this property
storage\_config?: UnionMember0 {access\_key, auth\_method, bucket, 9 more } | UnionMember1 {access\_key, region, auth\_method, 9 more } | UnionMember2 {private\_key, access\_key, auth\_method, 9 more } | UnionMember3 {password, access\_key, auth\_method, 9 more } | null One of the following:
UnionMember0 {access\_key, auth\_method, bucket, 9 more } access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property
auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium One of the following: "KEY" Link to this property "PASSWORD" Link to this property
Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type?: "gcs" Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember1 {access\_key, region, auth\_method, 9 more } access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property
auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium One of the following: "KEY" Link to this property "PASSWORD" Link to this property
Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean" One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember2 {private\_key, access\_key, auth\_method, 9 more } private\_key: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method?: "KEY" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media. One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
UnionMember3 {password, access\_key, auth\_method, 9 more } password: string SSH destination server password for SFTP type storage medium when auth\_method is “PASSWORD”. If auth\_method is “KEY”, this specifies the password for the ssh private key. Link to this property access\_key?: string Access key of the storage medium. Access key is not required for the gcs storage media type. Note that this field is not readable by clients, only writeable. Link to this property auth\_method?: "PASSWORD" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media. One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property
Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config?: VideoConfig {codec, export\_file, height, 2 more }
codec?: "H264"| "VP8"| "VP9" Codec using which the recording will be encoded. One of the following: "H264" Link to this property "VP8" Link to this property "VP9" Link to this property
Link to this property export\_file?: boolean Controls whether to export video file seperately Link to this property height?: number Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark?: Watermark {position, size, url } Watermark to be added to the recording
position?: "left top"| "right top"| "left bottom"| "right bottom" Position of the watermark One of the following: "left top" Link to this property "right top" Link to this property "left bottom" Link to this property "right bottom" Link to this property
Link to this property
size?: Size {height, width } Size of the watermark height?: number Height of the watermark in px minimum1 Link to this property width?: number Width of the watermark in px minimum1 Link to this property
Link to this property url?: string URL of the watermark image formaturi Link to this property
Link to this property width?: number Width of the recording video in pixels maximum1920 minimum1 Link to this property
Link to this property
Link to this property session\_keep\_alive\_time\_in\_secs?: number Time in seconds, for which a session remains active, after the last participant has left the meeting. maximum600 minimum60 Link to this property
status?: "ACTIVE"| "INACTIVE" Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting. One of the following: "ACTIVE" Link to this property "INACTIVE" Link to this property
Link to this property summarize\_on\_end?: boolean Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API. Link to this property title?: string Title of the meeting. Link to this property transcribe\_on\_end?: boolean Automatically generate transcripts when the meeting ends. Link to this property
Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_replace_meeting_by_id_response%20%3E%20(schema)>)
MeetingGetMeetingParticipantsResponse {data, paging, success }
data: Array<Data> id: string ID of the participant. formatuuid Link to this property created\_at: string When this object was created. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: string A unique participant ID generated by the client. Link to this property preset\_name: string Preset applied to the participant. Link to this property updated\_at: string When this object was updated. The time is returned in ISO format. formatdate-time Link to this property name?: string| null Name of the participant. Link to this property picture?: string| null URL to a picture of the participant. formaturi Link to this property
Link to this property
paging: Paging {end\_offset, start\_offset, total\_count } end\_offset: number Link to this property start\_offset: number Link to this property total\_count: number minimum0 Link to this property
Link to this property success: boolean Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_get_meeting_participants_response%20%3E%20(schema)>)
MeetingAddParticipantResponse {success, data } success: boolean Success status of the operation Link to this property
data?: Data {id, token, created\_at, 5 more } Represents a participant. id: string ID of the participant. formatuuid Link to this property token: string The participant’s auth token that can be used for joining a meeting from the client side. Link to this property created\_at: string When this object was created. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: string A unique participant ID generated by the client. Link to this property preset\_name: string Preset applied to the participant. Link to this property updated\_at: string When this object was updated. The time is returned in ISO format. formatdate-time Link to this property name?: string| null Name of the participant. Link to this property picture?: string| null URL to a picture of the participant. formaturi Link to this property
Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_add_participant_response%20%3E%20(schema)>)
MeetingGetMeetingParticipantResponse {data, success }
data: Data {id, created\_at, custom\_participant\_id, 4 more } Data returned by the operation id: string ID of the participant. formatuuid Link to this property created\_at: string When this object was created. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: string A unique participant ID generated by the client. Link to this property preset\_name: string Preset applied to the participant. Link to this property updated\_at: string When this object was updated. The time is returned in ISO format. formatdate-time Link to this property name?: string| null Name of the participant. Link to this property picture?: string| null URL to a picture of the participant. formaturi Link to this property
Link to this property success: boolean Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_get_meeting_participant_response%20%3E%20(schema)>)
MeetingEditParticipantResponse {success, data } success: boolean Success status of the operation Link to this property
data?: Data {id, token, created\_at, 5 more } Represents a participant. id: string ID of the participant. formatuuid Link to this property token: string The participant’s auth token that can be used for joining a meeting from the client side. Link to this property created\_at: string When this object was created. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: string A unique participant ID generated by the client. Link to this property preset\_name: string Preset applied to the participant. Link to this property updated\_at: string When this object was updated. The time is returned in ISO format. formatdate-time Link to this property name?: string| null Name of the participant. Link to this property picture?: string| null URL to a picture of the participant. formaturi Link to this property
Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_edit_participant_response%20%3E%20(schema)>)
MeetingDeleteMeetingParticipantResponse {success, data } success: boolean Success status of the operation Link to this property
data?: Data {created\_at, custom\_participant\_id, preset\_id, updated\_at } Data returned by the operation created\_at: string Timestamp this object was created at. The time is returned in ISO format. formatdate-time Link to this property custom\_participant\_id: string A unique participant ID generated by the client. Link to this property preset\_id: string ID of the preset applied to this participant. formatuuid Link to this property updated\_at: string Timestamp this object was updated at. The time is returned in ISO format. formatdate-time Link to this property
Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_delete_meeting_participant_response%20%3E%20(schema)>)
MeetingRefreshParticipantTokenResponse {data, success }
data: Data {token } Data returned by the operation token: string Regenerated participant’s authentication token. Link to this property
Link to this property success: boolean Success status of the operation Link to this property
[Link to this property](<#(resource)%20realtime_kit.meetings%20%3E%20(model)%20meeting_refresh_participant_token_response%20%3E%20(schema)>)