KaiCalls Compliance Settings API

openapi: 3.2.0
info:
  title: KaiCalls Public Compliance Settings 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: Compliance Settings
paths:
  /v1/compliance-settings:
    get:
      summary: The recording notice and AI notice callers hear before the greeting, and when…
      parameters:
      - name: business_id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: settings plus is_default
      x-required-scopes: agents:read
      tags:
      - Compliance Settings
      operationId: getV1ComplianceSettings
      x-operation-id-source: derived
    patch:
      summary: Change the recording or AI notice wording, or when each plays (agents:write +…
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - business_id
              properties:
                business_id:
                  type: string
                recording_disclosure_message:
                  type: string
                  maxLength: 300
                recording_disclosure_mode:
                  type: string
                  enum:
                  - always
                  - state_gated
                  - never
                ai_disclosure_message:
                  type: string
                  maxLength: 300
                ai_disclosure_mode:
                  type: string
                  enum:
                  - always
                  - state_gated
                  - never
                ai_disclosure_enabled:
                  type: boolean
                record_calls_by_default:
                  type: boolean
      responses:
        '200':
          description: ok with the saved settings and the previous ones
      x-required-scopes: agents:write
      tags:
      - Compliance Settings
      operationId: patchV1ComplianceSettings
      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.