RErecall
bot

Start Screenshare

Changed on

Causes the bot to start screensharing.

The base rate limit for this endpoint is:

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

Request

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

Path parameters

idstring uuid required

A UUID string identifying this bot.

Request body

kind'jpeg' required
  • jpeg - jpeg
b64_datastring required

Data encoded in Base64 format, using the standard alphabet (specified here: https://datatracker.ietf.org/doc/html/rfc4648#section-4)

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.

metadataobject

Changes

  • b72a4beeaeb3Revision changes
    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property ///////////////// to the response with the status

  • 04ea13759f97Revision changes
    • info

      added the required property ///////////////// to the response with the status