CreateBotRequest

Mixin class providing meeting URL validation for serializers.

  • bot_name
    Type: string
    min length:  
    1
    required

    The name of the bot to create, e.g. 'My Bot'

  • meeting_url
    Type: string
    min length:  
    1
    required

    The URL of the meeting to join, e.g. https://zoom.us/j/123?pwd=456

  • automatic_leave_settings
    Type: object
    Properties: 9
  • bot_chat_message
    Type:

    The chat message the bot sends after it joins the meeting

    Properties: 3
  • bot_image
    Type:

    The image for the bot

    Properties: 2
  • calendar_event_id
    Type: string
    min length:  
    1

    The ID of the calendar event the bot should join.

  • callback_settings
    Type: object

    Callback urls for the bot to call when it needs to fetch certain data.

    Properties: 1
  • debug_settings
    Type: object

    The debug settings for the bot, e.g. {'create_debug_recording': True}.

    Properties: 1
  • deduplication_key
    Type: string
    min length:  
    1

    Optional key for deduplicating bots. If a bot with this key already exists in a non-terminal state, the new bot will not be created and an error will be returned.

  • external_media_storage_settings
    Type: object

    Settings that allow Attendee to upload the recording to an external storage bucket controlled by you. This relieves you from needing to download the recording from Attendee and then upload it to your own storage. To use this feature you must add credentials to your project that provide access to the external storage.

    Properties: 2
  • google_meet_settings
    Type: object

    The Google Meet-specific settings for the bot.

    Properties: 4
  • join_at
    Type: stringFormat: date-time

    The time the bot should join the meeting. ISO 8601 format, e.g. 2025-06-13T12:00:00Z

  • metadata
    Type: object

    JSON object containing metadata to associate with the bot

  • recording_settings
    Type: object

    The settings for the bot's recording.

    Properties: 5
  • rtmp_settings
    Type: object

    RTMP server to stream to, e.g. {'destination_url': 'rtmp://global-live.mux.com:5222/app', 'stream_key': 'xxxx'}.

    Properties: 2
  • teams_settings
    Type: object

    The Microsoft Teams-specific settings for the bot.

    Properties: 3
  • transcription_settings
    Type: object

    The transcription settings for the bot, e.g. {'deepgram': {'language': 'en'}}

    Properties: 10
  • voice_agent_settings
    Type: object

    Settings for the voice agent that the bot should load.

    Properties: 3
  • webhooks
    Type: array of object

    List of webhook subscriptions to create for this bot. Each item should have 'url' and 'triggers' fields.

    Properties: 2
  • websocket_settings
    Type: object

    The websocket settings for the bot, e.g. {'audio': {'url': 'wss://example.com/audio', 'sample_rate': 16000}}

    Properties: 3
  • zoom_settings
    Type: object

    The Zoom-specific settings for the bot.

    Properties: 2
Previous
ChatMessage
Next
CreateCalendarRequest