List Bots

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

Get a list of all bots

time	status	user agent
Retrieving recent requests…

Loading…

🚧
Meeting URL response shape
Meeting URL's are currently improperly reflected in the API spec for meeting URL's in responses. For proper meeting URL shapes in API responses, please see Meeting URL's.
meeting_url's that are provided as a parameter to the API are reflected accurately in the API spec as strings.

Relevant links:

Meeting Metadata & Participants

Custom Metadata Filtering

To filter bots by metadata, add query params in the form metadata__KEY=VALUE. When a metadata key / value pair is used only bots with all of the key / value pairs as metadata will be returned.

Query Params

join_at_after

date-time

join_at_before

date-time

meeting_url

string

page

integer

A page number within the paginated result set.

platform

array of strings

zoom - Zoom
google_meet - Meet
goto_meeting - Goto
microsoft_teams - Teams
microsoft_teams_live - Teams Live
webex - Webex
chime_sdk - Chime Sdk
slack_authenticator - Slack Authenticator
slack_huddle_observer - Slack Huddle Observer

platform

status

array of strings

ready - Ready
joining_call - Joining Call
in_waiting_room - In Waiting Room
in_call_not_recording - In Call Not Recording
recording_permission_allowed - Recording Permission Allowed
recording_permission_denied - Recording Permission Denied
in_call_recording - In Call Recording
recording_done - Recording Done
call_ended - Call Ended
done - Done
fatal - Fatal
media_expired - Media Expired
analysis_done - Analysis Done
analysis_failed - Analysis Failed

status

Response

Response body

object

count

integer

uri | null

results

array of objects

results

object

uuid

required

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 ≤ 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. Once a bot has joined a call, it's join_at will be cleared.

video_url

uri

required

A URL where the video recorded by the bot can be downloaded. This is null while the recording is in progress, and will be populated when the recording is completed. The returned URL is valid for 6 hours from the API call. A fresh URL can be obtained at any point by calling the API again.

media_retention_end

date-time

required

After this date the video and transcript will be deleted. This date is 7 days from when the recording ended.

status_changes

array of objects

required

status_changes*

object

code

string

required

message

string

required

created_at

date-time

required

sub_code

string

required

meeting_metadata

object | null

required

meeting_participants

array of objects

required

meeting_participants*

object

integer

required

name

string

required

events

array of objects

required

events*

object

code

string

required

created_at

date-time

required

is_host

boolean

required

platform

string

required

extra_data

object

required

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

Defaults to speaker_view

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

speaker_view gallery_view gallery_view_v2 audio_only

recording_mode_options

object | null

Additional options for recording mode.

include_bot_in_recording

object

recordings

array of objects

required

recordings*

object

uuid

required

created_at

date-time

required

started_at

date-time | null

completed_at

date-time | null

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. Recommended resolution is 640x360.

automatic_audio_output

object | null

(BETA) Settings for the bot to output audio.

chat

object | null

(BETA) 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"}.

calendar_meetings

array of objects

required

The calendar meetings associated with this bot. This field is populated only for bots that are dispatched via Calendar V1 API integration.

calendar_meetings*

object

uuid

required

start_time

date-time

required

end_time

date-time

required

calendar_user

object

required

zoom

object | null

Zoom specific parameters

google_meet

object | null

Google Meet specific parameters

slack_team

object | null

required

metadata

object

Has additional fields

recording

string

required

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us-east-1.recall.ai/api/v1/bot/ \
3
     --header 'accept: application/json'

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

application/json

🚧Meeting URL response shape

Custom Metadata Filtering

200

🚧
Meeting URL response shape