Realtime Kit
Realtime KitApps
Fetch all apps
Create App
ModelsExpand Collapse
Realtime KitMeetings
Fetch all meetings for an App
Create a meeting
Fetch a meeting for an App
Update a meeting
Replace a meeting
Fetch all participants of a meeting
Add a participant
Fetch a participant's detail
Edit a participant's detail
Delete a participant
Refresh participant's authentication token
ModelsExpand Collapse
MeetingGetResponse { data, paging, success }
data: array of { id, created_at, updated_at, 7 more }
Timestamp the object was created at. The time is returned in ISO format.
Timestamp the object was updated at. The time is returned in ISO format.
Specifies if the meeting should start getting livestreamed on start.
Specifies if the meeting should start getting recorded as soon as someone joins the meeting.
Time in seconds, for which a session remains active, after the last participant has left the meeting.
status: optional "ACTIVE" or "INACTIVE"Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
MeetingCreateResponse { success, data }
data: optional { id, created_at, updated_at, 9 more } Data returned by the operation
Data returned by the operation
Timestamp the object was created at. The time is returned in ISO format.
Timestamp the object was updated at. The time is returned in ISO format.
ai_config: optional { summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries
The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization: optional { summary_type, text_format, word_limit } Summary Config
Summary Config
transcription: optional { keywords, language, profanity_filter } Transcription Configurations
Transcription Configurations
Specifies if the meeting should start getting livestreamed on start.
Specifies if the meeting should start getting recorded as soon as someone joins the meeting.
recording_config: optional { 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.
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 { channel, codec, export_file } Object containing configuration regarding the audio that is being recorded.
Object containing configuration regarding the audio that is being recorded.
channel: optional "mono" or "stereo"Audio signal pathway within an audio file that carries a specific sound source.
Audio signal pathway within an audio file that carries a specific sound source.
Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours.
storage_config: optional { type, access_key, auth_method, 9 more }
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.
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.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
video_config: optional { codec, export_file, height, 2 more }
Time in seconds, for which a session remains active, after the last participant has left the meeting.
status: optional "ACTIVE" or "INACTIVE"Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
MeetingGetMeetingByIDResponse { success, data }
data: optional { id, created_at, updated_at, 9 more } Data returned by the operation
Data returned by the operation
Timestamp the object was created at. The time is returned in ISO format.
Timestamp the object was updated at. The time is returned in ISO format.
ai_config: optional { summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries
The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization: optional { summary_type, text_format, word_limit } Summary Config
Summary Config
transcription: optional { keywords, language, profanity_filter } Transcription Configurations
Transcription Configurations
Specifies if the meeting should start getting livestreamed on start.
Specifies if the meeting should start getting recorded as soon as someone joins the meeting.
recording_config: optional { 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.
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 { channel, codec, export_file } Object containing configuration regarding the audio that is being recorded.
Object containing configuration regarding the audio that is being recorded.
channel: optional "mono" or "stereo"Audio signal pathway within an audio file that carries a specific sound source.
Audio signal pathway within an audio file that carries a specific sound source.
Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours.
storage_config: optional { type, access_key, auth_method, 9 more }
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.
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.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
video_config: optional { codec, export_file, height, 2 more }
Time in seconds, for which a session remains active, after the last participant has left the meeting.
status: optional "ACTIVE" or "INACTIVE"Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
MeetingUpdateMeetingByIDResponse { success, data }
data: optional { id, created_at, updated_at, 9 more } Data returned by the operation
Data returned by the operation
Timestamp the object was created at. The time is returned in ISO format.
Timestamp the object was updated at. The time is returned in ISO format.
ai_config: optional { summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries
The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization: optional { summary_type, text_format, word_limit } Summary Config
Summary Config
transcription: optional { keywords, language, profanity_filter } Transcription Configurations
Transcription Configurations
Specifies if the meeting should start getting livestreamed on start.
Specifies if the meeting should start getting recorded as soon as someone joins the meeting.
recording_config: optional { 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.
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 { channel, codec, export_file } Object containing configuration regarding the audio that is being recorded.
Object containing configuration regarding the audio that is being recorded.
channel: optional "mono" or "stereo"Audio signal pathway within an audio file that carries a specific sound source.
Audio signal pathway within an audio file that carries a specific sound source.
Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours.
storage_config: optional { type, access_key, auth_method, 9 more }
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.
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.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
video_config: optional { codec, export_file, height, 2 more }
Time in seconds, for which a session remains active, after the last participant has left the meeting.
status: optional "ACTIVE" or "INACTIVE"Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
MeetingReplaceMeetingByIDResponse { success, data }
data: optional { id, created_at, updated_at, 9 more } Data returned by the operation
Data returned by the operation
Timestamp the object was created at. The time is returned in ISO format.
Timestamp the object was updated at. The time is returned in ISO format.
ai_config: optional { summarization, transcription } The AI Config allows you to customize the behavior of meeting transcriptions and summaries
The AI Config allows you to customize the behavior of meeting transcriptions and summaries
summarization: optional { summary_type, text_format, word_limit } Summary Config
Summary Config
transcription: optional { keywords, language, profanity_filter } Transcription Configurations
Transcription Configurations
Specifies if the meeting should start getting livestreamed on start.
Specifies if the meeting should start getting recorded as soon as someone joins the meeting.
recording_config: optional { 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.
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 { channel, codec, export_file } Object containing configuration regarding the audio that is being recorded.
Object containing configuration regarding the audio that is being recorded.
channel: optional "mono" or "stereo"Audio signal pathway within an audio file that carries a specific sound source.
Audio signal pathway within an audio file that carries a specific sound source.
Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours.
storage_config: optional { type, access_key, auth_method, 9 more }
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.
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.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
video_config: optional { codec, export_file, height, 2 more }
Time in seconds, for which a session remains active, after the last participant has left the meeting.
status: optional "ACTIVE" or "INACTIVE"Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
Realtime KitPresets
Fetch all presets
Create a preset
Fetch details of a preset
Delete a preset
Update a preset
ModelsExpand Collapse
PresetCreateResponse { data, success }
data: { id, config, name, 2 more } Data returned by the operation
Data returned by the operation
config: { max_screenshare_count, max_video_streams, media, view_type }
ui: { design_tokens, config_diff }
permissions: optional { accept_waiting_requests, can_accept_production_requests, can_change_participant_permissions, 19 more }
connected_meetings: { can_alter_connected_meetings, can_switch_connected_meetings, can_switch_to_parent_meeting }
media: { audio, screenshare, video } Media permissions
Media permissions
PresetGetPresetByIDResponse { data, success }
data: { id, config, name, 2 more } Data returned by the operation
Data returned by the operation
config: { max_screenshare_count, max_video_streams, media, view_type }
ui: { design_tokens, config_diff }
permissions: optional { accept_waiting_requests, can_accept_production_requests, can_change_participant_permissions, 19 more }
connected_meetings: { can_alter_connected_meetings, can_switch_connected_meetings, can_switch_to_parent_meeting }
media: { audio, screenshare, video } Media permissions
Media permissions
PresetDeleteResponse { data, success }
data: { id, config, name, 2 more } Data returned by the operation
Data returned by the operation
config: { max_screenshare_count, max_video_streams, media, view_type }
ui: { design_tokens, config_diff }
permissions: optional { accept_waiting_requests, can_accept_production_requests, can_change_participant_permissions, 19 more }
connected_meetings: { can_alter_connected_meetings, can_switch_connected_meetings, can_switch_to_parent_meeting }
media: { audio, screenshare, video } Media permissions
Media permissions
PresetUpdateResponse { data, success }
data: { id, config, name, 2 more } Data returned by the operation
Data returned by the operation
config: { max_screenshare_count, max_video_streams, media, view_type }
ui: { design_tokens, config_diff }
permissions: optional { accept_waiting_requests, can_accept_production_requests, can_change_participant_permissions, 19 more }
connected_meetings: { can_alter_connected_meetings, can_switch_connected_meetings, can_switch_to_parent_meeting }
media: { audio, screenshare, video } Media permissions
Media permissions
Realtime KitSessions
Fetch all sessions of an App
Fetch details of a session
Fetch participants list of a session
Fetch details of a participant
Fetch all chat messages of a session
Fetch the complete transcript for a session
Fetch summary of transcripts for a session
Generate summary of Transcripts for the session
Fetch details of peer
ModelsExpand Collapse
SessionGetSessionsResponse { data, success }
data: optional { sessions }
sessions: optional array of { id, associated_id, created_at, 12 more }
SessionGetSessionDetailsResponse { data, success }
data: optional { session }
session: optional { id, associated_id, created_at, 12 more }
SessionGetSessionParticipantDetailsResponse { data, success }
data: optional { participant }
participant: optional { id, created_at, custom_participant_id, 9 more }
peer_stats: optional { config, device_info, events, 3 more }
SessionGetParticipantDataFromPeerIDResponse { data, success }
data: optional { participant }
participant: optional { id, created_at, custom_participant_id, 10 more }
peer_report: optional { metadata, quality }
metadata: optional { audio_devices_updates, browser_metadata, candidate_pairs, 10 more }
candidate_pairs: optional { consuming_transport, producing_transport }
quality: optional { audio_consumer, audio_consumer_cumulative, audio_producer, 13 more }
peer_stats: optional { device_info, events, ip_information, precall_network_information }
events: optional array of { metadata, timestamp, type }
Realtime KitRecordings
Fetch all recordings for an App
Start recording a meeting
Fetch active recording
Fetch details of a recording
Pause/Resume/Stop recording
Start recording audio and video tracks
ModelsExpand Collapse
RecordingGetRecordingsResponse { data, paging, success }
data: array of { id, audio_download_url, download_url, 11 more }
If the audio_config is passed, the URL for downloading the audio recording is returned.
Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time.
Timestamp when this recording was stopped. Optional; is present only when the recording has actually been stopped.
meeting: optional { id, created_at, updated_at, 7 more }
Timestamp the object was created at. The time is returned in ISO format.
Timestamp the object was updated at. The time is returned in ISO format.
Specifies if the meeting should start getting livestreamed on start.
Specifies if the meeting should start getting recorded as soon as someone joins the meeting.
Time in seconds, for which a session remains active, after the last participant has left the meeting.
status: optional "ACTIVE" or "INACTIVE"Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
storage_config: optional { type, access_key, auth_method, 9 more }
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.
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.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
RecordingStartRecordingsResponse { success, data }
data: optional { id, audio_download_url, download_url, 12 more } Data returned by the operation
Data returned by the operation
If the audio_config is passed, the URL for downloading the audio recording is returned.
Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time.
Timestamp when this recording was stopped. Optional; is present only when the recording has actually been stopped.
start_reason: optional { caller, reason }
caller: optional { name, type, user_Id }
stop_reason: optional { caller, reason }
storage_config: optional { type, access_key, auth_method, 9 more }
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.
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.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
RecordingGetActiveRecordingsResponse { data, success }
data: { id, audio_download_url, download_url, 9 more } Data returned by the operation
Data returned by the operation
If the audio_config is passed, the URL for downloading the audio recording is returned.
Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time.
RecordingGetOneRecordingResponse { success, data }
data: optional { id, audio_download_url, download_url, 12 more } Data returned by the operation
Data returned by the operation
If the audio_config is passed, the URL for downloading the audio recording is returned.
Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time.
Timestamp when this recording was stopped. Optional; is present only when the recording has actually been stopped.
start_reason: optional { caller, reason }
caller: optional { name, type, user_Id }
stop_reason: optional { caller, reason }
storage_config: optional { type, access_key, auth_method, 9 more }
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.
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.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
RecordingPauseResumeStopRecordingResponse { success, data }
data: optional { id, audio_download_url, download_url, 12 more } Data returned by the operation
Data returned by the operation
If the audio_config is passed, the URL for downloading the audio recording is returned.
Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time.
Timestamp when this recording was stopped. Optional; is present only when the recording has actually been stopped.
start_reason: optional { caller, reason }
caller: optional { name, type, user_Id }
stop_reason: optional { caller, reason }
storage_config: optional { type, access_key, auth_method, 9 more }
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.
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.
Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is “KEY”
Realtime KitWebhooks
Fetch all webhooks details
Add a webhook
Fetch details of a webhook
Replace a webhook
Edit a webhook
Delete a webhook
ModelsExpand Collapse
Realtime KitActive Session
Fetch details of an active session
Kick participants from an active session
Kick all participants
Create a poll
ModelsExpand Collapse
ActiveSessionGetActiveSessionResponse { data, success }
data: optional { id, associated_id, created_at, 12 more }
Realtime KitLivestreams
Create an independent livestream
Fetch all livestreams
Stop livestreaming a meeting
Start livestreaming a meeting
Fetch complete analytics data for your livestreams
Fetch day-wise session and recording analytics data for an App
Fetch active livestreams for a meeting
Fetch livestream session details using livestream session ID
Fetch active livestream session details
Fetch livestream details using livestream ID
ModelsExpand Collapse
LivestreamGetAllLivestreamsResponse { data, success }
data: optional { id, created_at, disabled, 8 more }
Timestamp the object was created at. The time is returned in ISO format.
The server URL to which the RTMP encoder sends the video and audio data.
LivestreamGetOrgAnalyticsResponse { data, success }
data: optional { recording_stats, session_stats }
recording_stats: optional { day_stats, recording_count, recording_minutes_consumed } Recording statistics of an App during the range specified
Recording statistics of an App during the range specified
LivestreamGetMeetingActiveLivestreamsResponse { data, success }
data: optional { id, created_at, disabled, 7 more }
LivestreamGetLivestreamSessionDetailsForSessionIDResponse { data, success }
LivestreamGetActiveLivestreamsForLivestreamIDResponse { data, success }
data: optional { livestream, session }
livestream: optional { id, created_at, disabled, 7 more }
session: optional { id, created_at, err_message, 7 more }
Timestamp the object was created at. The time is returned in ISO format.
The time duration for which the input was given or the meeting was streamed.
Timestamp the object was invoked. The time is returned in ISO format.
Timestamp the object was started. The time is returned in ISO format.
Timestamp the object was stopped. The time is returned in ISO format.
LivestreamGetLivestreamSessionForLivestreamIDResponse { data, success }
data: optional { livestream, paging, session }
livestream: optional { id, created_at, disabled, 7 more }
session: optional { id, created_at, err_message, 7 more }
Timestamp the object was created at. The time is returned in ISO format.
The time duration for which the input was given or the meeting was streamed.
Timestamp the object was invoked. The time is returned in ISO format.
Timestamp the object was started. The time is returned in ISO format.
Timestamp the object was stopped. The time is returned in ISO format.
Realtime KitAnalytics
Fetch day-wise session and recording analytics data for an App
ModelsExpand Collapse
AnalyticsGetOrgAnalyticsResponse { data, success }
data: optional { recording_stats, session_stats }
recording_stats: optional { day_stats, recording_count, recording_minutes_consumed } Recording statistics of an App during the range specified
Recording statistics of an App during the range specified