Sign in
latestOpenAPI 3.1.02026-08-206635377.2 KB

dae97e8eb063

Meetings

Create meeting invite

Invite a persona to join a Google Meet, Zoom, or Microsoft Teams meeting.

Provide exactly one of personaId for a saved persona, or personaConfig for a runtime persona configuration. The runtime persona configuration is used to start the meeting session but is not stored on the meeting invite.

The invite is created in pending status. displayName is normalized to include an AI disclosure suffix before the persona joins the meeting.

By default the persona joins immediately. Provide joinAt to schedule the join for a future time; scheduling at least 10 minutes ahead reserves the persona a guaranteed place on the call, which is the most reliable way to join meetings that are planned in advance.

post/v1/meetings/invites

Request body

CreateMeetingInviteRequest required— unresolved $ref

Response

Successfully created meeting invite

idstring uuid required

Unique identifier for the meeting invite.

provider'google_meet' | 'zoom' | 'microsoft_teams' required

Meeting provider inferred from the meeting URL.

meetingUrlstring uri required

Normalized meeting URL.

displayNamestring required

Display name used in the meeting.

status'pending' | 'active' | 'cancelled' | 'ended' | 'failed' required

Current invite status.

createdAtstring date-time required

Time the invite was created.

joinAtstring date-time nullable required

Scheduled time the persona joins the meeting, or null when the persona was asked to join immediately.

groupCallboolean required

Whether group-call turn-taking is enabled for this invite (respond only when addressed by name; silent join).

sessionIdstring nullable required

Engine session ID once the meeting session has started, otherwise null.

region'eu' | 'us-east' | 'us-west' | 'null' nullable required

Region the persona joined the call from. May differ from the requested region when the invite was served by another region for availability. Additional region values may be introduced over time; treat unrecognized values as informational rather than an error.

joinState'joining' | 'waiting_room' | 'in_call' | 'media_denied' | 'media_granted' | 'media_active' | 'left' | 'done' | 'error' | 'null' nullable required

Latest observed call-participation detail for the persona, updated asynchronously as the persona connects, waits for admission, joins, and leaves. Null until the first update arrives. Values may be added over time; treat unrecognized values as informational.

statusReasonstring nullable required

Reason attached to a terminal participation state — for example removed_by_host, meeting_ended, not_admitted, join_denied, meeting_link_invalid, meeting_not_started, idle_timeout, left_call, or provider_error. Null while the invite is in progress. Values may be added over time; treat unrecognized values as informational.