KaiCalls Owner Line Instructions API

openapi: 3.2.0
info:
  title: KaiCalls Public Owner Line Instructions 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: Owner Line Instructions
paths:
  /v1/owner-line-instructions:
    get:
      summary: 'Read the stored wording layers for a business''s owner line (agents:read): the…'
      parameters:
      - name: business_id
        in: query
        required: true
        schema:
          type: string
      - name: history
        in: query
        required: false
        schema:
          type: string
          enum:
          - '1'
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Active global + business layers, with optional history
      x-required-scopes: agents:read
      tags:
      - Owner Line Instructions
      operationId: getV1OwnerLineInstructions
      x-operation-id-source: derived
    patch:
      summary: Change what the owner line says without a code release (agents:write +…
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - scope
              - instructions
              - reason
              properties:
                scope:
                  type: string
                  enum:
                  - global
                  - business
                business_id:
                  type: string
                  description: Required for scope=business
                instructions:
                  type: string
                  description: 'Plain-language rules appended to the owner line prompt. Max 4000 chars (business) / 8000 (global). Wording only: phone numbers, emails and links are rejected, and so is any attempt to set callback windows, retries, consent, quiet hours or do-not-call (those are settings).'
                reason:
                  type: string
                  description: What was observed and why this wording changes it
                expected_version:
                  type: integer
                  nullable: true
                  description: The version last read (null = no active version). A mismatch returns 409 version_conflict instead of overwriting. Resending identical text is a no-op (created=false), so retries are safe.
      responses:
        '200':
          description: The new active version (created=false when the text was unchanged)
        '409':
          description: expected_version did not match the active version
      x-required-scopes: agents:write
      tags:
      - Owner Line Instructions
      operationId: patchV1OwnerLineInstructions
      x-operation-id-source: derived
  /v1/owner-line-instructions/preview:
    post:
      summary: Preview what the owner line will read before saving (agents:read, nothing…
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                scope:
                  type: string
                  enum:
                  - global
                  - business
                business_id:
                  type: string
                instructions:
                  type: string
      responses:
        '200':
          description: Validation result and the rendered block
      x-required-scopes: agents:read
      tags:
      - Owner Line Instructions
      operationId: postV1OwnerLineInstructionsPreview
      x-operation-id-source: derived
  /v1/owner-line-instructions/rollback:
    post:
      summary: Undo an owner line wording change in one call (same authorization as PATCH).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - scope
              - reason
              properties:
                scope:
                  type: string
                  enum:
                  - global
                  - business
                business_id:
                  type: string
                to_version:
                  type: integer
                reason:
                  type: string
      responses:
        '200':
          description: The restored version
      x-required-scopes: agents:write
      tags:
      - Owner Line Instructions
      operationId: postV1OwnerLineInstructionsRollback
      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.