Skip to content
Cloudflare API
Start here
API Reference
Realtime Kit

Livestreams

Create an independent livestream
realtime_kit.livestreams.create_independent_livestream(strapp_id, LivestreamCreateIndependentLivestreamParams**kwargs) -> LivestreamCreateIndependentLivestreamResponse
POST/accounts/{account_id}/realtime/kit/{app_id}/livestreams
Fetch all livestreams
realtime_kit.livestreams.get_all_livestreams(strapp_id, LivestreamGetAllLivestreamsParams**kwargs) -> LivestreamGetAllLivestreamsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams
Stop livestreaming a meeting
realtime_kit.livestreams.stop_livestreaming_a_meeting(strmeeting_id, LivestreamStopLivestreamingAMeetingParams**kwargs) -> LivestreamStopLivestreamingAMeetingResponse
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream/stop
Start livestreaming a meeting
realtime_kit.livestreams.start_livestreaming_a_meeting(strmeeting_id, LivestreamStartLivestreamingAMeetingParams**kwargs) -> LivestreamStartLivestreamingAMeetingResponse
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestreams
Fetch complete analytics data for your livestreams
realtime_kit.livestreams.get_livestream_analytics_complete(strapp_id, LivestreamGetLivestreamAnalyticsCompleteParams**kwargs) -> LivestreamGetLivestreamAnalyticsCompleteResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/overall
Fetch day-wise session and recording analytics data for an App
realtime_kit.livestreams.get_org_analytics(strapp_id, LivestreamGetOrgAnalyticsParams**kwargs) -> LivestreamGetOrgAnalyticsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/analytics/daywise
Fetch active livestreams for a meeting
realtime_kit.livestreams.get_meeting_active_livestreams(strmeeting_id, LivestreamGetMeetingActiveLivestreamsParams**kwargs) -> LivestreamGetMeetingActiveLivestreamsResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream
Fetch livestream session details using livestream session ID
realtime_kit.livestreams.get_livestream_session_details_for_session_id(strlivestream_session_id, LivestreamGetLivestreamSessionDetailsForSessionIDParams**kwargs) -> LivestreamGetLivestreamSessionDetailsForSessionIDResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/sessions/{livestream-session-id}
Fetch active livestream session details
realtime_kit.livestreams.get_active_livestreams_for_livestream_id(strlivestream_id, LivestreamGetActiveLivestreamsForLivestreamIDParams**kwargs) -> LivestreamGetActiveLivestreamsForLivestreamIDResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}/active-livestream-session
Fetch livestream details using livestream ID
realtime_kit.livestreams.get_livestream_session_for_livestream_id(strlivestream_id, LivestreamGetLivestreamSessionForLivestreamIDParams**kwargs) -> LivestreamGetLivestreamSessionForLivestreamIDResponse
GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}
ModelsExpand Collapse
class LivestreamCreateIndependentLivestreamResponse: …
data: Optional[Data]
id: Optional[str]

The livestream ID.

disabled: Optional[bool]

Specifies if the livestream was disabled.

ingest_server: Optional[str]

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

meeting_id: Optional[str]
name: Optional[str]
playback_url: Optional[str]

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

status: Optional[Literal["LIVE", "IDLE", "ERRORED", "INVOKED"]]
One of the following:
"LIVE"
"IDLE"
"ERRORED"
"INVOKED"
stream_key: Optional[str]

Unique key for accessing each livestream.

success: Optional[bool]
class LivestreamGetAllLivestreamsResponse: …
data: Optional[Data]
id: Optional[str]

The ID of the livestream.

formatuuid
created_at: Optional[datetime]

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

formatdate-time
disabled: Optional[str]

Specifies if the livestream was disabled.

ingest_server: Optional[str]

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

meeting_id: Optional[str]

ID of the meeting.

name: Optional[str]

Name of the livestream.

paging: Optional[DataPaging]
end_offset: Optional[int]
start_offset: Optional[int]
total_count: Optional[int]
playback_url: Optional[str]

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

status: Optional[Literal["LIVE", "IDLE", "ERRORED", "INVOKED"]]
One of the following:
"LIVE"
"IDLE"
"ERRORED"
"INVOKED"
stream_key: Optional[str]

Unique key for accessing each livestream.

updated_at: Optional[datetime]

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

formatdate-time
success: Optional[bool]
class LivestreamStopLivestreamingAMeetingResponse: …
data: Optional[Data]
message: Optional[str]
success: Optional[bool]
class LivestreamStartLivestreamingAMeetingResponse: …
data: Optional[Data]
id: Optional[str]

The livestream ID.

ingest_server: Optional[str]

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

playback_url: Optional[str]

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

status: Optional[Literal["LIVE", "IDLE", "ERRORED", "INVOKED"]]
One of the following:
"LIVE"
"IDLE"
"ERRORED"
"INVOKED"
stream_key: Optional[str]

Unique key for accessing each livestream.

success: Optional[bool]
class LivestreamGetLivestreamAnalyticsCompleteResponse: …
data: Optional[Data]
count: Optional[int]

Count of total livestreams.

total_ingest_seconds: Optional[int]

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

