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

Start livestreaming a meeting

client.realtimeKit.livestreams.startLivestreamingAMeeting(stringappId, stringmeetingId, LivestreamStartLivestreamingAMeetingParams { account_id, name, video_config } params, RequestOptionsoptions?): LivestreamStartLivestreamingAMeetingResponse { data, success }
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
Accepted Permissions (at least one required)
Realtime AdminRealtime
ParametersExpand Collapse
appId: string

The app identifier tag.

maxLength32
meetingId: string
formatuuid
params: LivestreamStartLivestreamingAMeetingParams { account_id, name, video_config }
account_id: string

Path param: The account identifier tag.

maxLength32
name?: string | null

Body param

video_config?: VideoConfig

Body param

height?: number

Height of the livestreaming video in pixels

width?: number

Width of the livestreaming video in pixels

ReturnsExpand Collapse
LivestreamStartLivestreamingAMeetingResponse { data, success }
data?: Data { id, ingest_server, playback_url, 2 more }
id?: string

The livestream ID.

ingest_server?: string

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

playback_url?: string

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

status?: "LIVE" | "IDLE" | "ERRORED" | "INVOKED"
One of the following:
"LIVE"
"IDLE"
"ERRORED"
"INVOKED"
stream_key?: string

Unique key for accessing each livestream.

success?: boolean

Start livestreaming a meeting

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.realtimeKit.livestreams.startLivestreamingAMeeting(
  'app_id',
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { account_id: '023e105f4ecef8ad9ca31a8372d0c353', name: 'prdmmp-xhycsl' },
);

console.log(response.data);
{
  "data": {
    "id": "7088bba8-f522-49a8-b59b-3cd0e946bbb0",
    "ingest_server": "rtmps://live.cloudflare.com:443/live/",
    "playback_url": "https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8",
    "status": "INVOKED",
    "stream_key": "f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4"
  },
  "success": true
}
Returns Examples
{
  "data": {
    "id": "7088bba8-f522-49a8-b59b-3cd0e946bbb0",
    "ingest_server": "rtmps://live.cloudflare.com:443/live/",
    "playback_url": "https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8",
    "status": "INVOKED",
    "stream_key": "f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4"
  },
  "success": true
}