Sign in
bot

Retrieve Bot

Changed on

Get a bot instance.

This endpoint is rate limited to:

  • 300 requests per min per workspace
get/api/v1/bot/{id}/

Request

  • Base URL: https://us-east-1.recall.ai
  • URL: https://us-east-1.recall.ai/api/v1/bot/{id}/
  • Auth: API key in header Authorization

Path parameters

idstring uuid required

A UUID string identifying this bot.

Response

idstring uuid required
bot_namestring

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_atstring date-time nullable

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.

metadataobject

Changes

  • 4ec07bd63db2Revision changes
    • warning

      added the new hr enum value to the //////////////////////// response property for the response status

    • warning

      added the new hr enum value to the ////////////////// response property for the response status

    • warning

      added the new hr enum value to the ////////////////////////// response property for the response status

  • 0e8162db9d27Revision changes
    • breaking

      added subschema #1 subschema #2 to the response property oneOf list for the response status

    • breaking

      the response's property type changed from string to no type for status