API Reference

Realtime Kit

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Livestreams

Create an independent livestream

client.realtimeKit.livestreams.createIndependentLivestream(stringappId, LivestreamCreateIndependentLivestreamParams { account_id, name } params, RequestOptionsoptions?): LivestreamCreateIndependentLivestreamResponse { data, success }

POST/accounts/{account_id}/realtime/kit/{app_id}/livestreams

Fetch all livestreams

client.realtimeKit.livestreams.getAllLivestreams(stringappId, LivestreamGetAllLivestreamsParams { account_id, end_time, exclude_meetings, 5 more } params, RequestOptionsoptions?): LivestreamGetAllLivestreamsResponse { data, success }

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

Stop livestreaming a meeting

client.realtimeKit.livestreams.stopLivestreamingAMeeting(stringappId, stringmeetingId, LivestreamStopLivestreamingAMeetingParams { account_id } params, RequestOptionsoptions?): LivestreamStopLivestreamingAMeetingResponse { data, success }

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream/stop

Start livestreaming a meeting

client.realtimeKit.livestreams.startLivestreamingAMeeting(stringappId, stringmeetingId, LivestreamStartLivestreamingAMeetingParams { account_id, name, video_config } params, RequestOptionsoptions?): LivestreamStartLivestreamingAMeetingResponse { data, success }

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestreams

Fetch complete analytics data for your livestreams

client.realtimeKit.livestreams.getLivestreamAnalyticsComplete(stringappId, LivestreamGetLivestreamAnalyticsCompleteParams { account_id, end_time, start_time } params, RequestOptionsoptions?): LivestreamGetLivestreamAnalyticsCompleteResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/overall

Fetch day-wise session and recording analytics data for an App

client.realtimeKit.livestreams.getOrgAnalytics(stringappId, LivestreamGetOrgAnalyticsParams { account_id, end_date, start_date } params, RequestOptionsoptions?): LivestreamGetOrgAnalyticsResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/analytics/daywise

Fetch active livestreams for a meeting

client.realtimeKit.livestreams.getMeetingActiveLivestreams(stringappId, stringmeetingId, LivestreamGetMeetingActiveLivestreamsParams { account_id } params, RequestOptionsoptions?): LivestreamGetMeetingActiveLivestreamsResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream

Fetch livestream session details using livestream session ID

client.realtimeKit.livestreams.getLivestreamSessionDetailsForSessionId(stringappId, stringlivestreamSessionId, LivestreamGetLivestreamSessionDetailsForSessionIDParams { account_id } params, RequestOptionsoptions?): LivestreamGetLivestreamSessionDetailsForSessionIDResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/sessions/{livestream-session-id}

Fetch active livestream session details

client.realtimeKit.livestreams.getActiveLivestreamsForLivestreamId(stringappId, stringlivestreamId, LivestreamGetActiveLivestreamsForLivestreamIDParams { account_id } params, RequestOptionsoptions?): LivestreamGetActiveLivestreamsForLivestreamIDResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}/active-livestream-session

Fetch livestream details using livestream ID

client.realtimeKit.livestreams.getLivestreamSessionForLivestreamId(stringappId, stringlivestreamId, LivestreamGetLivestreamSessionForLivestreamIDParams { account_id, page_no, per_page } params, RequestOptionsoptions?): LivestreamGetLivestreamSessionForLivestreamIDResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}

ModelsExpand Collapse

LivestreamCreateIndependentLivestreamResponse { data, success }

data?: Data { id, disabled, ingest_server, 5 more }

id?: string

The livestream ID.

disabled?: boolean

Specifies if the livestream was disabled.

ingest_server?: string

The server URL to which the RTMP encoder should send the video and audio data.

meeting_id?: string | null

name?: string

playback_url?: string

The web address that viewers can use to watch the livestream.

status?: "LIVE" | "IDLE" | "ERRORED" | "INVOKED"

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

stream_key?: string

Unique key for accessing each livestream.

success?: boolean

LivestreamGetAllLivestreamsResponse { data, success }

data?: Data { id, created_at, disabled, 8 more }

id?: string

The ID of the livestream.

formatuuid

created_at?: string

Timestamp the object was created at. The time is returned in ISO format.

formatdate-time

disabled?: string

Specifies if the livestream was disabled.

ingest_server?: string

The server URL to which the RTMP encoder sends the video and audio data.

meeting_id?: string

ID of the meeting.

name?: string

Name of the livestream.

paging?: Paging { end_offset, start_offset, total_count }

end_offset?: number

start_offset?: number

total_count?: number

playback_url?: string

The web address that viewers can use to watch the livestream.

status?: "LIVE" | "IDLE" | "ERRORED" | "INVOKED"

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

stream_key?: string

Unique key for accessing each livestream.

updated_at?: string

Timestamp the object was updated at. The time is returned in ISO format.

formatdate-time

success?: boolean

LivestreamStopLivestreamingAMeetingResponse { data, success }

data?: Data { message }

message?: string

success?: boolean

LivestreamStartLivestreamingAMeetingResponse { data, success }

data?: Data { id, ingest_server, playback_url, 2 more }

id?: string

The livestream ID.

ingest_server?: string

The server URL to which the RTMP encoder sends the video and audio data.

playback_url?: string

The web address that viewers can use to watch the livestream.

status?: "LIVE" | "IDLE" | "ERRORED" | "INVOKED"

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

stream_key?: string

Unique key for accessing each livestream.

success?: boolean

LivestreamGetLivestreamAnalyticsCompleteResponse { data, success }

data?: Data { count, total_ingest_seconds, total_viewer_seconds }

count?: number

Count of total livestreams.

total_ingest_seconds?: number

Total time duration for which the input was given or the meeting was streamed.

total_viewer_seconds?: number

