soev for developers
soev-server

Overview

Serve soev-agents plugins from a basic server that an API key protects, with document collections.

soev-server is a FastAPI app that serves the threads API of soev-agents. Each request sends a bearer API key. The header X-Soev-Subject names the subject of the request, and key-holder is the subject without it. The server keeps the threads and collections of each subject apart, and it lets each subject upload documents to its own collections. It does not verify the subject: it trusts the holder of the API key to name it, for example a gateway in front of the server. Run it with the command soev-server, or build it in Python with build from your own agents and stores.

The server calls its models through soev-inference. Each chat endpoint of the inference config root needs a context_window fact. The soev-inference README describes a config root.

Install

soev-server needs Python 3.12 or later. It has no extras.

pip install soev-server

Where to start

  • Commands: run the server, and the environment variables that it reads.
  • Reference of soev_server: create builds the server from the environment, build builds it from your own parts, and Settings holds its configuration.

On this page