Skip to content
Cloudflare API
Start here
API Reference
Realtime Kit
Livestreams

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

Starts livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the Create a meeting API.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Realtime AdminRealtime
ParametersExpand Collapse
account_id: str

The account identifier tag.

maxLength32
app_id: str

The app identifier tag.

meeting_id: str
formatuuid
name: Optional[str]
video_config: Optional[VideoConfig]
height: Optional[int]

Height of the livestreaming video in pixels

width: Optional[int]

Width of the livestreaming video in pixels

ReturnsExpand Collapse
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

Start livestreaming a meeting

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.realtime_kit.livestreams.start_livestreaming_a_meeting(
    meeting_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    app_id="14a396e7-ca44-4937-bf1f-050a69118543",
    name="prdmmp-xhycsl",
)
print(response.data)
{
  "data": {
    "id": "b60ef3da-fbbb-441b-9168-8235b0035248",
    "ingest_server": "rtmps://live.cloudflare.com:443/live/",
    "meeting_id": "bbb87945-df1c-49d9-8159-262a7ae6cfde",
    "name": "test",
    "playback_url": "https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8",
    "status": "LIVE",
    "stream_key": "f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4"
  },
  "success": true
}
Returns Examples
{
  "data": {
    "id": "b60ef3da-fbbb-441b-9168-8235b0035248",
    "ingest_server": "rtmps://live.cloudflare.com:443/live/",
    "meeting_id": "bbb87945-df1c-49d9-8159-262a7ae6cfde",
    "name": "test",
    "playback_url": "https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8",
    "status": "LIVE",
    "stream_key": "f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4"
  },
  "success": true
}