Total view time for which the viewers watched the stream.

success?: boolean

LivestreamGetOrgAnalyticsResponse { data, success }

data?: Data { recording_stats, session_stats }

recording_stats?: RecordingStats { day_stats, recording_count, recording_minutes_consumed }

Recording statistics of an App during the range specified

day_stats?: Array<DayStat>

Day wise recording stats

day?: string

total_recording_minutes?: number

Total recording minutes for a specific day

total_recordings?: number

Total number of recordings for a specific day

recording_count?: number

Total number of recordings during the range specified

recording_minutes_consumed?: number

Total recording minutes during the range specified

session_stats?: SessionStats { day_stats, sessions_count, sessions_minutes_consumed }

Session statistics of an App during the range specified

day_stats?: Array<DayStat>

Day wise session stats

day?: string

total_session_minutes?: number

Total session minutes for a specific day

total_sessions?: number

Total number of sessions for a specific day

sessions_count?: number

Total number of sessions during the range specified

sessions_minutes_consumed?: number

Total session minutes during the range specified

success?: boolean

LivestreamGetMeetingActiveLivestreamsResponse { data, success }

data?: Data { id, created_at, disabled, 7 more }

id?: string

The livestream ID.

created_at?: string

Timestamp the object was created at. The time is returned in ISO format.

formatdate-time

disabled?: string

Specifies if the livestream was disabled.

ingest_server?: string

The server URL to which the RTMP encoder sends the video and audio data.

meeting_id?: string

name?: string | null

Name of the livestream.

playback_url?: string

The web address that viewers can use to watch the livestream.

status?: "LIVE" | "IDLE" | "ERRORED" | "INVOKED"

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

stream_key?: string

Unique key for accessing each livestream.

updated_at?: string

Timestamp the object was updated at. The time is returned in ISO format.

formatdate-time

success?: boolean

LivestreamGetLivestreamSessionDetailsForSessionIDResponse { data, success }

data?: Data { id, created_at, err_message, 6 more }

id?: string

The livestream ID.

created_at?: string

Timestamp the object was created at. The time is returned in ISO format.

formatdate-time

err_message?: string

The server URL to which the RTMP encoder sends the video and audio data.

ingest_seconds?: number

Name of the livestream.

livestream_id?: string

started_time?: string

Unique key for accessing each livestream.

stopped_time?: string

The web address that viewers can use to watch the livestream.

updated_at?: string

Timestamp the object was updated at. The time is returned in ISO format.

viewer_seconds?: number

Specifies if the livestream was disabled.

success?: boolean

LivestreamGetActiveLivestreamsForLivestreamIDResponse { data, success }

data?: Data { livestream, session }

livestream?: Livestream { id, created_at, disabled, 7 more }

id?: string

created_at?: string

Timestamp the object was created at. The time is returned in ISO format.

formatdate-time

disabled?: string

Specifies if the livestream was disabled.

ingest_server?: string

The server URL to which the RTMP encoder sends the video and audio data.

meeting_id?: string

ID of the meeting.

name?: string

Name of the livestream.

playback_url?: string

The web address that viewers can use to watch the livestream.

status?: "LIVE" | "IDLE" | "ERRORED" | "INVOKED"

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

stream_key?: string

Unique key for accessing each livestream.

updated_at?: string

Timestamp the object was updated at. The time is returned in ISO format.

formatdate-time

session?: Session { id, created_at, err_message, 7 more }

id?: string

created_at?: string

Timestamp the object was created at. The time is returned in ISO format.

formatdate-time

err_message?: string

ingest_seconds?: string

The time duration for which the input was given or the meeting was streamed.

invoked_time?: string

Timestamp the object was invoked. The time is returned in ISO format.

formatdate-time

livestream_id?: string

started_time?: string

Timestamp the object was started. The time is returned in ISO format.

formatdate-time

stopped_time?: string

Timestamp the object was stopped. The time is returned in ISO format.

formatdate-time

updated_at?: string

Timestamp the object was updated at. The time is returned in ISO format.

formatdate-time

viewer_seconds?: string

The total view time for which the viewers watched the stream.

success?: boolean

LivestreamGetLivestreamSessionForLivestreamIDResponse { data, success }

data?: Data { livestream, paging, session }

livestream?: Livestream { id, created_at, disabled, 7 more }

id?: string

ID of the livestream.

created_at?: string

Timestamp the object was created at. The time is returned in ISO format.

disabled?: string

Specifies if the livestream was disabled.

ingest_server?: string

The server URL to which the RTMP encoder sends the video and audio data.

meeting_id?: string

The ID of the meeting.

name?: string

Name of the livestream.

playback_url?: string

The web address that viewers can use to watch the livestream.

status?: "LIVE" | "IDLE" | "ERRORED" | "INVOKED"

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

stream_key?: string

Unique key for accessing each livestream.

updated_at?: string

Timestamp the object was updated at. The time is returned in ISO format.

paging?: Paging { end_offset, start_offset, total_count }

end_offset?: number

start_offset?: number

total_count?: number

session?: Session { id, created_at, err_message, 7 more }

id?: string

ID of the session.

created_at?: string

Timestamp the object was created at. The time is returned in ISO format.

formatdate-time

err_message?: string

ingest_seconds?: number

The time duration for which the input was given or the meeting was streamed.

invoked_time?: string

Timestamp the object was invoked. The time is returned in ISO format.

formatdate-time

livestream_id?: string

started_time?: string

Timestamp the object was started. The time is returned in ISO format.

formatdate-time

stopped_time?: string

Timestamp the object was stopped. The time is returned in ISO format.

formatdate-time

updated_at?: string

Timestamp the object was updated at. The time is returned in ISO format.

formatdate-time

viewer_seconds?: number

The total view time for which the viewers watched the stream.

success?: boolean