Create Bot
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.
meeting_link
The URL of the Google Meet, Zoom, or Teams meeting.
bot_name
The display name the bot will use in the meeting.
video_required
Whether the bot should record video.
bot_message
An initial message for the bot to post in the meeting chat.
bot_image_url
URL for the bot's profile picture or avatar.
callback_url
A URL to receive webhook event callbacks.
join_at
ISO 8601 datetime to schedule the bot to join the meeting.
agent_config_id
The ID of the agent configuration to enable agentic features.
custom_attributes
Arbitrary key-value metadata attached to the bot.
socket_connection_url
WebSocket URL for two-way audio/data bridge connection.
live_audio_required
WebSocket URL to stream live audio output from the meeting.
live_video_required
WebSocket URL to stream live video output from the meeting.
live_transcription_required
Webhook URL to receive live transcription events.
automatic_leave
recording_config
Response
Created
bot_id
transcript_id
meeting_url
status
