Kagura AI System API

openapi: 3.2.0
info:
  title: Kagura Memory Cloud System API
  description: Universal AI Memory Platform - Remote MCP Server + Web Management
  version: 0.158.1
tags:
- name: System
  description: System health and info
paths:
  /api/v1/system/health:
    get:
      tags:
      - System
      summary: Health Check
      description: 'Health check endpoint.


        Returns:

        Status OK


        Example:

        GET /api/v1/health

        -> {"status": "ok"}'
      operationId: health_check_api_v1_system_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/v1/system/info:
    get:
      tags:
      - System
      summary: System Info
      description: 'System information endpoint.


        Returns:

        System info with version, environment, features


        Example:

        GET /api/v1/system/info

        -> {

        "name": "Kagura Memory Cloud",

        "version": "0.1.0",

        "environment": "development",

        "features": {...}

        }'
      operationId: system_info_api_v1_system_info_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/v1/system/telemetry:
    get:
      tags:
      - System
      summary: Get System Telemetry
      description: 'Get system telemetry and health status.


        Checks connectivity and status of all backend services.


        Args:

        user: Authenticated user

        db: Database session


        Returns:

        System telemetry including service status, memory stats, and uptime'
      operationId: get_system_telemetry_api_v1_system_telemetry_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TelemetryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/system/overview:
    get:
      tags:
      - System
      summary: Get System Overview
      description: 'Get comprehensive system overview.


        Returns database, vector DB, cache, graph, and neural memory status.

        Issue #45 - Replace mock API with real implementation.


        Returns:

        Comprehensive system overview including all backends'
      operationId: get_system_overview_api_v1_system_overview_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/v1/system/embedding/models:
    get:
      tags:
      - System
      summary: List Embedding Models
      description: 'List available embedding models with availability status.


        Returns all models from EMBEDDING_MODEL_REGISTRY with availability

        based on whether the provider is configured and reachable.


        Returns:

        List of models with name, dimensions, provider, and availability'
      operationId: list_embedding_models_api_v1_system_embedding_models_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingModelsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /:
    get:
      tags:
      - System
      summary: Root
      description: Root endpoint.
      operationId: root__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /health:
    get:
      tags:
      - System
      summary: Health
      description: Health check endpoint (liveness probe — always fast).
      operationId: health_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /readiness:
    get:
      tags:
      - System
      summary: Readiness
      description: 'Readiness probe for blue-green deploy.


        Checks PostgreSQL, Qdrant, and Redis connectivity with tight timeouts.

        Returns 200 only when all backends are reachable.

        Returns 503 if any backend is unavailable.


        Note: Uses _get_session_factory() directly (not Depends(get_db)) because

        this is a standalone probe, not a typical route handler.'
      operationId: readiness_readiness_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    TelemetryResponse:
      properties:
        services:
          additionalProperties:
            $ref: '#/components/schemas/ServiceStatus'
          type: object
          title: Services
        embedding_config:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Embedding Config
        memory_stats:
          additionalProperties: true
          type: object
          title: Memory Stats
        neural_memory:
          additionalProperties: true
          type: object
          title: Neural Memory
        uptime_seconds:
          type: integer
          title: Uptime Seconds
        version:
          type: string
          title: Version
      type: object
      required:
      - services
      - memory_stats
      - neural_memory
      - uptime_seconds
      - version
      title: TelemetryResponse
      description: System telemetry response.
    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
    ServiceStatus:
      properties:
        status:
          type: string
          title: Status
        version:
          anyOf:
          - type: string
          - type: 'null'
          title: Version
        details:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Details
      type: object
      required:
      - status
      title: ServiceStatus
      description: Individual service status.
    EmbeddingModelsResponse:
      properties:
        models:
          items:
            $ref: '#/components/schemas/EmbeddingModelInfo'
          type: array
          title: Models
        default_model:
          type: string
          title: Default Model
      type: object
      required:
      - models
      - default_model
      title: EmbeddingModelsResponse
      description: Response for available embedding models.
    EmbeddingModelInfo:
      properties:
        name:
          type: string
          title: Name
        dimensions:
          type: integer
          title: Dimensions
        provider:
          type: string
          title: Provider
        available:
          type: boolean
          title: Available
      type: object
      required:
      - name
      - dimensions
      - provider
      - available
      title: EmbeddingModelInfo
      description: Individual embedding model info.