Create a bot

Whether to allow multiple bots to join the same meeting.

If set to false, only a single bot will be allowed to join using the same meeting URL within the last 5 minutes. This prevents duplicate bots from joining the same meeting.

If set to true (default), multiple bots can join the same meeting URL.

Default: true

The bot's avatar image(s).

Accepts a single HTTPS URL or an array of up to 5 HTTPS URLs pointing to image files (JPEG, PNG, or WebP). When multiple images are provided, they will be cycled based on the bot_image_config settings.

Configuration for how bot avatar images are displayed. Only relevant when multiple images are provided in bot_image.

The name requested for the bot.

This name is displayed for anonymous joins. For an authenticated Microsoft Teams join using teams_config, Microsoft Teams ignores this value and displays the signed-in Microsoft 365 account's display name and profile instead.

For a Microsoft Teams meeting the name must be one Teams accepts for a guest, or the request is rejected: at most 50 characters; only letters, numbers, spaces and ' ’ . _ @ - · ・; no consecutive spaces; and no leading, trailing or consecutive periods. This applies to authenticated joins too, because a failed sign-in falls back to joining as a guest under this name.

Enable callback for this bot. When enabled, the callback_config property is used to provide the configuration.

The message that the bot will send when it joins the meeting.

This message will be posted in the meeting chat when the bot successfully joins.

Available for Google Meet, Microsoft Teams, and Zoom meetings.

Maximum: 4096 characters

An optional extra configuration object for the bot.

This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:

• Included in all webhook event payloads (if a webhook endpoint is configured)
• Part of the callback payload (if callback is enabled)
• Returned when fetching the bot's details via the API

Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.

Participant names to ignore when evaluating auto-leave conditions.

The bot will not count participants matching these names when determining whether to leave a meeting. This is useful when multiple bots may join the same meeting across different environments (e.g., sandbox, staging).

By ignoring other bots' participant names, each bot can correctly detect when human participants have left and leave the meeting rather than remaining indefinitely.

Meet-only configuration for authenticated bots via SAML SSO.

• credential_id: pin a specific login.
• email_group: pool selector (preferred — takes priority).
• fallback: 'fail' (default) or 'anonymous' on saturation.

Leave null for anonymous Meet joins, Zoom, or Microsoft Teams.

The URL of the meeting to join.

Must be a valid HTTPS URL for a Microsoft Teams, Google Meet, or Zoom meeting.

Example: "https://zoom.us/j/123456789" or "https://meet.google.com/abc-defg-hij"

The recording mode of the bot.

Determines what the bot records during the meeting:

• speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.
• audio_only: Records only the audio without video.
• gallery_view: Records the entire gallery view (coming soon).

Default: speaker_view

Enable audio streaming for this bot. When enabled, the streaming_config property is used to provide the configuration.

Teams-only configuration for authenticated bots via a signed-in Microsoft account.

Microsoft Teams displays the selected account's Microsoft 365 name and profile; bot_name is ignored for the authenticated join.

• credential_id: pin a specific login and display identity.
• email_group: least-loaded pool selector (takes priority).
• fallback: 'fail' (default) or 'anonymous' on saturation.

Leave null for anonymous Teams joins, Zoom, or Google Meet.

Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout. Optional max_recording_duration sets a hard cap on total recording time (up to 12 hours).

Enable transcription for this bot. When enabled, the transcription_config property is used to customise the transcription provider and parameters.

Zoom-only configuration for authentication and join method.

• credential_id: Use a stored Zoom credential (OBF token fetched by the bot from the API server).
• credential_user_id: Resolve a stored credential by Zoom user ID.
• obf_token: Provide a direct OBF token (one-off join).
• obf_token_url: URL that returns an OBF token when the bot joins.
• zak_token_url: URL that returns a ZAK for joining without the host.

Leave null for Google Meet and Microsoft Teams.