Kagura AI Config API

openapi: 3.2.0
info:
  title: Kagura Memory Cloud Config API
  description: Universal AI Memory Platform - Remote MCP Server + Web Management
  version: 0.158.1
tags:
- name: Config
  description: Environment configuration management (admin)
paths:
  /api/v1/config:
    get:
      tags:
      - Config
      summary: Get All Config
      description: 'Get all configuration values.


        Every value is the EFFECTIVE one the running process uses (Issue #1580);

        ``config_overrides`` rows are never consulted — nothing reads them at

        runtime, so showing one would display a value that is not in effect.

        Admin-only categories are omitted for non-admin callers.


        Args:

        user: Authenticated user

        mask_sensitive: Whether to mask sensitive values (URL credentials are

        masked regardless)


        Returns:

        List of configuration values'
      operationId: get_all_config_api_v1_config_get
      parameters:
      - name: mask_sensitive
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Mask Sensitive
      - 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/ConfigListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/config/categories:
    get:
      tags:
      - Config
      summary: Get Categories
      description: 'Get configuration categories.


        Args:

        user: Authenticated user


        Returns:

        Configuration categories'
      operationId: get_categories_api_v1_config_categories_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: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/config/{key}:
    put:
      tags:
      - Config
      summary: Update Config
      description: 'Refuse to update a configuration value (Issue #1580).


        Admin-only endpoint, kept so existing clients get a clear answer. Every key

        is env-backed: it is set via environment variables and applied on

        restart/redeploy, and no runtime consumer reads a stored override.


        Args:

        key: Configuration key the caller tried to update

        request: Rejected value

        admin: Authenticated admin user


        Raises:

        ConfigReadOnlyError: Always (409 ``CFG-002``)'
      operationId: update_config_api_v1_config__key__put
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          title: Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '409':
          description: 'Always: configuration is read-only (`CFG-002`). Values are set via environment variables and applied on restart/redeploy.'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/config/batch:
    post:
      tags:
      - Config
      summary: Batch Update Config
      description: 'Refuse to batch update configuration values (Issue #1580).


        Admin-only endpoint. The whole request is refused — there are no partial

        writes. See ``update_config``.


        Args:

        request: Rejected key-value pairs

        admin: Authenticated admin user


        Raises:

        ConfigReadOnlyError: Always (409 ``CFG-002``)'
      operationId: batch_update_config_api_v1_config_batch_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigBatchRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '409':
          description: 'Always: configuration is read-only (`CFG-002`). Values are set via environment variables and applied on restart/redeploy.'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/config/validate:
    post:
      tags:
      - Config
      summary: Validate Config
      description: 'Validate a configuration value.


        Args:

        request: Key and value to validate

        user: Authenticated user


        Returns:

        Validation result'
      operationId: validate_config_api_v1_config_validate_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigValidateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/config/schema:
    get:
      tags:
      - Config
      summary: Get Schema
      description: 'Get configuration schema with metadata.


        Returns metadata for all configuration keys including:

        - Type (string/number/boolean/enum)

        - Valid values for ENUM types

        - Min/max ranges for numeric types

        - Descriptions, impacts, examples, recommendations

        - Restart requirements


        Issue #53 - Enable frontend display improvements (read-only)


        Returns:

        Dictionary of configuration key schemas'
      operationId: get_schema_api_v1_config_schema_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    ConfigUpdateRequest:
      properties:
        value:
          title: Value
      type: object
      required:
      - value
      title: ConfigUpdateRequest
      description: Update configuration value.
    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
    ConfigBatchRequest:
      properties:
        updates:
          additionalProperties: true
          type: object
          title: Updates
      type: object
      required:
      - updates
      title: ConfigBatchRequest
      description: Batch update configuration.
    ConfigListResponse:
      properties:
        configs:
          items:
            $ref: '#/components/schemas/ConfigValue'
          type: array
          title: Configs
        total:
          type: integer
          title: Total
      type: object
      required:
      - configs
      - total
      title: ConfigListResponse
      description: Configuration list response.
    ConfigValidateRequest:
      properties:
        key:
          type: string
          title: Key
        value:
          title: Value
      type: object
      required:
      - key
      - value
      title: ConfigValidateRequest
      description: Validate configuration.
    ConfigValue:
      properties:
        key:
          type: string
          title: Key
        value:
          title: Value
        category:
          type: string
          title: Category
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        is_sensitive:
          type: boolean
          title: Is Sensitive
          default: false
        read_only:
          type: boolean
          title: Read Only
          default: true
      type: object
      required:
      - key
      - value
      - category
      title: ConfigValue
      description: Single configuration value.