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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

A UUID string identifying this bot.

Body Params
transcript
object | null

Specify this to capture transcript of the meeting as part of the recording. Supports:

Read more about real-time transcription.

Default: null

realtime_endpoints
array of objects
Defaults to

Add endpoints here to receive data (e.g transcript, participant events) from the recording in realtime during the meeting.

Default: []

realtime_endpoints
retention
object | null

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

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:
video_mixed_mp4
object | null

Capture mixed video of the meeting as part of the recording. This is enabled by default.

Default: {}

participant_events
object | null

Capture participant events as part of the recording. This is enabled by default.

Default: {}

meeting_metadata
object | null

Capture meeting metadata as part of the recording. This is enabled by default.

Default: {}

string
enum
Defaults to overlap
  • hide - hide
  • beside - beside
  • overlap - overlap
Allowed:
string
enum
Defaults to participant_join
  • call_join - call_join
  • participant_join - participant_join
  • participant_speak - participant_speak
Allowed:
include_bot_in_recording
object
metadata
object
audio_mixed_raw
object | null

Specify this to capture mixed audio in raw format of the meeting.

Default: null

audio_mixed_mp3
object | null

Specify this to capture mixed audio in the mp3 format of the meeting

Default: null

video_separate_mp4
object | null

Specify this to capture separate video in mp4 format for each participant in the meeting. Only supported with video_mixed_layout='gallery_view_v2'. Read more in this guide

Default: null

audio_separate_raw
object | null

Specify this to capture separate audio in raw format for each participant in the meeting(limited support). Read more in this guide

Default: null

audio_separate_mp3
object | null

Specify this to capture separate audio in mp3 format for each participant in the meeting. Read more in this guide

Default: null

video_mixed_flv
object | null

Specify this to capture mixed video in flv format(**required for rtmp streaming).

Default: null

video_separate_png
object | null

Specify this to capture separate video in png format for each participant in the meeting. Only supported with video_mixed_layout='gallery_view_v2'. Read more in this guide

Default: null

video_separate_h264
object | null

Specify this to capture separate video in compressed h264 for each participant in the meeting. Read more in this guide

Default: null

Responses

400

No response body

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json