KaiCalls Agency Care API

openapi: 3.2.0
info:
  title: KaiCalls Public Agency Care 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: Agency Care
paths:
  /v1/agency-care:
    post:
      summary: Manage agency care using a strict reviewed command
      description: IDs are in the body. Runtime refinements, current role, assignment and exact approval/hash/lease guards apply. Enrollment creation and commit require a stable Idempotency-Key. Installation run_scenarios also requires evals:write. Care requires sms:write and exact owner approval; preparation creates a draft, launch explicitly queues it. Provider-unknown outcomes require reconciliation. Configuration, testing, activation, billing and measured outcomes are distinct.
      parameters:
      - in: header
        name: Idempotency-Key
        schema:
          type: string
          maxLength: 150
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  enum:
                  - preview_review
                  - prepare_review
                  - launch_review
                partnerId:
                  type: string
                  format: uuid
                installationId:
                  type: string
                  format: uuid
                expectedRevision:
                  type: string
                  pattern: ^[a-f0-9]{64}$
                fromNumber:
                  type: string
                  pattern: ^\+[1-9][0-9]{7,14}$
                milestones:
                  type: array
                  items:
                    type: object
                    properties:
                      leadId:
                        type: string
                        format: uuid
                      completedAt:
                        type: string
                        format: date-time
                      evidenceRef:
                        type: string
                        minLength: 1
                        maxLength: 200
                    required:
                    - leadId
                    - completedAt
                    - evidenceRef
                    additionalProperties: false
                  minItems: 1
                  maxItems: 50
                minimumDays:
                  type: integer
                  minimum: 7
                  maximum: 365
                fingerprint:
                  type: string
                  pattern: ^[a-f0-9]{64}$
                campaignId:
                  type: string
                  format: uuid
                accepted:
                  const: true
                  type: boolean
              required:
              - action
              - partnerId
              - installationId
              - expectedRevision
              - fromNumber
              - milestones
              - minimumDays
              additionalProperties: false
      responses:
        '200':
          description: Recorded command receipt; read back current evidence.
        '202':
          description: Enrollment per-client receipt; inspect waiting and conflict states.
        '400':
          description: Invalid command.
        '403':
          description: Authority or approved owner revision required.
        '409':
          description: State changed or provider reconciliation required.
        '503':
          description: Dependency unavailable; durable operation retained.
      x-required-scopes:
        allOf:
        - workspaces:write
        - sms:write
      tags:
      - Agency Care
      operationId: postV1AgencyCare
      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.