bot

Create Bot

Changed on

Create a new bot.

This endpoint is rate limited to:

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

Request

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

Request body

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

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

    • info

      added the new hr enum value to the request property //////////////////////// (media type: application/json)

    • info

      added the new hr enum value to the request property //////////////////////// (media type: application/x-www-form-urlencoded)

    • info

      added the new hr enum value to the request property //////////////////////// (media type: multipart/form-data)

    • info

      added the new hr enum value to the request property ////////////////// (media type: application/json)

    • info

      added the new hr enum value to the request property ////////////////// (media type: application/x-www-form-urlencoded)

    • info

      added the new hr enum value to the request property ////////////////// (media type: multipart/form-data)

    • info

      added the new hr enum value to the request property ////////////////////////// (media type: application/json)

    • info

      added the new hr enum value to the request property ////////////////////////// (media type: application/x-www-form-urlencoded)

    • info

      added the new hr enum value to the request property ////////////////////////// (media type: multipart/form-data)

  • 0e8162db9d27Revision changes
    • breaking

      the request property type changed from string to no type (media type: application/json)

    • 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

    • info

      added subschema #1 subschema #2 to the request property oneOf list (media type: application/json)

    • info

      added subschema #1 subschema #2 to the request property oneOf list (media type: application/x-www-form-urlencoded)

    • info

      added subschema #1 subschema #2 to the request property oneOf list (media type: multipart/form-data)

    • info

      the request property type was generalized from string to no type (media type: application/x-www-form-urlencoded)

    • info

      the request property type was generalized from string to no type (media type: multipart/form-data)