Bot Endpoints

Create Bot

View as Markdown
This endpoint supports 20 different payload variations. Use the dropdown above the code panel to explore configurations for various use cases.

Authentication

Authorizationstring

Format: Token <your_api_key>

Request

This endpoint expects an object.
bot_namestringRequired
The display name the bot will use in the meeting.
video_requiredbooleanOptionalDefaults to true
Whether the bot should record video.
zoomobjectOptional

Zoom-specific configuration options.

audio_separate_streamsbooleanOptional
Enable separate audio streams feature.
video_separate_streamsbooleanOptional
Enable separate video streams feature.
bot_messagestringOptional
An initial message for the bot to post in the meeting chat.
bot_image_urlstringOptional
URL for the bot's profile picture or avatar.
callback_urlstringOptional
A URL to receive webhook event callbacks.
join_atdatetimeOptional
ISO 8601 datetime to schedule the bot to join the meeting.
agent_config_idstringOptional
The ID of the agent configuration to enable agentic features.
custom_attributesmap from strings to anyOptional

Arbitrary key-value metadata attached to the bot.

socket_connection_urlobjectOptional

WebSocket URL for two-way audio/data bridge connection.

live_audio_requiredobjectOptional
WebSocket URL to stream live audio output from the meeting.
live_video_requiredobjectOptional
WebSocket URL to stream live video output from the meeting.
workflow_config_idslist of stringsOptional

List of workflow configuration IDs to trigger post-meeting.

live_transcription_requiredobjectOptional
Webhook URL to receive live transcription events.
automatic_leaveobjectOptional
recording_configobjectOptional

Response

Created
bot_idstring
transcript_idstring or null
meeting_urlstring
statusstring