,
, , , and ."}},"required":["message"]},"BotImageRequest":{"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/TypeEnum"}],"description":"Image content type. Currently only PNG is supported.\n\n* `image/png` - image/png"},"data":{"type":"string","minLength":1,"description":"Base64 encoded image data. Simple example of a red pixel encoded in PNG format: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="}},"required":["data","type"]},"BotStateEnum":{"type":"string","enum":["ready","joining","joined_not_recording","joined_recording","leaving","post_processing","fatal_error","waiting_room","ended","data_deleted","scheduled","staged","joined_recording_paused","joining_breakout_room","leaving_breakout_room","joined_recording_permission_denied"]},"Calendar":{"type":"object","properties":{"id":{"type":"string"},"platform":{"allOf":[{"$ref":"#/components/schemas/PlatformEnum"}],"readOnly":true},"client_id":{"type":"string","readOnly":true},"platform_uuid":{"type":["string","null"],"readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/CalendarStateEnum"}],"readOnly":true},"metadata":{"type":"object","description":"Metadata associated with the calendar","readOnly":true},"deduplication_key":{"type":["string","null"],"readOnly":true,"description":"Optional key for deduplicating calendars"},"connection_failure_data":{"readOnly":true,"nullable":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true},"last_successful_sync_at":{"type":["string","null"],"format":"date-time","readOnly":true},"last_attempted_sync_at":{"type":["string","null"],"format":"date-time","readOnly":true}},"required":["client_id","connection_failure_data","created_at","deduplication_key","id","last_attempted_sync_at","last_successful_sync_at","metadata","platform","platform_uuid","state","updated_at"]},"CalendarEvent":{"type":"object","properties":{"id":{"type":"string"},"calendar_id":{"type":"string"},"platform_uuid":{"type":"string","readOnly":true},"meeting_url":{"type":["string","null"],"readOnly":true},"start_time":{"type":"string","format":"date-time","readOnly":true},"end_time":{"type":"string","format":"date-time","readOnly":true},"is_deleted":{"type":"boolean","readOnly":true},"attendees":{"readOnly":true,"nullable":true},"ical_uid":{"type":["string","null"],"readOnly":true},"name":{"type":["string","null"],"readOnly":true},"raw":{"readOnly":true},"bots":{"type":"array","items":{"$ref":"#/components/schemas/Bot"},"readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["attendees","bots","calendar_id","created_at","end_time","ical_uid","id","is_deleted","meeting_url","name","platform_uuid","raw","start_time","updated_at"]},"CalendarStateEnum":{"type":"string","enum":["connected","disconnected"]},"ChatMessage":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"timestamp_ms":{"type":"string","readOnly":true},"timestamp":{"type":"integer"},"to":{"type":"string","readOnly":true},"sender_name":{"type":"string"},"sender_uuid":{"type":"string"},"sender_user_uuid":{"type":["string","null"]},"additional_data":{}},"required":["additional_data","id","sender_name","sender_user_uuid","sender_uuid","text","timestamp","timestamp_ms","to"]},"CreateBotRequest":{"type":"object","description":"Mixin class providing meeting URL validation for serializers.","properties":{"meeting_url":{"type":"string","minLength":1,"description":"The URL of the meeting to join, e.g. https://zoom.us/j/123?pwd=456"},"bot_name":{"type":"string","minLength":1,"description":"The name of the bot to create, e.g. 'My Bot'"},"bot_image":{"allOf":[{"$ref":"#/components/schemas/BotImageRequest"}],"description":"The image for the bot"},"metadata":{"type":"object","description":"JSON object containing metadata to associate with the bot","examples":[{"client_id":"abc123","user":"john_doe","purpose":"Weekly team meeting"}]},"bot_chat_message":{"allOf":[{"$ref":"#/components/schemas/BotChatMessageRequestRequest"}],"description":"The chat message the bot sends after it joins the meeting"},"join_at":{"type":"string","format":"date-time","description":"The time the bot should join the meeting. ISO 8601 format, e.g. 2025-06-13T12:00:00Z"},"calendar_event_id":{"type":"string","minLength":1,"description":"The ID of the calendar event the bot should join."},"deduplication_key":{"type":"string","minLength":1,"description":"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."},"webhooks":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"The webhook URL (must be HTTPS)"},"triggers":{"type":"array","items":{"type":"string","enum":["bot.state_change","transcript.update","chat_messages.update","participant_events.join_leave","calendar.events_update","calendar.state_change"]},"description":"List of webhook trigger types","uniqueItems":true}},"required":["url","triggers"],"additionalProperties":false},"description":"List of webhook subscriptions to create for this bot. Each item should have 'url' and 'triggers' fields."},"callback_settings":{"type":"object","properties":{"zoom_tokens_url":{"type":"string","description":"URL of an endpoint on your server that returns Zoom authentication tokens the bot will use when it joins the meeting. Our server will make a POST request to this URL with information about the bot and expects a JSON response with the format: {\"zak_token\": \"\", \"join_token\": \"\", \"app_privilege_token\": \"\", \"onbehalf_token\": \"\"}. Not every token needs to be provided, i.e. you can reply with {\"zak_token\": \"\"}."}},"required":[],"additionalProperties":false,"description":"Callback urls for the bot to call when it needs to fetch certain data."},"external_media_storage_settings":{"type":"object","properties":{"bucket_name":{"type":"string","description":"The name of the external storage bucket to use for media files."},"recording_file_name":{"type":"string","description":"Optional custom name for the recording file"}},"required":["bucket_name"],"additionalProperties":false,"description":"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."},"voice_agent_settings":{"type":"object","properties":{"url":{"type":"string","description":"URL of a website containing a voice agent that gets the user's responses from the microphone. The bot will load this website and stream its video and audio to the meeting. The audio from the meeting will be sent to website via the microphone. See https://docs.attendee.dev/guides/voice-agents for further details. The video will be displayed through the bot's webcam. To display the video through screenshare, use the screenshare_url parameter instead."},"screenshare_url":{"type":"string","description":"Behaves the same as url, but the video will be displayed through screenshare instead of the bot's webcam. Currently, you cannot provide both url and screenshare_url."},"reserve_resources":{"type":"boolean","description":"If you want to start a voice agent or stream a webpage mid-meeting, but not at the start of the meeting, set this to true. This will reserve resources for the voice agent. You cannot start a voice agent mid-meeting if this is not set to true.","default":false}},"additionalProperties":false,"description":"Settings for the voice agent that the bot should load."},"transcription_settings":{"type":"object","properties":{"deepgram":{"type":"object","properties":{"language":{"type":"string","description":"The language code for transcription. Defaults to 'multi' if not specified, which selects the language automatically and can change the detected language in the middle of the audio. See here for available languages: https://developers.deepgram.com/docs/models-languages-overview."},"detect_language":{"type":"boolean","description":"Whether to automatically detect the spoken language. Can only detect a single language for the entire audio. This is only supported for an older model and is not recommended. Please use language='multi' instead."},"callback":{"type":"string","description":"The URL to send the transcriptions to. If used, the transcriptions will be sent directly from Deepgram to your server so you will not be able to access them via the Attendee API. See here for details: https://developers.deepgram.com/docs/callback"},"keyterms":{"type":"array","items":{"type":"string"},"description":"Improve recall of key terms or phrases in the transcript. This feature is only available for the nova-3 model in english, so you must set the language to 'en'. See here for details: https://developers.deepgram.com/docs/keyterm"},"keywords":{"type":"array","items":{"type":"string"},"description":"Improve recall of key terms or phrases in the transcript. This feature is only available for the nova-2 model. See here for details: https://developers.deepgram.com/docs/keywords"},"model":{"type":"string","description":"The model to use for transcription. Defaults to 'nova-3' if not specified, which is the recommended model for most use cases. See here for details: https://developers.deepgram.com/docs/models-languages-overview"},"redact":{"type":"array","items":{"type":"string","enum":["pci","pii","numbers"]},"uniqueItems":true,"description":"Array of redaction types to apply to transcription. Automatically removes or masks sensitive information like PII, PCI data, and numbers from transcripts. See here for details: https://developers.deepgram.com/docs/redaction"},"replace":{"type":"array","items":{"type":"string"},"description":"Array of terms to find and replace in the transcript. Each string should be in the format 'term_to_find:replacement_term' (e.g., 'kpis:Key Performance Indicators'). See here for details: https://developers.deepgram.com/docs/find-and-replace"},"use_eu_server":{"type":"boolean","description":"Whether to use the EU server for transcription. Defaults to false."}},"additionalProperties":false},"gladia":{"type":"object","properties":{"code_switching_languages":{"type":"array","items":{"type":"string"},"description":"The languages to transcribe the meeting in when using code switching. See here for available languages: https://docs.gladia.io/chapters/limits-and-specifications/languages"},"enable_code_switching":{"type":"boolean","description":"Whether to use code switching to transcribe the meeting in multiple languages."}},"additionalProperties":false},"meeting_closed_captions":{"type":"object","properties":{"google_meet_language":{"type":"string","description":"The language code for Google Meet closed captions (e.g. 'en-US'). See here for available languages and codes: https://docs.google.com/spreadsheets/d/1MN44lRrEBaosmVI9rtTzKMii86zGgDwEwg4LSj-SjiE"},"teams_language":{"type":"string","description":"The language code for Teams closed captions (e.g. 'en-us'). This will change the closed captions language for everyone in the meeting, not just the bot. See here for available languages and codes: https://docs.google.com/spreadsheets/d/1F-1iLJ_4btUZJkZcD2m5sF3loqGbB0vTzgOubwQTb5o/edit?usp=sharing"},"zoom_language":{"type":"string","enum":["Arabic","Cantonese","Chinese (Simplified)","Czech","Danish","Dutch","English","Estonian","Finnish","French","French (Canada)","German","Hebrew","Hindi","Hungarian","Indonesian","Italian","Japanese","Korean","Malay","Persian","Polish","Portuguese","Romanian","Russian","Spanish","Swedish","Tagalog","Tamil","Telugu","Thai","Turkish","Ukrainian","Vietnamese"],"description":"The language to use for Zoom closed captions. (e.g. 'Spanish'). This will change the closed captions language for everyone in the meeting, not just the bot."},"merge_consecutive_captions":{"type":"boolean","description":"The captions from Google Meet can end in the middle of a sentence, which is not ideal. This setting deals with that by merging consecutive captions for a given speaker that occur close together in time. Turned off by default."}},"additionalProperties":false},"openai":{"type":"object","properties":{"model":{"type":"string","enum":["gpt-4o-transcribe","gpt-4o-mini-transcribe","gpt-4o-transcribe-diarize"],"description":"The OpenAI model to use for transcription"},"prompt":{"type":"string","description":"Optional prompt to use for the OpenAI transcription"},"language":{"type":"string","description":"The language to use for transcription. See here in the 'Set 1' column for available language codes: https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes. This parameter is optional but if you know the language in advance, setting it will improve accuracy."},"response_format":{"type":"string","enum":["json","diarized_json"],"description":"The format of the transcription response. Only applicable for gpt-4o-transcribe-diarize model. Defaults to diarized_json when using gpt-4o-transcribe-diarize."},"chunking_strategy":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"object","properties":{"type":{"type":"string","enum":["server_vad"],"description":"Must be set to server_vad to enable manual chunking using server side VAD."},"prefix_padding_ms":{"type":"integer","description":"Amount of audio to include before the VAD detected speech (in milliseconds). Defaults to 300."},"silence_duration_ms":{"type":"integer","description":"Duration of silence to detect speech stop (in milliseconds). With shorter values the model will respond more quickly, but may jump in on short pauses from the user. Defaults to 200."},"threshold":{"type":"number","description":"Sensitivity threshold (0.0 to 1.0) for voice activity detection. A higher threshold will require louder audio to activate the model, and thus might perform better in noisy environments. Defaults to 0.5."}},"required":["type"],"additionalProperties":false}],"description":"The chunking strategy for transcription. Only applicable for gpt-4o-transcribe-diarize model. Defaults to auto when using gpt-4o-transcribe-diarize. Can be 'auto' or a server_vad object with optional prefix_padding_ms, silence_duration_ms, and threshold parameters."}},"required":["model"],"additionalProperties":false},"assembly_ai":{"type":"object","properties":{"language_code":{"type":"string","description":"The language code to use for transcription. See here for available languages: https://www.assemblyai.com/docs/speech-to-text/pre-recorded-audio/supported-languages"},"language_detection":{"type":"boolean","description":"Whether to automatically detect the spoken language."},"keyterms_prompt":{"type":"array","items":{"type":"string"},"description":"List of words or phrases to boost in the transcript. Only supported for when using the 'slam-1' speech model. See AssemblyAI docs for details."},"speech_model":{"type":"string","enum":["best","nano","slam-1","universal"],"description":"The speech model to use for transcription. See AssemblyAI docs for details."},"speaker_labels":{"type":"boolean","description":"Whether to enable AssemblyAI's ML-based diarization. Only needed if multiple people are speaking into a single microphone. Defaults to false."},"use_eu_server":{"type":"boolean","description":"Whether to use the EU server for transcription. Defaults to false."},"language_detection_options":{"type":"object","properties":{"expected_languages":{"type":"array","items":{"type":"string"}},"fallback_language":{"type":"string"}},"description":"Options for controlling the automatic language detection. See AssemblyAI docs for details.","additionalProperties":false}},"additionalProperties":false},"sarvam":{"type":"object","properties":{"model":{"type":"string","enum":["saarika:v2","saarika:v2.5"],"description":"The Sarvam model to use for transcription"},"language_code":{"type":"string","enum":["unknown","hi-IN","bn-IN","kn-IN","ml-IN","mr-IN","od-IN","pa-IN","ta-IN","te-IN","en-IN","gu-IN"],"description":"The language code to use for transcription"}},"required":[],"additionalProperties":false},"elevenlabs":{"type":"object","properties":{"model_id":{"type":"string","description":"The ElevenLabs model to use for transcription","enum":["scribe_v1","scribe_v1_experimental"]},"language_code":{"type":"string","description":"An ISO-639-1 or ISO-639-3 language_code corresponding to the language of the audio file."},"tag_audio_events":{"type":"boolean","description":"Whether to tag audio events like 'laughter' in the transcription."}},"required":["model_id"],"additionalProperties":false},"kyutai":{"type":"object","properties":{"server_url":{"type":"string","description":"The WebSocket URL of the Kyutai STT server (e.g., 'wss://your-domain.com/api/asr-streaming'). Must start with ws:// or wss://. If not provided, will use the server_url from project credentials."}},"required":[],"additionalProperties":false},"custom_async":{"type":"object","description":"Custom self-hosted transcription service with async processing. Additional properties will be sent as form data in the request. Only supported if self-hosting Attendee.","required":[],"additionalProperties":true}},"required":[],"description":"The transcription settings for the bot, e.g. {'deepgram': {'language': 'en'}}"},"websocket_settings":{"type":"object","properties":{"audio":{"type":"object","properties":{"url":{"type":"string","description":"The URL of the websocket to use for receiving meeting audio in real time and having the bot output audio in real time. It must start with wss://. See https://docs.attendee.dev/guides/realtime-audio-input-and-output for details on how to receive and send audio through the websocket connection."},"sample_rate":{"type":"integer","enum":[8000,16000,24000],"default":16000,"description":"The sample rate of the audio to send. Can be 8000, 16000, or 24000. Defaults to 16000."}},"required":["url"],"additionalProperties":false}},"required":[],"additionalProperties":false,"description":"The websocket settings for the bot, e.g. {'audio': {'url': 'wss://example.com/audio', 'sample_rate': 16000}}"},"rtmp_settings":{"type":"object","properties":{"destination_url":{"type":"string","description":"The URL of the RTMP server to send the stream to"},"stream_key":{"type":"string","description":"The stream key to use for the RTMP server"}},"required":["destination_url","stream_key"],"description":"RTMP server to stream to, e.g. {'destination_url': 'rtmp://global-live.mux.com:5222/app', 'stream_key': 'xxxx'}."},"recording_settings":{"type":"object","properties":{"format":{"type":"string","description":"The format of the recording to save. The supported formats are 'mp4', 'mp3' and 'none'. Defaults to 'mp4'."},"view":{"type":"string","description":"The view to use for the recording. The supported views are 'speaker_view', 'gallery_view' and 'speaker_view_no_sidebar'."},"resolution":{"type":"string","description":"The resolution to use for the recording. The supported resolutions are '1080p' and '720p'. Defaults to '1080p'.","enum":["1080p","720p"]},"record_chat_messages_when_paused":{"type":"boolean","description":"Whether to record chat messages even when the recording is paused. Defaults to false.","default":false},"reserve_additional_storage":{"type":"boolean","description":"Whether to reserve extra space to store the recording. Only needed when the bot will record video for longer than 6 hours. Defaults to false.","default":false}},"additionalProperties":false,"required":[],"default":{"format":"mp4","view":"speaker_view","resolution":"1080p","record_chat_messages_when_paused":false,"reserve_additional_storage":false},"description":"The settings for the bot's recording."},"google_meet_settings":{"type":"object","properties":{"use_login":{"type":"boolean","description":"Whether to use Google Meet bot login credentials to sign in before joining the meeting. Requires Google Meet bot login credentials to be set for the project.","default":false},"login_mode":{"type":"string","enum":["always","only_if_required"],"description":"The mode to use for the Google Meet bot login. 'always' means the bot will always login, 'only_if_required' means the bot will only login if the meeting requires authentication.","default":"always"}},"required":[],"additionalProperties":false,"default":{"use_login":false,"login_mode":"always"},"description":"The Google Meet-specific settings for the bot."},"teams_settings":{"type":"object","properties":{"use_login":{"type":"boolean","description":"Whether to use Teams bot login credentials to sign in before joining the meeting. Requires Teams bot login credentials to be set for the project.","default":false},"login_mode":{"type":"string","enum":["always","only_if_required"],"description":"The mode to use for the Teams bot login. 'always' means the bot will always login, 'only_if_required' means the bot will only login if the meeting requires authentication.","default":"always"}},"required":[],"additionalProperties":false,"default":{"use_login":false,"login_mode":"always"},"description":"The Microsoft Teams-specific settings for the bot."},"zoom_settings":{"type":"object","properties":{"sdk":{"type":"string","enum":["web","native"],"description":"The Zoom SDK to use for the bot. Use 'web' when you need closed caption based transcription.","default":"native"},"meeting_settings":{"type":"object","properties":{"allow_participants_to_unmute_self":{"type":"boolean"},"allow_participants_to_share_whiteboard":{"type":"boolean"},"allow_participants_to_request_cloud_recording":{"type":"boolean"},"allow_participants_to_request_local_recording":{"type":"boolean"},"allow_participants_to_share_screen":{"type":"boolean"},"allow_participants_to_chat":{"type":"boolean"},"enable_focus_mode":{"type":"boolean"}},"required":[],"additionalProperties":false,"description":"Settings for various aspects of the Zoom Meeting. To use these settings, the bot must have host privileges."}},"required":[],"additionalProperties":false,"default":{"sdk":"native"},"description":"The Zoom-specific settings for the bot."},"debug_settings":{"type":"object","properties":{"create_debug_recording":{"type":"boolean","description":"Whether to generate a recording of the attempt to join the meeting. Used for debugging."}},"required":[],"default":{"create_debug_recording":false},"description":"The debug settings for the bot, e.g. {'create_debug_recording': True}."},"automatic_leave_settings":{"type":"object","properties":{"silence_timeout_seconds":{"type":"integer","description":"Number of seconds of continuous silence after which the bot should leave","default":600},"silence_activate_after_seconds":{"type":"integer","description":"Number of seconds to wait before activating the silence timeout","default":1200},"only_participant_in_meeting_timeout_seconds":{"type":"integer","description":"Number of seconds to wait before leaving if bot becomes the only participant in the meeting because everyone else left.","default":60},"wait_for_host_to_start_meeting_timeout_seconds":{"type":"integer","description":"Number of seconds to wait for the host to start the meeting","default":600},"waiting_room_timeout_seconds":{"type":"integer","description":"Number of seconds to wait before leaving if the bot is in the waiting room","default":900},"max_uptime_seconds":{"type":"integer","description":"Maximum number of seconds that the bot should be running before automatically leaving (infinity)","default":null},"enable_closed_captions_timeout_seconds":{"type":"integer","description":"Number of seconds to wait before leaving if bot could not enable closed captions (infinity by default). Only relevant if the bot is transcribing via closed captions. Currently only supports leaving immediately.","default":null},"authorized_user_not_in_meeting_timeout_seconds":{"type":"integer","description":"Number of seconds to wait before leaving if the authorized user is not in the meeting. Only relevant if this is a Zoom bot using the on behalf of token.","default":600},"bot_keywords":{"type":["array","null"],"items":{"type":"string"},"description":"List of keywords to identify bot participants. A participant is considered a bot if any word in their name matches a keyword. Words are found by splitting on spaces, hyphens, and underscores, and the comparison is case-insensitive. Bot participants are excluded when determining if the bot is the only participant in the meeting.","default":null}},"required":[],"additionalProperties":false}},"required":["bot_name","meeting_url"]},"CreateCalendarRequest":{"type":"object","properties":{"platform_uuid":{"type":"string","minLength":1,"description":"The UUID of the calendar on the calendar platform. Specify only for non-primary calendars."},"client_id":{"type":"string","minLength":1,"description":"The client ID for the calendar platform authentication"},"client_secret":{"type":"string","minLength":1,"description":"The client secret for the calendar platform authentication"},"refresh_token":{"type":"string","minLength":1,"description":"The refresh token for accessing the calendar platform"},"platform":{"allOf":[{"$ref":"#/components/schemas/PlatformEnum"}],"description":"The calendar platform (google or microsoft)\n\n* `google` - Google\n* `microsoft` - Microsoft"},"metadata":{"description":"JSON object containing metadata to associate with the calendar"},"deduplication_key":{"type":"string","minLength":1,"description":"Optional key for deduplicating calendars. If a calendar with this key already exists in the project, the new calendar will not be created and an error will be returned."}},"required":["client_id","client_secret","platform","refresh_token"]},"OutputVideoRequestRequest":{"type":"object","properties":{"url":{"type":"string","format":"uri","minLength":1,"description":"URL of the video to output. Must be a valid URL to an mp4 file and start with https://."},"loop":{"type":"boolean","default":false,"description":"Whether to loop the video. Defaults to false."}},"required":["url"]},"PaginatedBotList":{"type":"object","required":["results"],"properties":{"next":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cD00ODY%3D\""]},"previous":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/Bot"}}}},"CreateZoomOAuthConnectionRequest":{"type":"object","properties":{"zoom_oauth_app_id":{"type":"string","minLength":1,"description":"The Zoom Oauth App the connection is for"},"authorization_code":{"type":"string","minLength":1,"description":"The authorization code received from Zoom during the OAuth flow"},"redirect_uri":{"type":"string","minLength":1,"description":"The redirect URI used to obtain the authorization code"},"is_local_recording_token_supported":{"type":"boolean","default":true,"description":"Whether the Zoom OAuth Connection supports generating local recording tokens"},"is_onbehalf_token_supported":{"type":"boolean","default":false,"description":"Whether the Zoom OAuth Connection supports generating onbehalf tokens"},"metadata":{"description":"JSON object containing metadata to associate with the Zoom OAuth Connection"}},"required":["authorization_code","redirect_uri"]},"PaginatedCalendarEventList":{"type":"object","required":["results"],"properties":{"next":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cD00ODY%3D\""]},"previous":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CalendarEvent"}}}},"PaginatedCalendarList":{"type":"object","required":["results"],"properties":{"next":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cD00ODY%3D\""]},"previous":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/Calendar"}}}},"PaginatedChatMessageList":{"type":"object","required":["results"],"properties":{"next":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cD00ODY%3D\""]},"previous":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/ChatMessage"}}}},"PaginatedParticipantEventList":{"type":"object","required":["results"],"properties":{"next":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cD00ODY%3D\""]},"previous":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantEvent"}}}},"PaginatedParticipantList":{"type":"object","required":["results"],"properties":{"next":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cD00ODY%3D\""]},"previous":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/Participant"}}}},"PaginatedZoomOAuthConnectionList":{"type":"object","required":["results"],"properties":{"next":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cD00ODY%3D\""]},"previous":{"type":["string","null"],"format":"uri","examples":["http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/ZoomOAuthConnection"}}}},"Participant":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"user_uuid":{"type":["string","null"]},"is_host":{"type":"boolean"}},"required":["id","is_host","name","user_uuid","uuid"]},"ParticipantEvent":{"type":"object","properties":{"id":{"type":"string"},"participant_name":{"type":"string"},"participant_uuid":{"type":"string"},"participant_user_uuid":{"type":["string","null"]},"participant_is_host":{"type":"boolean"},"event_type":{"type":"string","readOnly":true},"event_data":{},"timestamp_ms":{"type":"integer"}},"required":["event_data","event_type","id","participant_name","participant_user_uuid","participant_uuid","participant_is_host","timestamp_ms"]},"PatchedPatchBotRequest":{"type":"object","description":"Mixin class providing validation for common attributes used in both patching and creating bots.","properties":{"join_at":{"type":"string","format":"date-time","description":"The time the bot should join the meeting. ISO 8601 format, e.g. 2025-06-13T12:00:00Z"},"meeting_url":{"type":"string","minLength":1,"description":"The URL of the meeting to join, e.g. https://zoom.us/j/123?pwd=456"},"metadata":{"type":"object","description":"JSON object containing metadata to associate with the bot"},"bot_name":{"type":"string","minLength":1,"description":"The name of the bot, e.g. 'My Bot'"},"bot_image":{"allOf":[{"$ref":"#/components/schemas/BotImageRequest"}],"description":"The image for the bot"},"recording_settings":{"type":"object","properties":{"format":{"type":"string","description":"The format of the recording to save. The supported formats are 'mp4', 'mp3' and 'none'. Defaults to 'mp4'."},"view":{"type":"string","description":"The view to use for the recording. The supported views are 'speaker_view', 'gallery_view' and 'speaker_view_no_sidebar'."},"resolution":{"type":"string","description":"The resolution to use for the recording. The supported resolutions are '1080p' and '720p'. Defaults to '1080p'.","enum":["1080p","720p"]},"record_chat_messages_when_paused":{"type":"boolean","description":"Whether to record chat messages even when the recording is paused. Defaults to false.","default":false},"record_async_transcription_audio_chunks":{"type":"boolean","description":"Whether to record additional audio data which is needed for creating async (post-meeting) transcriptions. Defaults to false.","default":false},"reserve_additional_storage":{"type":"boolean","description":"Whether to reserve extra space to store the recording. Only needed when the bot will record video for longer than 6 hours. Defaults to false.","default":false}},"additionalProperties":false,"required":[],"description":"The settings for the bot's recording. The settings specified here will completely replace the existing settings."}}},"PatchedPatchBotVoiceAgentSettingsRequest":{"type":"object","properties":{"url":{"type":"string","description":"URL of a website containing a voice agent that gets the user's responses from the microphone. The bot will load this website and stream its video and audio to the meeting. The audio from the meeting will be sent to website via the microphone. See https://docs.attendee.dev/guides/voice-agents for further details. The video will be displayed through the bot's webcam. To display the video through screenshare, use the screenshare_url parameter instead. Set to \"\" to turn off."},"screenshare_url":{"type":"string","description":"Behaves the same as url, but the video will be displayed through screenshare instead of the bot's webcam. Currently, you cannot provide both url and screenshare_url. Set to \"\" to turn off."}}},"PatchedPatchCalendarRequest":{"type":"object","properties":{"client_secret":{"type":"string","minLength":1,"description":"The client secret for the calendar platform authentication"},"refresh_token":{"type":"string","minLength":1,"description":"The refresh token for accessing the calendar platform"},"metadata":{"description":"JSON object containing metadata to associate with the calendar"}}},"PlatformEnum":{"enum":["google","microsoft"],"type":"string","description":"* `google` - Google\n* `microsoft` - Microsoft"},"Recording":{"type":"object","properties":{"url":{"type":"string","readOnly":true},"start_timestamp_ms":{"type":"integer"}},"required":["start_timestamp_ms","url"]},"RecordingStateEnum":{"type":"string","enum":["not_started","in_progress","complete","failed","paused"]},"SpeechRequest":{"type":"object","properties":{"text":{"type":"string","minLength":1},"text_to_speech_settings":{"type":"object","properties":{"google":{"type":"object","properties":{"voice_language_code":{"type":"string","description":"The voice language code (e.g. 'en-US'). See https://cloud.google.com/text-to-speech/docs/voices for a list of available language codes and voices."},"voice_name":{"type":"string","description":"The name of the voice to use (e.g. 'en-US-Casual-K')"}}}},"required":["google"]}},"required":["text","text_to_speech_settings"]},"ToEnum":{"enum":["everyone","specific_user","everyone_but_host"],"type":"string","description":"* `everyone` - everyone\n* `specific_user` - specific_user\n* `everyone_but_host` - everyone_but_host"},"TranscriptUtterance":{"type":"object","properties":{"speaker_name":{"type":"string"},"speaker_uuid":{"type":"string"},"speaker_user_uuid":{"type":["string","null"]},"speaker_is_host":{"type":"boolean"},"timestamp_ms":{"type":"integer"},"duration_ms":{"type":"integer"},"transcription":{}},"required":["duration_ms","speaker_name","speaker_user_uuid","speaker_uuid","speaker_is_host","timestamp_ms","transcription"]},"TranscriptionStateEnum":{"type":"string","enum":["not_started","in_progress","complete","failed"]},"TypeEnum":{"enum":["image/png"],"type":"string","description":"* `image/png` - image/png"},"ZoomOAuthConnection":{"type":"object","properties":{"id":{"type":"string"},"zoom_oauth_app_id":{"type":"string"},"user_id":{"type":"string","readOnly":true},"account_id":{"type":"string","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/StateFeeEnum"}],"readOnly":true},"metadata":{"type":"object","description":"Metadata associated with the zoom oauth connection","readOnly":true},"is_local_recording_token_supported":{"type":"boolean"},"is_onbehalf_token_supported":{"type":"boolean"},"connection_failure_data":{"readOnly":true,"nullable":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true},"last_successful_sync_at":{"type":["string","null"],"format":"date-time","readOnly":true},"last_attempted_sync_at":{"type":["string","null"],"format":"date-time","readOnly":true}},"required":["account_id","connection_failure_data","created_at","id","is_local_recording_token_supported","is_onbehalf_token_supported","last_attempted_sync_at","last_successful_sync_at","metadata","state","updated_at","user_id","zoom_oauth_app_id"]}}},"servers":[{"url":"https://app.attendee.dev","description":"Production server"}],"tags":[{"name":"Bots","description":"Bot management endpoints"}],"x-ext-urls":{}}}}