---
title: Active Session
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/python)

[Realtime Kit](https://developers.cloudflare.com/api/python/resources/realtime_kit)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Active Session

##### [Fetch details of an active session](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/active-session/methods/get_active_session)

realtime\_kit.active\_session.get\_active\_session(strmeeting\_id, ActiveSessionGetActiveSessionParams\*\*kwargs) -> [ActiveSessionGetActiveSessionResponse](<https://developers.cloudflare.com/api/python/resources/realtime_kit#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)>)

GET/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/active-session

##### [Kick participants from an active session](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/active-session/methods/kick_participants)

realtime\_kit.active\_session.kick\_participants(strmeeting\_id, ActiveSessionKickParticipantsParams\*\*kwargs) -> [ActiveSessionKickParticipantsResponse](<https://developers.cloudflare.com/api/python/resources/realtime_kit#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)>)

POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/active-session/kick

##### [Kick all participants](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/active-session/methods/kick_all_participants)

realtime\_kit.active\_session.kick\_all\_participants(strmeeting\_id, ActiveSessionKickAllParticipantsParams\*\*kwargs) -> [ActiveSessionKickAllParticipantsResponse](<https://developers.cloudflare.com/api/python/resources/realtime_kit#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_all_participants_response%20%3E%20(schema)>)

POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/active-session/kick-all

##### [Create a poll](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/active-session/methods/create_poll)

realtime\_kit.active\_session.create\_poll(strmeeting\_id, ActiveSessionCreatePollParams\*\*kwargs) -> [ActiveSessionCreatePollResponse](<https://developers.cloudflare.com/api/python/resources/realtime_kit#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)>)

POST/accounts/{account\_id}/realtime/kit/{app\_id}/meetings/{meeting\_id}/active-session/poll

##### ModelsExpand Collapse

<details>

<summary>

class ActiveSessionGetActiveSessionResponse: …

</summary>

<details>

<summary>

data: Optional\[Data]

</summary>

id: str

ID of the session

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20id">Link to this property</a>

associated\_id: str

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 <code>abcdef-ghijkl</code>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20associated_id">Link to this property</a>

created\_at: str

timestamp when session created

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20created_at">Link to this property</a>

live\_participants: float

number of participants currently in the session

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20live_participants">Link to this property</a>

max\_concurrent\_participants: float

number of maximum participants that were in the session

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20max_concurrent_participants">Link to this property</a>

meeting\_display\_name: str

Title of the meeting this session belongs to

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20meeting_display_name">Link to this property</a>

minutes\_consumed: float

number of minutes consumed since the session started

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20minutes_consumed">Link to this property</a>

organization\_id: str

App id that hosted this session

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20organization_id">Link to this property</a>

started\_at: str

timestamp when session started

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20started_at">Link to this property</a>

<details>

<summary>

status: Literal\["LIVE", "ENDED"]

current status of session

</summary>

One of the following:

"LIVE"

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20status%20%3E%20(member)%200">Link to this property</a>

"ENDED"

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20status%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20status">Link to this property</a>

<details>

<summary>

type: Literal\["meeting", "livestream", "participant"]

type of session

</summary>

One of the following:

"meeting"

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"livestream"

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

"participant"

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20type%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20type">Link to this property</a>

updated\_at: str

timestamp when session was last updated

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20updated_at">Link to this property</a>

breakout\_rooms: Optional\[List\[object]]

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20breakout_rooms">Link to this property</a>

ended\_at: Optional\[str]

timestamp when session ended

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20ended_at">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20data">Link to this property</a>

success: Optional\[bool]

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)%20%3E%20(property)%20success">Link to this property</a>

</details>

[Link to this property](<#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_get_active_session_response%20%3E%20(schema)>)

<details>

<summary>

class ActiveSessionKickParticipantsResponse: …

</summary>

<details>

<summary>

data: Optional\[Data]

</summary>

action: Optional\[str]

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20action">Link to this property</a>

<details>

<summary>

participants: Optional\[List\[DataParticipant]]

</summary>

id: str

ID of the session participant

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants%20%3E%20(items)%20%3E%20(property)%20id">Link to this property</a>

created\_at: str

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants%20%3E%20(items)%20%3E%20(property)%20created_at">Link to this property</a>

updated\_at: str

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants%20%3E%20(items)%20%3E%20(property)%20updated_at">Link to this property</a>

email: Optional\[str]

Email of the session participant.

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants%20%3E%20(items)%20%3E%20(property)%20email">Link to this property</a>

name: Optional\[str]

Name of the session participant.

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants%20%3E%20(items)%20%3E%20(property)%20name">Link to this property</a>

picture: Optional\[str]

A URL pointing to a picture of the participant.

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants%20%3E%20(items)%20%3E%20(property)%20picture">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20participants">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20data">Link to this property</a>

success: Optional\[bool]

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)%20%3E%20(property)%20success">Link to this property</a>

</details>

[Link to this property](<#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_participants_response%20%3E%20(schema)>)

<details>

<summary>

class ActiveSessionKickAllParticipantsResponse: …

</summary>

<details>

<summary>

data: Optional\[Data]

</summary>

action: Optional\[str]

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_all_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20action">Link to this property</a>

kicked\_participants\_count: Optional\[float]

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_all_participants_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20kicked_participants_count">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_all_participants_response%20%3E%20(schema)%20%3E%20(property)%20data">Link to this property</a>

success: Optional\[bool]

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_all_participants_response%20%3E%20(schema)%20%3E%20(property)%20success">Link to this property</a>

</details>

[Link to this property](<#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_kick_all_participants_response%20%3E%20(schema)>)

<details>

<summary>

class ActiveSessionCreatePollResponse: …

</summary>

<details>

<summary>

data: Optional\[Data]

</summary>

action: Optional\[str]

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20action">Link to this property</a>

<details>

<summary>

poll: Optional\[DataPoll]

</summary>

id: str

ID of the poll

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20id">Link to this property</a>

<details>

<summary>

options: List\[DataPollOption]

Answer options

</summary>

count: float

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20options%20%3E%20(items)%20%3E%20(property)%20count">Link to this property</a>

text: str

Text of the answer option

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20options%20%3E%20(items)%20%3E%20(property)%20text">Link to this property</a>

<details>

<summary>

votes: List\[DataPollOptionVote]

</summary>

id: str

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20options%20%3E%20(items)%20%3E%20(property)%20votes%20%3E%20(items)%20%3E%20(property)%20id">Link to this property</a>

name: str

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20options%20%3E%20(items)%20%3E%20(property)%20votes%20%3E%20(items)%20%3E%20(property)%20name">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20options%20%3E%20(items)%20%3E%20(property)%20votes">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20options">Link to this property</a>

question: str

Question asked by the poll

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20question">Link to this property</a>

anonymous: Optional\[bool]

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20anonymous">Link to this property</a>

created\_by: Optional\[str]

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20created_by">Link to this property</a>

hide\_votes: Optional\[bool]

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20hide_votes">Link to this property</a>

voted: Optional\[List\[str]]

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll%20%3E%20(property)%20voted">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(property)%20poll">Link to this property</a>

</details>

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20data">Link to this property</a>

success: Optional\[bool]

<a href="#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)%20%3E%20(property)%20success">Link to this property</a>

</details>

[Link to this property](<#(resource)%20realtime_kit.active-session%20%3E%20(model)%20active_session_create_poll_response%20%3E%20(schema)>)