KaiCalls Meetings API

openapi: 3.2.0
info:
  title: KaiCalls Public Meetings API
  version: '2026-06-05'
  description: Machine-readable surface for KaiCalls external developers and client agents.
servers:
- url: https://www.kaicalls.com/api
security:
- bearerAuth: []
tags:
- name: Meetings
paths:
  /v1/meetings:
    get:
      summary: Meetings the business's agent was sent into (newest first), or one by id with…
      parameters:
      - name: business_id
        in: query
        required: true
        schema:
          type: string
      - name: id
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Meetings and allowance
      x-required-scopes: agents:read
      tags:
      - Meetings
      operationId: getV1Meetings
      x-operation-id-source: derived
    post:
      summary: Send the business's agent into a Zoom, Google Meet, Microsoft Teams or Webex…
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - business_id
              - meeting_url
              properties:
                business_id:
                  type: string
                meeting_url:
                  type: string
                  format: uri
                agent_id:
                  type: string
                bot_name:
                  type: string
                  description: Speakable roster name override.
                camera_image_url:
                  type: string
                  format: uri
                  description: Public https .jpg shown as the camera tile.
                instructions:
                  type: string
                  maxLength: 2000
                  description: Context for this meeting only.
                mode:
                  type: string
                  enum:
                  - listen
                  - avatar
                  default: listen
                  description: '''listen'': still camera tile, answers out loud when addressed. ''avatar'': talking video face from a hosted assistant; counts as one avatar meeting (one lifetime free per business, then plan or purchased avatar meetings); 30 minutes on camera, then voice-only, ended at 60 minutes.'
                avatar_id:
                  type: string
                  description: 'Avatar mode: stock face id (400 lists the valid ids).'
      responses:
        '200':
          description: Already joining this meeting (same link)
        '201':
          description: Joining
        '400':
          description: Unsupported link or invalid override
        '402':
          description: No meeting minutes (or, in avatar mode, no avatar meetings) left
        '502':
          description: The meeting provider could not start the session
      x-required-scopes: agents:write
      tags:
      - Meetings
      operationId: postV1Meetings
      x-operation-id-source: derived
    delete:
      summary: Have the agent leave a meeting. Notes taken so far are kept
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - business_id
              - id
              properties:
                business_id:
                  type: string
                id:
                  type: string
      responses:
        '200':
          description: Left the meeting
      x-required-scopes: agents:write
      tags:
      - Meetings
      operationId: deleteV1Meetings
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'KaiCalls API key. Per-operation scope requirements are published on each operation as `x-required-scopes` — a scope string, or a nested `{ allOf: [...] }` / `{ anyOf: [...] }` expression. An operation with no `x-required-scopes` requires a valid key but no particular scope.'
      x-scopes:
      - workspaces:read
      - workspaces:write
      - numbers:read
      - numbers:write
      - agents:read
      - agents:write
      - communication-runs:read
      - communication-runs:write
      - calls:read
      - calls:write
      - sms:read
      - sms:write
      - webhooks:read
      - webhooks:write
      - events:read
      - events:replay
      - lifecycle:write
      - leads:read
      - leads:write
      - emails:read
      - emails:write
      - sdr:read
      - sdr:write
      - evals:read
      - evals:write
      - appointments:read
      - appointments:write
      - knowledge:read
      - knowledge:write
      - products:read
      - products:write
      - integrations:write
      - approvals:write
      - concierge:write
      - billing:read
      - billing:write
      - call_evidence:read
      - call_evidence:write
      - support:write
    sessionAuth:
      type: apiKey
      in: cookie
      name: sb-access-token
      description: Authenticated dashboard session cookie. Used by first-party flows that mint or manage API keys.