Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-201,3412,1385.0 MB

3fdc16374d70

Meeting Sessions

Create a meeting session

Creates a new meeting session. When an idempotency_key is supplied in the request body, replay lookup is scoped to the authenticated account and compares only the key; the request payload is not fingerprinted or compared. If a session with that key already exists for the account, the existing session is replayed (200); otherwise a new session is created (201). Supports bring-your-own-key (BYOK) configuration. The session may enter asynchronous states (e.g. joining, waiting_for_admission) before becoming active. Optional camera_image input is write-only and applies only when no Avatar or Assistant webpage output takes precedence. An ignored URL is not fetched. An effective URL source is resolved before bot creation; neither the source URL nor image bytes are persisted, returned, or logged. Treat signed URLs as credentials.

post/meeting_sessions

Request body

barge_inboolean

When enabled, a human participant speech_on event interrupts and stops the current bot audio; it does not bypass admission or initiate speech. Assistant sessions reject barge_in: true.

bot_namestring

Display name for the bot in the meeting. Defaults to "Meeting Bot".

idempotency_keystring

Client-supplied idempotency key to safely retry creation requests without duplicating sessions. Lookup is scoped to the authenticated account and compares the key only; the request payload is not fingerprinted or compared.

join_atstring date-time

ISO-8601 timestamp in the future at which the bot should join. If omitted, the bot joins immediately.

meeting_urlstring uri required

The meeting URL the bot should join.

metadataobject

Arbitrary key-value metadata attached to the session. The serialized JSON representation must not exceed 16384 characters at runtime.

speak_on_enterstring

Text the bot speaks when it enters the meeting.

summarize_on_endboolean

If true, generate a summary artifact when the session ends.

voicestring

Session-default voice identifier used for speak_on_enter and ordinary speak actions. A voice supplied on an individual speak action overrides this default for that utterance.

webhook_urlstring uri

HTTPS endpoint to receive session lifecycle callbacks. Static validation requires HTTPS, rejects embedded credentials and blocked hosts, and enforces egress policy. Validation makes no network request to the endpoint.

Example request

{
  "bot_name": "Notetaker",
  "meeting_url": "https://zoom.us/j/1234567890"
}

Response

Replayed existing meeting session matching the account-scoped idempotency_key. Replay is key-only; the request payload is not fingerprinted or compared.