Start Recording

post

https://us-east-1.recall.ai/api/v1/bot/{id}/start_recording/

Instructs the bot to start recording the meeting. This will restart the current recording if one is already in progress.

The base rate limit for this endpoint is:

300 requests per min per workspace

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

A UUID string identifying this bot.

Body Params

recording_mode

string

enum

Defaults to speaker_view

speaker_view - speaker_view
gallery_view - gallery_view
gallery_view_v2 - gallery_view_v2
audio_only - audio_only

Allowed:

recording_mode_options

object | null

Additional options for recording mode.

real_time_transcription

object | null

The settings for real-time transcription.

real_time_media

object | null

The settings for real-time media output.

transcription_options

object | null

retention

object | null

Specify the retention policy for the recording. Read more in this guide

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

No response body

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200