Skip to main content

1. Install and Run

The API starts on http://127.0.0.1:8000. Open http://127.0.0.1:8000/docs for Swagger UI. REST defaults live in request payloads. These examples pass the vector database, embedding model, and LLM model explicitly.

2. Ingest

POST /v1/pipelines/ingest extracts, chunks, embeds, and stores content.

3. Query

POST /v1/pipelines/query embeds the question and retrieves matching chunks.

4. Chat

POST /v1/chat retrieves context and asks the configured LLM for an answer.
Pass the returned history array back on the next chat request to keep conversation context.

5. Stream Chat

Next, use REST Ingest for full ingest options, REST Query for retrieval options, or Pipeline Overview to run each stage separately.