API Reference

Realtime Kit

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Livestreams

Fetch all livestreams

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

Fetch livestream session details for a meeting

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

Fetch livestream session details using a session ID

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

Stop livestreaming a meeting

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

Start livestreaming a meeting

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

Fetch complete analytics data for your livestreams

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

Fetch day-wise analytics data for your livestreams

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

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

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

Fetch active livestreams for a meeting

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

Fetch livestream session details using livestream session ID

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

Fetch active livestream session details

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

Fetch livestream details using livestream ID

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

ModelsExpand Collapse

LivestreamGetAllLivestreamsResponse object { data, paging, success }

data: array of object { id, created_at, disabled, 9 more }

id: string

ID of the livestream.

formatuuid

created_at: string

Timestamp the livestream was created at, in ISO format.

formatdate-time

disabled: boolean

Specifies if the livestream is disabled.

external_id: string

ID of the underlying Cloudflare Stream live input.

ingest_server: string

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

manual_ingest: boolean

Specifies if the livestream is ingested manually by an RTMP encoder.

meeting_id: string

ID of the meeting being livestreamed, if any.

name: string

Name of the livestream.

playback_url: string

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

status: "LIVE" or "IDLE" or "ERRORED" or 2 more

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

updated_at: string

Timestamp the livestream was last updated at, in ISO format.

formatdate-time

paging: object { end_offset, start_offset, total_count }

end_offset: number

start_offset: number

total_count: number

minimum0

success: boolean

LivestreamGetLivestreamSessionDetailsForMeetingResponse object { data, success }

data: object { data, paging }

data: object { livestream, sessions }

livestream: object { id, created_at, disabled, 9 more }

id: string

ID of the livestream.

formatuuid

created_at: string

Timestamp the livestream was created at, in ISO format.

formatdate-time

disabled: boolean

Specifies if the livestream is disabled.

external_id: string

ID of the underlying Cloudflare Stream live input.

ingest_server: string

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

manual_ingest: boolean

Specifies if the livestream is ingested manually by an RTMP encoder.

meeting_id: string

ID of the meeting being livestreamed, if any.

name: string

Name of the livestream.

playback_url: string

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

status: "LIVE" or "IDLE" or "ERRORED" or 2 more

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

updated_at: string

Timestamp the livestream was last updated at, in ISO format.

formatdate-time

sessions: array of object { id, created_at, err_message, 7 more }

id: string

ID of the livestream session.

formatuuid

created_at: string

Timestamp the livestream session was created at, in ISO format.

formatdate-time

err_message: string

Error message, if the livestream session failed.

ingest_seconds: number

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

invoked_time: string

Timestamp the livestream session was invoked at, in ISO format.

formatdate-time

livestream_id: string

ID of the livestream.

formatuuid

started_time: string

Timestamp the livestream session started at, in ISO format.

formatdate-time

stopped_time: string

Timestamp the livestream session stopped at, in ISO format.

formatdate-time

updated_at: string

Timestamp the livestream session was last updated at, in ISO format.

formatdate-time

viewer_seconds: number

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

paging: object { end_offset, start_offset, total_count }

end_offset: number

start_offset: number

total_count: number

minimum0

success: boolean

LivestreamGetLivestreamSessionsForSessionResponse object { data, success }

data: object { data, paging }

data: array of object { id, created_at, err_message, 7 more }

id: string

ID of the livestream session.

formatuuid

created_at: string

Timestamp the livestream session was created at, in ISO format.

formatdate-time

err_message: string

Error message, if the livestream session failed.

ingest_seconds: number

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

invoked_time: string

Timestamp the livestream session was invoked at, in ISO format.

formatdate-time

livestream_id: string

ID of the livestream.

formatuuid

started_time: string

Timestamp the livestream session started at, in ISO format.

formatdate-time

stopped_time: string

Timestamp the livestream session stopped at, in ISO format.

formatdate-time

updated_at: string

Timestamp the livestream session was last updated at, in ISO format.

formatdate-time

viewer_seconds: number

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

paging: object { end_offset, start_offset, total_count }

end_offset: number

start_offset: number

total_count: number

minimum0

success: boolean

LivestreamStopLivestreamingAMeetingResponse object { data, success }

data: optional object { message }

message: optional string

success: optional boolean

LivestreamStartLivestreamingAMeetingResponse object { data, success }

data: object { id, ingest_server, meeting_id, 4 more }

id: string

ID of the livestream.

formatuuid

ingest_server: string

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

meeting_id: string

ID of the meeting being livestreamed, if any.

name: string

Name of the livestream.

playback_url: string

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

status: "LIVE" or "IDLE" or "ERRORED" or 2 more

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

success: boolean

LivestreamGetLivestreamAnalyticsCompleteResponse object { data, success }

data: optional object { count, total_ingest_seconds, total_viewer_seconds }

count: optional number

Count of total livestreams.

total_ingest_seconds: optional number

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

total_viewer_seconds: optional number

Total view time for which the viewers watched the stream.

success: optional boolean

LivestreamGetLivestreamAnalyticsDaywiseResponse object { data, success }

data: optional array of object { count, date, total_ingest_seconds, total_viewer_seconds }

count: optional number

Count of total livestream sessions.

date: optional string

Analytics date.

total_ingest_seconds: optional number

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

total_viewer_seconds: optional number

Total view time for which the viewers watched the stream.

success: optional boolean

LivestreamGetOrgAnalyticsResponse object { data, success }

data: optional object { recording_stats, session_stats }

recording_stats: optional object { day_stats, recording_count, recording_minutes_consumed }

Recording statistics of an App during the range specified

day_stats: optional array of object { day, total_recording_minutes, total_recordings }

