Sign in

v3

latestOpenAPI 3.0.32026-07-31112307733.3 KB
bot

Start Screenshare

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/

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