Skip to main content
Version: /v2

Start Livestream - API

This API lets you start a livestream by passing roomId, outputs and config object as body parameters.

HTTP method and endpoint


Headers Parameters


This will be a JWT token generate using VideoSDK ApiKey and Secret.

Note that the token will not include any prefix such as "Basic " or "Bearer ". Just pass a token as value.

You can generate a new token by refering this Guide: Generate Auth token


values : application/json

This is usefull for json body parameters, so that VideoSDK servers can understand that the incoming body parameter will be a JSON string.

Body Parameters
The ID of the Room.

Array of object which contains multiple platfroms streamKey and url.

Make sure the stream key is correctly assigned, and if you're using a dynamic key, confirm that it's valid.

You must have enabled recording in config to use transcription.

  • transcription:
    • enabled: true | false
    • summary:
      • enabled: true | false
      • prompt: “Your customized summary prompt”
  • config:
    • layout:
      • type: "GRID" | "SPOTLIGHT" | "SIDEBAR"
      • priority: "SPEAKER" | "PIN"
      • gridSize: Number max 4
    • theme: "DARK" | "LIGHT" | "DEFAULT"
    • recording:
      • enabled: true | false
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' }]",
"transcription" : "transcriptionObj",
"config" : "configObj",
"templateUrl" : ""
const url= ``;
const response = await fetch(url, options);
const data = await response.json();
"Livestream started successfully"

Got a Question? Ask us on discord