Create Bot

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this endpoint to:

  • Schedule a bot to join planned meetings and capture recordings, transcripts, and meeting data.
  • Join ad-hoc meetings when a bot can't be scheduled in advance.
  • Stream real-time video and audio from a meeting to your app.
  • Create interactive agents that join calls to answer questions, guide workflows, or respond in real time.
❗️

In production, use scheduled bots by setting the join_at parameter to a time at least 10 minutes in the future to guarantee your bot will join on time.

You should use ad-hoc bots sparingly, only when your use case requires it (e.g. for spontaneous meetings). You can create ad-hoc bots by omitting the join_at or setting it to a time that is less than 10 minutes in the future.

📘

Bot status change events

To track bot lifecycle/status changes, listen for bot status change webhook events. Do not poll the API for bot status changes. Polling for bot status changes is an anti-pattern and must not be used in production integrations.

Bot status change events are delivered through the webhook configured in the Recall webhook dashboard. They cannot be subscribed to through recording_config.realtime_endpoints.

See Status Change Webhooks for setup and verification details, and Bot Webhooks for the list of available bot status changes.

Body Params
string
required
string
length between 1 and 100
Defaults to Meeting Notetaker
date-time | null
recording_config
object | null
output_media
object | null
automatic_video_output
object | null
automatic_audio_output
object | null
chat
object | null
automatic_leave
object | null
variant
object | null
zoom
object | null
google_meet
object | null
webex
object | null
breakout_room
object | null
metadata
object
Headers
string
enum
Defaults to application/json
Allowed:
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