API Reference

Realtime Kit

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Livestreams

Fetch all livestreams

realtime_kit.livestreams.get_all_livestreams(strapp_id, LivestreamGetAllLivestreamsParams**kwargs) -> LivestreamGetAllLivestreamsResponse

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

Fetch livestream session details for a meeting

realtime_kit.livestreams.get_livestream_session_details_for_meeting(strmeeting_id, LivestreamGetLivestreamSessionDetailsForMeetingParams**kwargs) -> LivestreamGetLivestreamSessionDetailsForMeetingResponse

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

Fetch livestream session details using a session ID

realtime_kit.livestreams.get_livestream_sessions_for_session(strsession_id, LivestreamGetLivestreamSessionsForSessionParams**kwargs) -> LivestreamGetLivestreamSessionsForSessionResponse

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

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 analytics data for your livestreams

realtime_kit.livestreams.get_livestream_analytics_daywise(strapp_id, LivestreamGetLivestreamAnalyticsDaywiseParams**kwargs) -> LivestreamGetLivestreamAnalyticsDaywiseResponse

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

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 LivestreamGetAllLivestreamsResponse: …

data: List[Data]

id: str

ID of the livestream.

formatuuid

created_at: datetime

Timestamp the livestream was created at, in ISO format.

formatdate-time

disabled: bool

Specifies if the livestream is disabled.

external_id: str

ID of the underlying Cloudflare Stream live input.

ingest_server: str

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

manual_ingest: bool

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

meeting_id: Optional[str]

ID of the meeting being livestreamed, if any.

name: Optional[str]

Name of the livestream.

playback_url: str

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

status: Literal["LIVE", "IDLE", "ERRORED", 2 more]

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: str

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

updated_at: datetime

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

formatdate-time

paging: Paging

end_offset: float

start_offset: float

total_count: float

minimum0

success: bool

class LivestreamGetLivestreamSessionDetailsForMeetingResponse: …

data: Data

data: DataData

livestream: DataDataLivestream

id: str

ID of the livestream.

formatuuid

created_at: datetime

Timestamp the livestream was created at, in ISO format.

formatdate-time

disabled: bool

Specifies if the livestream is disabled.

external_id: str

ID of the underlying Cloudflare Stream live input.

ingest_server: str

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

manual_ingest: bool

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

meeting_id: Optional[str]

ID of the meeting being livestreamed, if any.

name: Optional[str]

Name of the livestream.

playback_url: str

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

status: Literal["LIVE", "IDLE", "ERRORED", 2 more]

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: str

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

updated_at: datetime

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

formatdate-time

sessions: List[DataDataSession]

id: str

ID of the livestream session.

formatuuid

created_at: datetime

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

formatdate-time

err_message: Optional[str]

Error message, if the livestream session failed.

ingest_seconds: float

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

invoked_time: Optional[datetime]

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

formatdate-time

livestream_id: str

ID of the livestream.

formatuuid

started_time: Optional[datetime]

Timestamp the livestream session started at, in ISO format.

formatdate-time

stopped_time: Optional[datetime]

Timestamp the livestream session stopped at, in ISO format.

formatdate-time

updated_at: datetime

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

formatdate-time

viewer_seconds: float

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

paging: DataPaging

end_offset: float

start_offset: float

total_count: float

minimum0

success: bool

class LivestreamGetLivestreamSessionsForSessionResponse: …

data: Data

data: List[DataData]

id: str

ID of the livestream session.

formatuuid

created_at: datetime

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

formatdate-time

err_message: Optional[str]

Error message, if the livestream session failed.

ingest_seconds: float

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

invoked_time: Optional[datetime]

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

formatdate-time

livestream_id: str

ID of the livestream.

formatuuid

started_time: Optional[datetime]

Timestamp the livestream session started at, in ISO format.

formatdate-time

stopped_time: Optional[datetime]

Timestamp the livestream session stopped at, in ISO format.

formatdate-time

updated_at: datetime

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

formatdate-time

viewer_seconds: float

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

paging: DataPaging

end_offset: float

start_offset: float

total_count: float

minimum0

success: bool

class LivestreamStopLivestreamingAMeetingResponse: …

data: Optional[Data]

message: Optional[str]

success: Optional[bool]

class LivestreamStartLivestreamingAMeetingResponse: …

data: Data

id: str

ID of the livestream.

formatuuid

ingest_server: str

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

meeting_id: Optional[str]

ID of the meeting being livestreamed, if any.

name: Optional[str]

Name of the livestream.

playback_url: str

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

status: Literal["LIVE", "IDLE", "ERRORED", 2 more]

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: str

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

success: bool

