Send Kai Into a Meeting
join_meetingSend Kai into a Zoom, Google Meet, Microsoft Teams or Webex meeting by its link. Kai joins under the agent name, takes notes, and emails the owner a summary when the meeting ends. If the meeting has a waiting room, the host must admit Kai. In the default listen mode it answers out loud when someone says its name and counts against the plan's monthly meeting minutes (a business whose plan includes none gets its first hour free, once); avatar mode joins with a talking video face and counts one avatar meeting. Mirrors POST /api/v1/meetings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | 'listen' (default): joins with a still camera tile and answers out loud when someone says its name. 'avatar': joins with a talking video face; counts as one avatar meeting (separate from meeting minutes; every business gets one free), stays on camera for the first 30 minutes, then continues voice-only and leaves at 60 minutes. | |
| agent_id | No | Which agent joins (optional; defaults to the business's first agent). | |
| bot_name | No | Name shown in the meeting and the name people say to get a reply (optional; defaults to the agent's name). Must be a short, speakable name. | |
| avatar_id | No | Avatar mode only: which stock face to use (optional; an unknown id returns the list of valid ones). | |
| business_id | No | Business ID (required when the token can access several businesses). | |
| meeting_url | Yes | The meeting link, e.g. https://meet.google.com/abc-defg-hij or a zoom.us join link. | |
| instructions | No | Context for this meeting only, e.g. "This is an onboarding call for a new customer; walk them through setup" (optional, up to 2000 characters). | |
| camera_image_url | No | Public https link to a .jpg shown as the camera tile (optional). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present when success is false | |
| meeting | No | ||
| success | Yes | Whether the tool completed successfully |