Skip to content
Cloudflare API
Start here
API Reference
Realtime Kit

Sessions

Fetch all sessions of an App
realtime_kit.sessions.get_sessions(strapp_id, SessionGetSessionsParams**kwargs) -> SessionGetSessionsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions
Fetch details of a session
realtime_kit.sessions.get_session_details(strsession_id, SessionGetSessionDetailsParams**kwargs) -> SessionGetSessionDetailsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}
Fetch participants list of a session
realtime_kit.sessions.get_session_participants(strsession_id, SessionGetSessionParticipantsParams**kwargs) -> SessionGetSessionParticipantsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants
Fetch details of a participant
realtime_kit.sessions.get_session_participant_details(strparticipant_id, SessionGetSessionParticipantDetailsParams**kwargs) -> SessionGetSessionParticipantDetailsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants/{participant_id}
Fetch all chat messages of a session
realtime_kit.sessions.get_session_chat(strsession_id, SessionGetSessionChatParams**kwargs) -> SessionGetSessionChatResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/chat
Fetch the complete transcript for a session
realtime_kit.sessions.get_session_transcripts(strsession_id, SessionGetSessionTranscriptsParams**kwargs) -> SessionGetSessionTranscriptsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/transcript
Fetch summary of transcripts for a session
realtime_kit.sessions.get_session_summary(strsession_id, SessionGetSessionSummaryParams**kwargs) -> SessionGetSessionSummaryResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary
Generate summary of Transcripts for the session
realtime_kit.sessions.generate_summary_of_transcripts(strsession_id, SessionGenerateSummaryOfTranscriptsParams**kwargs)
POST/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary
Fetch details of peer
realtime_kit.sessions.get_participant_data_from_peer_id(strpeer_id, SessionGetParticipantDataFromPeerIDParams**kwargs) -> SessionGetParticipantDataFromPeerIDResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/peer-report/{peer_id}
ModelsExpand Collapse
class SessionGetSessionsResponse: …
data: Optional[Data]
sessions: Optional[List[DataSession]]
id: str

ID of the session

associated_id: str

ID of the meeting this session is associated with. In the case of V2 meetings, it is always a UUID. In V1 meetings, it is a room name of the form abcdef-ghijkl

created_at: str

timestamp when session created

live_participants: float

number of participants currently in the session

max_concurrent_participants: float

number of maximum participants that were in the session

meeting_display_name: str

Title of the meeting this session belongs to

minutes_consumed: float

number of minutes consumed since the session started

organization_id: str

App id that hosted this session

started_at: str

timestamp when session started

status: Literal["LIVE", "ENDED"]

current status of session

One of the following:
"LIVE"
"ENDED"
type: Literal["meeting", "livestream", "participant"]

type of session

One of the following:
"meeting"
"livestream"
"participant"
updated_at: str

timestamp when session was last updated

breakout_rooms: Optional[List[object]]
ended_at: Optional[str]

timestamp when session ended

meta: Optional[object]

Any meta data about session.

success: Optional[bool]
class SessionGetSessionDetailsResponse: …
data: Optional[Data]
session: Optional[DataSession]
id: str

ID of the session

associated_id: str

ID of the meeting this session is associated with. In the case of V2 meetings, it is always a UUID. In V1 meetings, it is a room name of the form abcdef-ghijkl

created_at: str

timestamp when session created

live_participants: float

number of participants currently in the session

max_concurrent_participants: float

number of maximum participants that were in the session

meeting_display_name: str

Title of the meeting this session belongs to

minutes_consumed: float

number of minutes consumed since the session started

organization_id: str

App id that hosted this session

started_at: str

timestamp when session started

status: Literal["LIVE", "ENDED"]

current status of session

One of the following:
"LIVE"
"ENDED"
type: Literal["meeting", "livestream", "participant"]

type of session

One of the following:
"meeting"
"livestream"
"participant"
updated_at: str

timestamp when session was last updated

breakout_rooms: Optional[List[object]]
ended_at: Optional[str]

timestamp when session ended

meta: Optional[object]

Any meta data about session.

success: Optional[bool]
class SessionGetSessionParticipantsResponse: …
data: Optional[Data]
participants: Optional[List[DataParticipant]]
id: Optional[str]

