openapi: 3.1.0
info:
  title: KAITO RAGEngine REST Chat Retrieval 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: Retrieval
  description: Retrieve relevant nodes from a RAG index.
paths:
  /retrieve:
    post:
      operationId: retrieve
      summary: Retrieve nodes from a RAG index
      description: Retrieve the top relevant nodes from a RAG index for a given query.
      tags:
      - Retrieval
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                index_name:
                  type: string
                query:
                  type: string
                max_node_count:
                  type: integer
                metadata_filter:
                  type: object
              required:
              - index_name
              - query
      responses:
        '200':
          description: Retrieved nodes.
          content:
            application/json:
              schema:
                type: object