Kagura AI Admin Memory Health API

openapi: 3.2.0
info:
  title: Kagura Memory Cloud Admin Memory Health API
  description: Universal AI Memory Platform - Remote MCP Server + Web Management
  version: 0.158.1
tags:
- name: admin-memory-health
  description: 'Admin: deprecated alias of GET /api/v1/memory-health, removed in a later release'
paths:
  /api/v1/admin/memory-health:
    get:
      tags:
      - admin-memory-health
      summary: Per-context memory-health report (deprecated alias)
      description: 'Deprecated: use GET /api/v1/memory-health, which answers any signed-in user with the same document. This system-admin alias is removed in a later release.'
      operationId: get_memory_health_api_v1_admin_memory_health_get
      deprecated: true
      parameters:
      - name: context_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - const: unattributed
            type: string
          - type: 'null'
          description: Omit for the per-context breakdown. Pass a context UUID for that context's 3-section detail (must be created by the caller — otherwise 404), or the sentinel 'unattributed' for signals recorded without a context.
          title: Context Id
        description: Omit for the per-context breakdown. Pass a context UUID for that context's 3-section detail (must be created by the caller — otherwise 404), or the sentinel 'unattributed' for signals recorded without a context.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/MemoryHealthBreakdownResponse'
                - $ref: '#/components/schemas/MemoryHealthDetailResponse'
                title: Response Get Memory Health Api V1 Admin Memory Health Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    MemoryHealthBreakdownResponse:
      properties:
        generated_at:
          type: string
          title: Generated At
        overall_status:
          type: string
          enum:
          - ok
          - warn
          - fail
          title: Overall Status
        contexts:
          items:
            $ref: '#/components/schemas/MemoryHealthContextEntry'
          type: array
          title: Contexts
      type: object
      required:
      - generated_at
      - overall_status
      - contexts
      title: MemoryHealthBreakdownResponse
      description: 200 response for GET /memory-health (no context_id).
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    MemoryHealthContextEntry:
      properties:
        context_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Context Id
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        overall_status:
          type: string
          enum:
          - ok
          - warn
          - fail
          title: Overall Status
        sections:
          additionalProperties:
            type: string
            enum:
            - ok
            - warn
            - fail
          type: object
          title: Sections
      type: object
      required:
      - context_id
      - name
      - overall_status
      - sections
      title: MemoryHealthContextEntry
      description: "One breakdown row: a single context's graded statuses.\n\nAttributes:\n    context_id: The context UUID, or null for the unattributed bucket\n        (signals recorded without a context).\n    name: Context display name; null for the unattributed bucket.\n    overall_status: Worst section status for this context.\n    sections: Per-section status only — metrics live in the detail view."
    MemoryHealthSection:
      properties:
        status:
          type: string
          enum:
          - ok
          - warn
          - fail
          title: Status
        metrics:
          additionalProperties: true
          type: object
          title: Metrics
        notes:
          items:
            $ref: '#/components/schemas/MemoryHealthNote'
          type: array
          title: Notes
      type: object
      required:
      - status
      - metrics
      - notes
      title: MemoryHealthSection
      description: "One graded health section.\n\nAttributes:\n    status: ok | warn | fail (fail only on deterministic facts).\n    metrics: Label-free numeric signals backing the grade.\n    notes: Structured explanations for every non-ok contribution, plus\n        informational notes on ok sections (e.g. an idle store)."
    MemoryHealthNote:
      properties:
        code:
          type: string
          title: Code
        params:
          additionalProperties: true
          type: object
          title: Params
      type: object
      required:
      - code
      title: MemoryHealthNote
      description: "One structured section note (#1225).\n\nAttributes:\n    code: Stable note code the frontend maps to a localized string\n        (the code → rationale mapping lives in\n        docs/ops/memory-health-report.md).\n    params: Interpolation values for the localized message."
    MemoryHealthDetailResponse:
      properties:
        generated_at:
          type: string
          title: Generated At
        context_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Context Id
        context_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Context Name
        overall_status:
          type: string
          enum:
          - ok
          - warn
          - fail
          title: Overall Status
        sections:
          additionalProperties:
            $ref: '#/components/schemas/MemoryHealthSection'
          type: object
          title: Sections
      type: object
      required:
      - generated_at
      - context_id
      - context_name
      - overall_status
      - sections
      title: MemoryHealthDetailResponse
      description: 200 response for GET /memory-health?context_id=...