openapi: 3.1.0
info:
  title: KAITO RAGEngine REST Chat Persistence API
  description: REST API for the KAITO RAGEngine, used to manage indexes, ingest and retrieve documents, persist or reload indexes from storage, and run OpenAI-compatible chat completions grounded in indexed content. The API is exposed by a self-hosted RAGEngine service running in a Kubernetes cluster.
  version: 1.0.0
  contact:
    name: KAITO Project
    url: https://kaito-project.github.io/kaito/
  license:
    name: MIT
    url: https://github.com/kaito-project/kaito/blob/main/LICENSE
servers:
- url: http://localhost:8080
  description: Self-hosted KAITO RAGEngine endpoint (replace with the in-cluster service URL).
tags:
- name: Persistence
  description: Persist indexes to storage or reload them.
paths:
  /persist/{index_name}:
    post:
      operationId: persistIndex
      summary: Persist an index to storage
      description: Persist the named index to storage at an optional path.
      tags:
      - Persistence
      parameters:
      - name: index_name
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                path:
                  type: string
      responses:
        '200':
          description: Index persisted.
  /load/{index_name}:
    post:
      operationId: loadIndex
      summary: Load an index from storage
      description: Load a persisted index back into the RAGEngine.
      tags:
      - Persistence
      parameters:
      - name: index_name
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                path:
                  type: string
                overwrite:
                  type: boolean
      responses:
        '200':
          description: Index loaded.