Participant ID. This maps to the corresponding peerId.

created_at: Optional[str]

timestamp when this participant was created.

custom_participant_id: Optional[str]

ID passed by client to create this participant.

display_name: Optional[str]

Display name of participant when joining the session.

duration: Optional[float]

number of minutes for which the participant was in the session.

joined_at: Optional[str]

timestamp at which participant joined the session.

left_at: Optional[str]

timestamp at which participant left the session.

preset_name: Optional[str]

Name of the preset associated with the participant.

updated_at: Optional[str]

timestamp when this participant's data was last updated.

user_id: Optional[str]

User id for this participant.

success: Optional[bool]
class SessionGetSessionParticipantDetailsResponse: …
data: Optional[Data]
participant: Optional[DataParticipant]
id: Optional[str]

Participant ID. This maps to the corresponding peerId.

created_at: Optional[str]

timestamp when this participant was created.

custom_participant_id: Optional[str]

ID passed by client to create this participant.

display_name: Optional[str]

Display name of participant when joining the session.

duration: Optional[float]

number of minutes for which the participant was in the session.

joined_at: Optional[str]

timestamp at which participant joined the session.

left_at: Optional[str]

timestamp at which participant left the session.

peer_stats: Optional[DataParticipantPeerStats]
config: Optional[str]
device_info: Optional[DataParticipantPeerStatsDeviceInfo]
browser: Optional[str]
browser_version: Optional[str]
cpus: Optional[float]
engine: Optional[str]
is_mobile: Optional[bool]
memory: Optional[float]
os: Optional[str]
os_version: Optional[str]
sdk_name: Optional[str]
sdk_version: Optional[str]
user_agent: Optional[str]
webgl_support: Optional[str]
events: Optional[List[DataParticipantPeerStatsEvent]]
timestamp: Optional[str]
type: Optional[str]
ip_information: Optional[DataParticipantPeerStatsIPInformation]
city: Optional[str]
country: Optional[str]
ip_location: Optional[str]
ipv4: Optional[str]
org: Optional[str]
portal: Optional[str]
region: Optional[str]
timezone: Optional[str]
precall_network_information: Optional[DataParticipantPeerStatsPrecallNetworkInformation]
backend_rtt: Optional[float]
effective_networktype: Optional[str]
fractional_loss: Optional[float]
jitter: Optional[float]
reflexive_connectivity: Optional[bool]
relay_connectivity: Optional[bool]
rtt: Optional[float]
throughtput: Optional[float]
turn_connectivity: Optional[bool]
status: Optional[str]
preset_name: Optional[str]

Name of the preset associated with the participant.

quality_stats: Optional[List[DataParticipantQualityStat]]
audio_bandwidth: Optional[float]
audio_packet_loss: Optional[float]
audio_stats: Optional[List[DataParticipantQualityStatAudioStat]]
concealment_events: Optional[float]
jitter: Optional[float]
packets_lost: Optional[float]
quality: Optional[float]
timestamp: Optional[str]
average_quality: Optional[float]
end: Optional[str]
peer_id: Optional[str]
start: Optional[str]
video_bandwidth: Optional[float]
video_packet_loss: Optional[float]
video_stats: Optional[List[DataParticipantQualityStatVideoStat]]
frame_height: Optional[float]
frame_width: Optional[float]
frames_dropped: Optional[float]
frames_per_second: Optional[float]
jitter: Optional[float]
packets_lost: Optional[float]
quality: Optional[float]
timestamp: Optional[str]
updated_at: Optional[str]

timestamp when this participant's data was last updated.

user_id: Optional[str]

User id for this participant.

success: Optional[bool]
class SessionGetSessionChatResponse: …
data: Optional[Data]
chat_download_url: str

URL where the chat logs can be downloaded

chat_download_url_expiry: str

Time when the download URL will expire

success: Optional[bool]
class SessionGetSessionTranscriptsResponse: …
data: Optional[Data]
session_id: str
transcript_download_url: str

URL where the transcript can be downloaded

transcript_download_url_expiry: str

Time when the download URL will expire

success: Optional[bool]
class SessionGetSessionSummaryResponse: …
data: Optional[Data]
session_id: str
summary_download_url: str

URL where the summary of transcripts can be downloaded

summary_download_url_expiry: str