class LivestreamGetLivestreamAnalyticsCompleteResponse: …

data: Optional[Data]

count: Optional[int]

Count of total livestreams.

total_ingest_seconds: Optional[float]

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

total_viewer_seconds: Optional[float]

Total view time for which the viewers watched the stream.

success: Optional[bool]

class LivestreamGetLivestreamAnalyticsDaywiseResponse: …

data: Optional[List[Data]]

count: Optional[int]

Count of total livestream sessions.

date: Optional[str]

Analytics date.

total_ingest_seconds: Optional[float]

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

total_viewer_seconds: Optional[float]

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: Data

id: str

ID of the livestream.

formatuuid

created_at: datetime

Timestamp the livestream was created at, in ISO format.

formatdate-time

disabled: bool

Specifies if the livestream is disabled.

external_id: str

ID of the underlying Cloudflare Stream live input.

ingest_server: str

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

manual_ingest: bool

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

meeting_id: Optional[str]

ID of the meeting being livestreamed, if any.

name: Optional[str]

Name of the livestream.

playback_url: str

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

status: Literal["LIVE", "IDLE", "ERRORED", 2 more]

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: str

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

updated_at: datetime

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

formatdate-time

success: bool

class LivestreamGetLivestreamSessionDetailsForSessionIDResponse: …

data: Data

id: str

ID of the livestream session.

formatuuid

created_at: datetime

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

formatdate-time

err_message: Optional[str]

Error message, if the livestream session failed.

ingest_seconds: float

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

invoked_time: Optional[datetime]

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

formatdate-time

livestream_id: str

ID of the livestream.

formatuuid

started_time: Optional[datetime]

Timestamp the livestream session started at, in ISO format.

formatdate-time

stopped_time: Optional[datetime]

Timestamp the livestream session stopped at, in ISO format.

formatdate-time

updated_at: datetime

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

formatdate-time

viewer_seconds: float

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

success: bool

class LivestreamGetActiveLivestreamsForLivestreamIDResponse: …

data: Data

livestream: DataLivestream

id: str

ID of the livestream.

formatuuid

created_at: datetime

Timestamp the livestream was created at, in ISO format.

formatdate-time

disabled: bool

Specifies if the livestream is disabled.

external_id: str

ID of the underlying Cloudflare Stream live input.

ingest_server: str

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

manual_ingest: bool

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

meeting_id: Optional[str]

ID of the meeting being livestreamed, if any.

name: Optional[str]

Name of the livestream.

playback_url: str

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

status: Literal["LIVE", "IDLE", "ERRORED", 2 more]

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: str

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

updated_at: datetime

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

formatdate-time

session: DataSession

id: str

ID of the livestream session.

formatuuid

created_at: datetime

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

formatdate-time

err_message: Optional[str]

Error message, if the livestream session failed.

ingest_seconds: float

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

invoked_time: Optional[datetime]

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

formatdate-time

livestream_id: str

ID of the livestream.

formatuuid

started_time: Optional[datetime]

Timestamp the livestream session started at, in ISO format.

formatdate-time

stopped_time: Optional[datetime]

Timestamp the livestream session stopped at, in ISO format.

formatdate-time

updated_at: datetime

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

formatdate-time

viewer_seconds: float

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

success: bool

class LivestreamGetLivestreamSessionForLivestreamIDResponse: …

data: Data

livestream: DataLivestream

id: str

ID of the livestream.

formatuuid

created_at: datetime

Timestamp the livestream was created at, in ISO format.

formatdate-time

disabled: bool

Specifies if the livestream is disabled.

external_id: str

ID of the underlying Cloudflare Stream live input.

ingest_server: str

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

manual_ingest: bool

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

meeting_id: Optional[str]

ID of the meeting being livestreamed, if any.

name: Optional[str]

Name of the livestream.

playback_url: str

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

status: Literal["LIVE", "IDLE", "ERRORED", 2 more]

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: str

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

updated_at: datetime

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

formatdate-time

sessions: List[DataSession]

id: str

ID of the livestream session.

formatuuid

created_at: datetime

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

formatdate-time

err_message: Optional[str]

Error message, if the livestream session failed.

ingest_seconds: float

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

invoked_time: Optional[datetime]

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

formatdate-time

livestream_id: str

ID of the livestream.

formatuuid

started_time: Optional[datetime]

Timestamp the livestream session started at, in ISO format.

formatdate-time

stopped_time: Optional[datetime]

Timestamp the livestream session stopped at, in ISO format.

formatdate-time

updated_at: datetime

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

formatdate-time

viewer_seconds: float

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

paging: Paging

end_offset: float

start_offset: float

total_count: float

minimum0

success: bool