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

Create an independent livestream

client.realtimeKit.livestreams.createIndependentLivestream(stringappId, LivestreamCreateIndependentLivestreamParams { account_id, name } params, RequestOptionsoptions?): LivestreamCreateIndependentLivestreamResponse { data, success }
POST/accounts/{account_id}/realtime/kit/{app_id}/livestreams

Creates a livestream for the given App ID and returns ingest server, stream key, and playback URL. You can pass custom input to the ingest server and stream key, and freely distribute the content using the playback URL on any player that supports HLS/LHLS.

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
params: LivestreamCreateIndependentLivestreamParams { account_id, name }
account_id: string

Path param: The account identifier tag.

maxLength32
name?: string | null

Body param: Name of the livestream

ReturnsExpand Collapse
LivestreamCreateIndependentLivestreamResponse { data, success }
data?: Data { id, disabled, ingest_server, 5 more }
id?: string

The livestream ID.

disabled?: boolean

Specifies if the livestream was disabled.

ingest_server?: string

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

meeting_id?: string | null
name?: string
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

Create an independent livestream

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.createIndependentLivestream('app_id', {
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  name: 'prdmmp-xhycsl',
});

console.log(response.data);
{
  "data": {
    "disabled": false,
    "id": "78dd0b50-4147-4bb8-88d3-2ccc2e98bff0",
    "ingest_server": "rtmps://live.cloudflare.com:443/live/",
    "meeting_id": null,
    "name": "Livestreaming-Demo",
    "playback_url": "https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8",
    "status": "INVOKED",
    "stream_key": "f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4"
  },
  "success": true
}
Returns Examples
{
  "data": {
    "disabled": false,
    "id": "78dd0b50-4147-4bb8-88d3-2ccc2e98bff0",
    "ingest_server": "rtmps://live.cloudflare.com:443/live/",
    "meeting_id": null,
    "name": "Livestreaming-Demo",
    "playback_url": "https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8",
    "status": "INVOKED",
    "stream_key": "f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4"
  },
  "success": true
}