Sign in
bot

List Bots

Get a list of all bots

The base rate limit for this endpoint is:

  • 60 requests per min per workspace
get/api/v1/bot/

Query parameters

join_at_afterstring date
join_at_beforestring date
meeting_urlstring
metadata__<key>string

Filter by metadata. Replace <key> with the metadata key you want to filter on.

pageinteger

A page number within the paginated result set.

platformstring[]
  • zoom - Zoom
  • google_meet - Meet
  • goto_meeting - Goto
  • microsoft_teams - Teams
  • microsoft_teams_live - Teams Live
  • webex - Webex
  • chime_sdk - Chime Sdk
  • zoom_rtms - Zoom Rtms
  • google_meet_media_api - Google Meet Media Api
  • slack_authenticator - Slack Authenticator
  • slack_huddle_observer - Slack Huddle Observer
statusstring[]
  • 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
use_cursorstring

When present, uses cursor-based pagination instead of offset pagination.

Response

countinteger
nextstring uri nullable
previousstring uri nullable

Changes

Changed in 4 of the 6 revisions of this API.375

  • 56a9d14b7f103See the full diff
    • ●

      removed the optional property results/items/recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/gladia_v2_async/callback from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property results/items/recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/gladia_v2_async/callback_config from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property results/items/recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/gladia_v2_async/callback_url from the response with the 200 status

      response-optional-property-removed

  • 55ce8c277c241See the full diff
    • ○

      added the optional property results/items/recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/deepgram_async/credential_id to the response with the 200 status

      response-optional-property-added

  • e1a54c5db7902See the full diff
    • ○

      the response optional property results/items/join_at became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      the response property results/items/join_at became required for the status 200

      response-property-became-required

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 01244e56b3a1342See the full diff
    • ▲

      added BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointRtmp BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebsocket BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebhook BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointDesktopSdkCallback to the results/items/recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      the results/items/recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property results/items/recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/type from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property results/items/recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/events from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property results/items/recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/metadata from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property results/items/recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/url from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new melia-1 enum value to the results/items/recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/speechmatics_async/transcription_config/operating_point response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property results/items/recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/speechmatics_async/transcription_config/model to the response with the 200 status

      response-optional-property-added

    • ○

      added discriminator to results/items/recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/ response property for the response status 200

      response-property-discriminator-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog