Skip to main content
Version: /v2

Start Livestream

This API lets you start a livestream by passing roomId, outputs and config object as body parameters.
Body Parameters
REQUIRED
The ID of the Room.
REQUIRED
Array of object which contains multiple platfroms streamKey and url.
OPTIONAL
  • config:
    • layout:
      • type: "GRID" | "SPOTLIGHT" | "SIDEBAR"
      • priority: "SPEAKER" | "PIN"
      • gridSize: Number max 4
    • theme: "DARK" | "LIGHT" | "DEFAULT"
POST
|
https://api.videosdk.live/v2/livestreams/start
NodeJS
import fetch from 'node-fetch';
const options = {
	method: "POST",
	headers: {
		"Authorization": "$YOUR_TOKEN",
		"Content-Type": "application/json",
	},
	body: JSON.stringify({"roomId" : "xyz","outputs" : "[{ streamKey: 'Platform_StreamKey', url: 'RTMP-URL' }]","config" : "configObj","templateUrl" : "https://www.example.com/?token=token&meetingId=74v5-v21l-n1ey&participantId=RECORDER_ID"}),
};
const url= `https://api.videosdk.live/v2/livestreams/start`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
RESPONSE
"Livestream started successfully"