total_viewer_seconds: Optional[int]

Total view time for which the viewers watched the stream.

success: Optional[bool]
class LivestreamGetOrgAnalyticsResponse: …
data: Optional[Data]
recording_stats: Optional[DataRecordingStats]

Recording statistics of an App during the range specified

day_stats: Optional[List[DataRecordingStatsDayStat]]

Day wise recording stats

day: Optional[str]
total_recording_minutes: Optional[int]

Total recording minutes for a specific day

total_recordings: Optional[int]

Total number of recordings for a specific day

recording_count: Optional[int]

Total number of recordings during the range specified

recording_minutes_consumed: Optional[float]

Total recording minutes during the range specified

session_stats: Optional[DataSessionStats]

Session statistics of an App during the range specified

day_stats: Optional[List[DataSessionStatsDayStat]]

Day wise session stats

day: Optional[str]
total_session_minutes: Optional[float]

Total session minutes for a specific day

total_sessions: Optional[int]

Total number of sessions for a specific day

sessions_count: Optional[int]

Total number of sessions during the range specified

sessions_minutes_consumed: Optional[float]

Total session minutes during the range specified

success: Optional[bool]
class LivestreamGetMeetingActiveLivestreamsResponse: …
data: Optional[Data]
id: Optional[str]

The livestream ID.

created_at: Optional[datetime]

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

formatdate-time
disabled: Optional[str]

Specifies if the livestream was disabled.

ingest_server: Optional[str]

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

meeting_id: Optional[str]
name: Optional[str]

Name of the livestream.

playback_url: Optional[str]

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

status: Optional[Literal["LIVE", "IDLE", "ERRORED", "INVOKED"]]
One of the following:
"LIVE"
"IDLE"
"ERRORED"
"INVOKED"
stream_key: Optional[str]

Unique key for accessing each livestream.

updated_at: Optional[datetime]

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

formatdate-time
success: Optional[bool]
class LivestreamGetLivestreamSessionDetailsForSessionIDResponse: …
data: Optional[Data]
id: Optional[str]

The livestream ID.

created_at: Optional[datetime]

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

formatdate-time
err_message: Optional[str]

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

ingest_seconds: Optional[int]

Name of the livestream.

livestream_id: Optional[str]
started_time: Optional[str]

Unique key for accessing each livestream.

stopped_time: Optional[str]

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

updated_at: Optional[str]

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

viewer_seconds: Optional[int]

Specifies if the livestream was disabled.

success: Optional[bool]
class LivestreamGetActiveLivestreamsForLivestreamIDResponse: …
data: Optional[Data]
livestream: Optional[DataLivestream]
id: Optional[str]
created_at: Optional[datetime]

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

formatdate-time
disabled: Optional[str]

Specifies if the livestream was disabled.

ingest_server: Optional[str]

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

meeting_id: Optional[str]

ID of the meeting.

name: Optional[str]

Name of the livestream.

playback_url: Optional[str]

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

status: Optional[Literal["LIVE", "IDLE", "ERRORED", "INVOKED"]]
One of the following:
"LIVE"
"IDLE"
"ERRORED"
"INVOKED"
stream_key: Optional[str]

Unique key for accessing each livestream.

updated_at: Optional[datetime]

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

formatdate-time
session: Optional[DataSession]
id: Optional[str]
created_at: Optional[datetime]

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

formatdate-time
err_message: Optional[str]
ingest_seconds: Optional[str]

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

invoked_time: Optional[datetime]

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

formatdate-time
livestream_id: Optional[str]
started_time: Optional[datetime]

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

formatdate-time
stopped_time: Optional[datetime]

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

formatdate-time
updated_at: Optional[datetime]

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

formatdate-time
viewer_seconds: Optional[str]

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

success: Optional[bool]
class LivestreamGetLivestreamSessionForLivestreamIDResponse: …
data: Optional[Data]
livestream: Optional[DataLivestream]
id: Optional[str]

ID of the livestream.

created_at: Optional[str]

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

disabled: Optional[str]

Specifies if the livestream was disabled.

ingest_server: Optional[str]

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

meeting_id: Optional[str]

The ID of the meeting.

name: Optional[str]

Name of the livestream.

playback_url: Optional[str]

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

status: Optional[Literal["LIVE", "IDLE", "ERRORED", "INVOKED"]]
One of the following:
"LIVE"
"IDLE"
"ERRORED"
"INVOKED"
stream_key: Optional[str]

Unique key for accessing each livestream.

updated_at: Optional[str]

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

paging: Optional[DataPaging]
end_offset: Optional[int]
start_offset: Optional[int]
total_count: Optional[int]
session: Optional[DataSession]
id: Optional[str]

ID of the session.

created_at: Optional[datetime]

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

formatdate-time
err_message: Optional[str]
ingest_seconds: Optional[float]

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

invoked_time: Optional[datetime]

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

formatdate-time
livestream_id: Optional[str]
started_time: Optional[datetime]

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

formatdate-time
stopped_time: Optional[datetime]

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

formatdate-time
updated_at: Optional[datetime]

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

formatdate-time
viewer_seconds: Optional[float]

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

success: Optional[bool]