Day wise recording stats

day: optional string

total_recording_minutes: optional number

Total recording minutes for a specific day

total_recordings: optional number

Total number of recordings for a specific day

recording_count: optional number

Total number of recordings during the range specified

recording_minutes_consumed: optional number

Total recording minutes during the range specified

session_stats: optional object { day_stats, sessions_count, sessions_minutes_consumed }

Session statistics of an App during the range specified

day_stats: optional array of object { day, total_session_minutes, total_sessions }

Day wise session stats

day: optional string

total_session_minutes: optional number

Total session minutes for a specific day

total_sessions: optional number

Total number of sessions for a specific day

sessions_count: optional number

Total number of sessions during the range specified

sessions_minutes_consumed: optional number

Total session minutes during the range specified

success: optional boolean

LivestreamGetMeetingActiveLivestreamsResponse object { data, success }

data: object { id, created_at, disabled, 9 more }

id: string

ID of the livestream.

formatuuid

created_at: string

Timestamp the livestream was created at, in ISO format.

formatdate-time

disabled: boolean

Specifies if the livestream is disabled.

external_id: string

ID of the underlying Cloudflare Stream live input.

ingest_server: string

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

manual_ingest: boolean

Specifies if the livestream is ingested manually by an RTMP encoder.

meeting_id: string

ID of the meeting being livestreamed, if any.

name: string

Name of the livestream.

playback_url: string

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

status: "LIVE" or "IDLE" or "ERRORED" or 2 more

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

updated_at: string

Timestamp the livestream was last updated at, in ISO format.

formatdate-time

success: boolean

LivestreamGetLivestreamSessionDetailsForSessionIDResponse object { data, success }

data: object { id, created_at, err_message, 7 more }

id: string

ID of the livestream session.

formatuuid

created_at: string

Timestamp the livestream session was created at, in ISO format.

formatdate-time

err_message: string

Error message, if the livestream session failed.

ingest_seconds: number

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

invoked_time: string

Timestamp the livestream session was invoked at, in ISO format.

formatdate-time

livestream_id: string

ID of the livestream.

formatuuid

started_time: string

Timestamp the livestream session started at, in ISO format.

formatdate-time

stopped_time: string

Timestamp the livestream session stopped at, in ISO format.

formatdate-time

updated_at: string

Timestamp the livestream session was last updated at, in ISO format.

formatdate-time

viewer_seconds: number

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

success: boolean

LivestreamGetActiveLivestreamsForLivestreamIDResponse object { data, success }

data: object { livestream, session }

livestream: object { id, created_at, disabled, 9 more }

id: string

ID of the livestream.

formatuuid

created_at: string

Timestamp the livestream was created at, in ISO format.

formatdate-time

disabled: boolean

Specifies if the livestream is disabled.

external_id: string

ID of the underlying Cloudflare Stream live input.

ingest_server: string

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

manual_ingest: boolean

Specifies if the livestream is ingested manually by an RTMP encoder.

meeting_id: string

ID of the meeting being livestreamed, if any.

name: string

Name of the livestream.

playback_url: string

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

status: "LIVE" or "IDLE" or "ERRORED" or 2 more

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

updated_at: string

Timestamp the livestream was last updated at, in ISO format.

formatdate-time

session: object { id, created_at, err_message, 7 more }

id: string

ID of the livestream session.

formatuuid

created_at: string

Timestamp the livestream session was created at, in ISO format.

formatdate-time

err_message: string

Error message, if the livestream session failed.

ingest_seconds: number

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

invoked_time: string

Timestamp the livestream session was invoked at, in ISO format.

formatdate-time

livestream_id: string

ID of the livestream.

formatuuid

started_time: string

Timestamp the livestream session started at, in ISO format.

formatdate-time

stopped_time: string

Timestamp the livestream session stopped at, in ISO format.

formatdate-time

updated_at: string

Timestamp the livestream session was last updated at, in ISO format.

formatdate-time

viewer_seconds: number

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

success: boolean

LivestreamGetLivestreamSessionForLivestreamIDResponse object { data, paging, success }

data: object { livestream, sessions }

livestream: object { id, created_at, disabled, 9 more }

id: string

ID of the livestream.

formatuuid

created_at: string

Timestamp the livestream was created at, in ISO format.

formatdate-time

disabled: boolean

Specifies if the livestream is disabled.

external_id: string

ID of the underlying Cloudflare Stream live input.

ingest_server: string

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

manual_ingest: boolean

Specifies if the livestream is ingested manually by an RTMP encoder.

meeting_id: string

ID of the meeting being livestreamed, if any.

name: string

Name of the livestream.

playback_url: string

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

status: "LIVE" or "IDLE" or "ERRORED" or 2 more

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

updated_at: string

Timestamp the livestream was last updated at, in ISO format.

formatdate-time

sessions: array of object { id, created_at, err_message, 7 more }

id: string

ID of the livestream session.

formatuuid

created_at: string

Timestamp the livestream session was created at, in ISO format.

formatdate-time

err_message: string

Error message, if the livestream session failed.

ingest_seconds: number

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

invoked_time: string

Timestamp the livestream session was invoked at, in ISO format.

formatdate-time

livestream_id: string

ID of the livestream.

formatuuid

started_time: string

Timestamp the livestream session started at, in ISO format.

formatdate-time

stopped_time: string

Timestamp the livestream session stopped at, in ISO format.

formatdate-time

updated_at: string

Timestamp the livestream session was last updated at, in ISO format.

formatdate-time

viewer_seconds: number

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

paging: object { end_offset, start_offset, total_count }

end_offset: number

start_offset: number

total_count: number

minimum0

success: boolean