Skip to main content
POST
Join External Meeting

Authorizations

x-api-key
string
header
required

Body

application/json
agent_id
string
required

ID of the agent to send into the meeting.

Example:

"agt_12345"

meeting_url
string
required

Full URL of the Google Meet, Zoom, or Teams meeting the agent should join.

Example:

"https://meet.google.com/abc-defg-hij"

user_name
string
required

Display name the agent uses in the meeting.

Example:

"Alex: AI Assistant"

user_id
string
required

Identifier for this session — used in analytics and callbacks.

Example:

"meeting-2026-07-30-abc"

context
string

Free-form conversational context passed to the agent's system prompt.

Example:

"This is a hiring interview. The candidate is Priya Sharma for the Senior Engineer role."

wake_phrase
string

Optional phrase the agent listens for before speaking (useful in silent-observer mode).

mode
string

Session mode.

Response

Agent request accepted

The response is of type string.