Create Bot

post

https://us-east-1.recall.ai/api/v1/bot/

Create a new bot.

The base rate limit for this endpoint is:

120 requests per min per workspace

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

meeting_url

string

required

The url of the meeting. For example, https://zoom.us/j/123?pwd=456. This field will be cleared a few days after the bot has joined a call.

bot_name

string

length between 1 and 100

Defaults to Meeting Notetaker

The name of the bot that will be displayed in the call. (Note: Authenticated Google Meet bots will use the Google account name and this field will be ignored.)

join_at

date-time | null

The time at which the bot will join the call, formatted in ISO 8601. This field can only be read from scheduled bots that have not yet joined a call.

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

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.

include_bot_in_recording

object

output_media

object | null

Settings for the bot output media.

automatic_video_output

object | null

Settings for the bot to output video. Image should be 16:9. Read more about this here: https://docs.recall.ai/docs/output-video-in-meetings

automatic_audio_output

object | null

Settings for the bot to output audio.

chat

object | null

Settings for the bot to send chat messages. (Note: Chat functionality is only supported for Zoom, Google Meet and Microsoft Teams currently.)

automatic_leave

object | null

variant

object | null

Configure bot variants per meeting platforms, e.g. {"zoom": "web_4_core"}.

zoom

object | null

Zoom specific parameters

google_meet

object | null

Google Meet specific parameters

webex

object | null

Webex specific parameters

breakout_room

object | null

Configure how the bot handles breakout rooms. Currently, Zoom is supported.Examples: {"mode": "join_main_room"} | {"mode": "join_specific_room", "room_id": ""} | {"mode": "auto_accept_all_invites"} (default).

metadata

object

retention

object | null

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

Responses

400

No response body

201

507