Time of Expiry before when you need to download the csv file.

success: Optional[bool]
class SessionGetParticipantDataFromPeerIDResponse: …
data: Optional[Data]
participant: Optional[DataParticipant]
id: Optional[str]
created_at: Optional[str]
custom_participant_id: Optional[str]
display_name: Optional[str]
duration: Optional[float]
joined_at: Optional[str]
left_at: Optional[str]
peer_report: Optional[DataParticipantPeerReport]
metadata: Optional[DataParticipantPeerReportMetadata]
audio_devices_updates: Optional[List[object]]
browser_metadata: Optional[DataParticipantPeerReportMetadataBrowserMetadata]
browser: Optional[str]
browser_version: Optional[str]
engine: Optional[str]
user_agent: Optional[str]
webgl_support: Optional[str]
candidate_pairs: Optional[DataParticipantPeerReportMetadataCandidatePairs]
consuming_transport: Optional[List[object]]
producing_transport: Optional[List[DataParticipantPeerReportMetadataCandidatePairsProducingTransport]]
available_outgoing_bitrate: Optional[int]
bytes_discarded_on_send: Optional[int]
bytes_received: Optional[int]
bytes_sent: Optional[int]
current_round_trip_time: Optional[float]
last_packet_received_timestamp: Optional[int]
last_packet_sent_timestamp: Optional[int]
local_candidate_address: Optional[str]
local_candidate_id: Optional[str]
local_candidate_network_type: Optional[str]
local_candidate_port: Optional[int]
local_candidate_protocol: Optional[str]
local_candidate_type: Optional[str]
nominated: Optional[bool]
packets_discarded_on_send: Optional[int]
packets_received: Optional[int]
packets_sent: Optional[int]
remote_candidate_address: Optional[str]
remote_candidate_id: Optional[str]
remote_candidate_port: Optional[int]
remote_candidate_protocol: Optional[str]
remote_candidate_type: Optional[str]
total_round_trip_time: Optional[float]
device_info: Optional[DataParticipantPeerReportMetadataDeviceInfo]
cpus: Optional[int]
is_mobile: Optional[bool]
os: Optional[str]
os_version: Optional[str]
events: Optional[List[DataParticipantPeerReportMetadataEvent]]
name: Optional[str]
timestamp: Optional[str]
ip_information: Optional[DataParticipantPeerReportMetadataIPInformation]
asn: Optional[DataParticipantPeerReportMetadataIPInformationASN]
asn: Optional[str]
city: Optional[str]
country: Optional[str]
ipv4: Optional[str]
region: Optional[str]
timezone: Optional[str]
pc_metadata: Optional[List[DataParticipantPeerReportMetadataPcMetadata]]
effective_network_type: Optional[str]
reflexive_connectivity: Optional[bool]
relay_connectivity: Optional[bool]
timestamp: Optional[str]
turn_connectivity: Optional[bool]
room_view_type: Optional[str]
sdk_name: Optional[str]
sdk_version: Optional[str]
selected_device_updates: Optional[List[object]]
speaker_devices_updates: Optional[List[object]]
video_devices_updates: Optional[List[object]]
quality: Optional[DataParticipantPeerReportQuality]
audio_consumer: Optional[List[object]]
audio_consumer_cumulative: Optional[object]
audio_producer: Optional[List[DataParticipantPeerReportQualityAudioProducer]]
bytes_sent: Optional[int]
jitter: Optional[int]
mid: Optional[str]
mos_quality: Optional[int]
packets_lost: Optional[int]
packets_sent: Optional[int]
producer_id: Optional[str]
rtt: Optional[float]
ssrc: Optional[int]
timestamp: Optional[str]
audio_producer_cumulative: Optional[DataParticipantPeerReportQualityAudioProducerCumulative]
packet_loss: Optional[DataParticipantPeerReportQualityAudioProducerCumulativePacketLoss]
_10_or_greater_event_fraction: Optional[int]
_25_or_greater_event_fraction: Optional[int]
_5_or_greater_event_fraction: Optional[int]
_50_or_greater_event_fraction: Optional[int]
avg: Optional[int]
quality_mos: Optional[DataParticipantPeerReportQualityAudioProducerCumulativeQualityMos]
avg: Optional[int]
p50: Optional[int]
p75: Optional[int]
p90: Optional[int]
rtt: Optional[DataParticipantPeerReportQualityAudioProducerCumulativeRTT]
_100ms_or_greater_event_fraction: Optional[float]
_250ms_or_greater_event_fraction: Optional[float]
_500ms_or_greater_event_fraction: Optional[float]
avg: Optional[float]
screenshare_audio_consumer: Optional[List[object]]
screenshare_audio_consumer_cumulative: Optional[object]
screenshare_audio_producer: Optional[List[object]]
screenshare_audio_producer_cumulative: Optional[object]
screenshare_video_consumer: Optional[List[object]]
screenshare_video_consumer_cumulative: Optional[object]
screenshare_video_producer: Optional[List[object]]
screenshare_video_producer_cumulative: Optional[object]
video_consumer: Optional[List[object]]
video_consumer_cumulative: Optional[object]
video_producer: Optional[List[object]]
video_producer_cumulative: Optional[object]
peer_stats: Optional[DataParticipantPeerStats]
device_info: Optional[DataParticipantPeerStatsDeviceInfo]
browser: Optional[str]
browser_version: Optional[str]
cpus: Optional[int]
engine: Optional[str]
is_mobile: Optional[bool]
os: Optional[str]
os_version: Optional[str]
sdk_name: Optional[str]
sdk_version: Optional[str]
user_agent: Optional[str]
webgl_support: Optional[str]
events: Optional[List[DataParticipantPeerStatsEvent]]
metadata: Optional[DataParticipantPeerStatsEventMetadata]
connection_info: Optional[DataParticipantPeerStatsEventMetadataConnectionInfo]
backend_r_t_t: Optional[float]
connectivity: Optional[DataParticipantPeerStatsEventMetadataConnectionInfoConnectivity]
host: Optional[bool]
reflexive: Optional[bool]
relay: Optional[bool]
effective_network_type: Optional[str]
fractional_loss: Optional[int]
ip_details: Optional[DataParticipantPeerStatsEventMetadataConnectionInfoIPDetails]
asn: Optional[DataParticipantPeerStatsEventMetadataConnectionInfoIPDetailsASN]
asn: Optional[str]
city: Optional[str]
country: Optional[str]
ip: Optional[str]
loc: Optional[str]
postal: Optional[str]
region: Optional[str]
timezone: Optional[str]
jitter: Optional[int]
location: Optional[DataParticipantPeerStatsEventMetadataConnectionInfoLocation]
coords: Optional[DataParticipantPeerStatsEventMetadataConnectionInfoLocationCoords]
latitude: Optional[float]
longitude: Optional[float]
r_t_t: Optional[float]
throughput: Optional[int]
turn_connectivity: Optional[bool]
timestamp: Optional[str]
type: Optional[str]
ip_information: Optional[DataParticipantPeerStatsIPInformation]
asn: Optional[DataParticipantPeerStatsIPInformationASN]
asn: Optional[str]
city: Optional[str]
country: Optional[str]
ip_location: Optional[str]
ipv4: Optional[str]
org: Optional[str]
region: Optional[str]
timezone: Optional[str]
precall_network_information: Optional[DataParticipantPeerStatsPrecallNetworkInformation]
backend_rtt: Optional[float]
effective_networktype: Optional[str]
fractional_loss: Optional[int]
jitter: Optional[int]
reflexive_connectivity: Optional[bool]
relay_connectivity: Optional[bool]
rtt: Optional[float]
throughput: Optional[int]
turn_connectivity: Optional[bool]
quality_stats: Optional[DataParticipantQualityStats]
audio_bandwidth: Optional[int]
audio_stats: Optional[List[object]]
average_quality: Optional[int]
end: Optional[str]
first_audio_packet_received: Optional[str]
first_video_packet_received: Optional[str]
last_audio_packet_received: Optional[str]
last_video_packet_received: Optional[str]
peer_ids: Optional[List[str]]
start: Optional[str]
total_audio_packets: Optional[int]
total_audio_packets_lost: Optional[int]
total_video_packets: Optional[int]
total_video_packets_lost: Optional[int]
video_bandwidth: Optional[int]
video_stats: Optional[List[object]]
role: Optional[str]
updated_at: Optional[str]
user_id: Optional[str]
success: Optional[bool]