Bot
idstring<uuid>Unique bot identifier
statusstringThe current lifecycle status of the bot. Refer to the [Bot Lifecycle](/guides/bot-lifecycle) guide for a detailed explanation of each state. *Note on `bot_detected`:* This is often non-terminal. Skribby automatically retries up to 3 times. You may see the status toggle between `bot_detected` and `booting` during retries.
scheduledbootingjoiningrecordingprocessingtranscribingleavingfinishednot_admittedbot_detectedauth_requiredinvalid_credentialsfailedstop_reasonstringnullThe reason why the bot stopped. This field is only populated when the status is `finished` or `not_admitted`. Refer to the [Bot Lifecycle](/guides/bot-lifecycle#stop-reasons) guide for the machine-to-human mapping of these codes.
invalid_meeting_urlcall_already_finishedwaiting_room_timeoutrequest_deniedhost_in_another_meetingmanually_stoppedkickedmeeting_endedlast_person_detectedsilence_detection_triggeredservicestringService the bot joined
gmeetteamszoomscheduled_forstring,null<date-time>When the bot is scheduled to join (for scheduled bots)
time_limitintegernullUse `time_limit` property in `stop_options`.
stop_optionsobjectDefined options when the bot should stop on certain conditions.
bot_namestringName of the bot as it appears in the meeting. This may be truncated from the original input if it exceeded platform limits (Teams: 50, Meet: 60, Zoom: 64 characters).
bot_avatarstring,null<uri>URL to bot avatar image
meeting_urlstring<uri>URL of the meeting
webhook_urlstring,null<uri>Webhook URL for receiving updates. Refer to the [Webhooks](/docs/guides/webhook-events) section for details on webhook format and available events.
custom_metadataobjectMetadata attached to the bot for tracking requests in your system. Keys and values must be strings. Up to 50 keys, each value up to 500 characters. Clearing metadata returns an empty object in responses.
recording_urlstring,null<uri>URL to download the recording
recording_available_untilstring,null<date-time>When the recording will be automatically deleted
websocket_urlstring,null<uri>WebSocket URL for real-time transcription (realtime models only)
websocket_read_only_urlstring,null<uri>WebSocket URL for real-time transcription (realtime models only) - Only provides access to events, no actions. Useful if you want to use the websocket directly in your front-end without providing access to the user.
websocket_audio_urlstring,null<uri>WebSocket URL for receiving realtime audio data from the bot. Only available when using a realtime model or when `realtime_audio: true` was set when creating the bot. Audio is streamed as 16-bit PCM at 16kHz sample rate.
videobooleanWhether video is recorded for this meeting
langstringnullLanguage specified when creating the bot
detected_langstringnullLanguage detected from the conversation (if supported by the model)
transcriptref[]Array of transcript segments
transcription_modelstringModel used for transcription
participantsref[]List of meeting participants
eventsref[]List of bot lifecycle events
profanity_filterbooleanWhether profanity filter was enabled
custom_vocabularystring[]Words or phrases provided when creating meeting bot for transcription model
created_atstring<date-time>When the bot was created
finished_atstring,null<date-time>When the bot finished