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

Authorization

REQUIRED

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

Content-Type

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

roomId

REQUIRED

The ID of the Room.

templateUrl

OPTIONAL

Customize Layout of Meeting Recording.

transcription

OPTIONAL

• transcription:
  • enabled: true | false
  • summary:
    • enabled: true | false
    • prompt: “Your customized summary prompt”

config

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"

  low corresponds to SD recording, med to HD recording, and high to Full HD recording. Please refer FAQ for pricing impact

webhookUrl

OPTIONAL

Webhook URL

awsDirPath

OPTIONAL

Your AWS S3 Bucket Path.

preSignedUrl

OPTIONAL

Your presigned url of cloud.

POST

|

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

NodeJS

• cURL
• NodeJS
• PHP
• Python

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"