API Reference

Realtime Kit

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Sessions

Fetch all sessions of an App

client.realtimeKit.sessions.getSessions(stringappId, SessionGetSessionsParams { account_id, associated_id, end_time, 8 more } params, RequestOptionsoptions?): SessionGetSessionsResponse { data, paging, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions

Fetch details of a session

client.realtimeKit.sessions.getSessionDetails(stringappId, stringsessionId, SessionGetSessionDetailsParams { account_id, include_breakout_rooms } params, RequestOptionsoptions?): SessionGetSessionDetailsResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}

Fetch participants list of a session

client.realtimeKit.sessions.getSessionParticipants(stringappId, stringsessionId, SessionGetSessionParticipantsParams { account_id, include_peer_events, page_no, 5 more } params, RequestOptionsoptions?): SessionGetSessionParticipantsResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants

Fetch details of a participant

client.realtimeKit.sessions.getSessionParticipantDetails(stringappId, stringsessionId, stringparticipantId, SessionGetSessionParticipantDetailsParams { account_id, filters, include_peer_events } params, RequestOptionsoptions?): SessionGetSessionParticipantDetailsResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants/{participant_id}

Fetch all chat messages of a session

client.realtimeKit.sessions.getSessionChat(stringappId, stringsessionId, SessionGetSessionChatParams { account_id } params, RequestOptionsoptions?): SessionGetSessionChatResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/chat

Fetch the complete transcript for a session

client.realtimeKit.sessions.getSessionTranscripts(stringappId, stringsessionId, SessionGetSessionTranscriptsParams { account_id } params, RequestOptionsoptions?): SessionGetSessionTranscriptsResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/transcript

Fetch summary of transcripts for a session

client.realtimeKit.sessions.getSessionSummary(stringappId, stringsessionId, SessionGetSessionSummaryParams { account_id } params, RequestOptionsoptions?): SessionGetSessionSummaryResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary

Generate summary of Transcripts for the session

client.realtimeKit.sessions.generateSummaryOfTranscripts(stringappId, stringsessionId, SessionGenerateSummaryOfTranscriptsParams { account_id } params, RequestOptionsoptions?): void

POST/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary

Fetch details of peer

client.realtimeKit.sessions.getParticipantDataFromPeerId(stringappId, stringpeerId, SessionGetParticipantDataFromPeerIDParams { account_id, filters } params, RequestOptionsoptions?): SessionGetParticipantDataFromPeerIDResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/peer-report/{peer_id}

ModelsExpand Collapse

SessionGetSessionsResponse { data, paging, success }

data?: Data { sessions }

sessions?: Array<Session>

id: string

ID of the session

associated_id: string

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

created_at: string

timestamp when session created

live_participants: number

number of participants currently in the session

max_concurrent_participants: number

number of maximum participants that were in the session

meeting_display_name: string

Title of the meeting this session belongs to

minutes_consumed: number

number of minutes consumed since the session started

organization_id: string

App id that hosted this session

started_at: string

timestamp when session started

status: "LIVE" | "ENDED"

current status of session

One of the following:

"LIVE"

"ENDED"

type: "meeting" | "livestream" | "participant"

type of session

One of the following:

"meeting"

"livestream"

"participant"

updated_at: string

timestamp when session was last updated

breakout_rooms?: Array<unknown>

ended_at?: string

timestamp when session ended

meta?: unknown

Any meta data about session.

paging?: Paging { end_offset, start_offset, total_count }

end_offset?: number

start_offset?: number

total_count?: number

minimum0

success?: boolean

SessionGetSessionDetailsResponse { data, success }

data?: Data { id, associated_id, created_at, 12 more }

id: string

ID of the session

associated_id: string

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

created_at: string

timestamp when session created

live_participants: number

number of participants currently in the session

max_concurrent_participants: number

number of maximum participants that were in the session

meeting_display_name: string

Title of the meeting this session belongs to

minutes_consumed: number

number of minutes consumed since the session started

organization_id: string

App id that hosted this session

started_at: string

timestamp when session started

status: "LIVE" | "ENDED"

current status of session

One of the following:

"LIVE"

"ENDED"

type: "meeting" | "livestream" | "participant"

type of session

One of the following:

"meeting"

"livestream"

"participant"

updated_at: string

timestamp when session was last updated

breakout_rooms?: Array<unknown>

ended_at?: string

timestamp when session ended

meta?: unknown

Any meta data about session.

success?: boolean

SessionGetSessionParticipantsResponse { data, success }

data?: Data { participants }

participants?: Array<Participant>

id?: string

Participant ID. This maps to the corresponding peerId.

created_at?: string

timestamp when this participant was created.

custom_participant_id?: string

ID passed by client to create this participant.

display_name?: string

Display name of participant when joining the session.

duration?: number

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

joined_at?: string

timestamp at which participant joined the session.

left_at?: string

timestamp at which participant left the session.

preset_name?: string

Name of the preset associated with the participant.

updated_at?: string

timestamp when this participant’s data was last updated.

user_id?: string

User id for this participant.

success?: boolean

SessionGetSessionParticipantDetailsResponse { data, success }

data?: Data { participant }

participant?: Participant { id, created_at, custom_participant_id, 7 more }

id?: string

Participant ID. This maps to the corresponding peerId.

created_at?: string

timestamp when this participant was created.

custom_participant_id?: string

ID passed by client to create this participant.

display_name?: string

Display name of participant when joining the session.

duration?: number

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

joined_at?: string

timestamp at which participant joined the session.

left_at?: string

timestamp at which participant left the session.

preset_name?: string

Name of the preset associated with the participant.

updated_at?: string

timestamp when this participant’s data was last updated.

user_id?: string

User id for this participant.

success?: boolean

SessionGetSessionChatResponse { data, success }

data?: Data { chat_download_url, chat_download_url_expiry }

chat_download_url: string

URL where the chat logs can be downloaded

chat_download_url_expiry: string

Time when the download URL will expire

success?: boolean

SessionGetSessionTranscriptsResponse { data, success }

data?: Data { sessionId, transcript_download_url, transcript_download_url_expiry }

sessionId: string

transcript_download_url: string

URL where the transcript can be downloaded

transcript_download_url_expiry: string

Time when the download URL will expire

success?: boolean

SessionGetSessionSummaryResponse { data, success }

data?: Data { sessionId, summaryDownloadUrl, summaryDownloadUrlExpiry }

sessionId: string

summaryDownloadUrl: string

URL where the summary of transcripts can be downloaded

summaryDownloadUrlExpiry: string

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

success?: boolean

SessionGetParticipantDataFromPeerIDResponse { data, success }

data?: Data { id, created_at, custom_participant_id, 10 more }

id?: string

Participant ID. This maps to the corresponding peerId.

created_at?: string

timestamp when this participant was created.

custom_participant_id?: string

ID passed by client to create this participant.

display_name?: string

Display name of participant when joining the session.

duration?: number

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

joined_at?: string

timestamp at which participant joined the session.

left_at?: string

timestamp at which participant left the session.

peer_events?: Array<Record<string, unknown>>

peer_report?: PeerReport { metadata, quality }

Peer call statistics report.

metadata?: Record<string, unknown>

quality?: Record<string, unknown>

preset_name?: string

Name of the preset associated with the participant.

session_id?: string

formatuuid

updated_at?: string

timestamp when this participant’s data was last updated.

user_id?: string

User id for this participant.

success?: boolean