Skip to main content
Version: /v2

Start Recording

This API lets you record your room by passing roomId and config object as body parameters.
Body Parameters
REQUIRED
The ID of the Room.
OPTIONAL
  • config:
    • layout:
      • type: "GRID" | "SPOTLIGHT" | "SIDEBAR"
      • priority: "SPEAKER" | "PIN"
      • gridSize: Number max 4
    • theme: "DARK" | "LIGHT" | "DEFAULT"
    • mode: "video-and-audio" | "audio"
    • quality: "low" | "med" | "high"
OPTIONAL
Webhook URL
OPTIONAL
Your AWS S3 Bucket Path.
POST
|
https://api.videosdk.live/v2/recordings/start
import fetch from 'node-fetch';
const options = {
method: "POST",
headers: {
"Authorization": "$YOUR_TOKEN",
"Content-Type": "application/json",
},
body: JSON.stringify({"roomId" : "abcd-efgh-ijkl","templateUrl" : "https://www.example.com/?token=token&meetingId=74v5-v21l-n1ey&participantId=RECORDER_ID","config" : "configObj","webhookUrl" : "https://www.example.com/","awsDirPath" : "s3path"}),
};
const url= `https://api.videosdk.live/v2/recordings/start`;
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
RESPONSE
"Recording started successfully"