Skip to main content
Version: /v2

Start Recording - API

This API lets you record your room by passing roomId and config object as body parameters.

HTTP method and endpoint

POST

|

https://api.videosdk.live/v2/recordings/start
Headers Parameters

values : YOUR_TOKEN_WITHOUT_ANY_PREFIX

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

REQUIRED

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
REQUIRED
The ID of the Room.
  • transcription:
    • enabled: true | false
    • summary:
      • enabled: true | false
      • prompt: “Your customized summary prompt”
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"
    • orientation: "portrait" | "landscape"
OPTIONAL
Webhook URL
OPTIONAL
Your AWS S3 Bucket Path.
OPTIONAL
Your presigned url of cloud.
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",
"transcription" : "transcriptionObj",
"config" : "configObj",
"webhookUrl" : "https://www.example.com/",
"awsDirPath" : "s3path",
"preSignedUrl" : "preSignedUrl"
}),
};
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"

Got a Question? Ask us on discord