Documentation Search

Public endpoints for searching Qarion's user guides and developer API references, plus an admin endpoint to trigger documentation reindexing.

Base Path

/docs

Authentication

Search is public (no authentication required). Reindexing requires admin access.

---

Endpoints

Search Documentation

GET /docs/search

Search across user guides and developer API references using keyword, semantic, or hybrid search.

Query Parameters

Parameter	Type	Default	Description
q	string	—	Search query (min 2 characters, required)
source	string	all	Filter by source: all, user, developer
mode	string	auto	Search strategy: auto, keyword, semantic
limit	int	10	Max results (1–50)

Search Modes

Mode	Description
auto	(default) Combines keyword and semantic results when embeddings are available
keyword	BM25 full-text search via Elasticsearch
semantic	Vector-similarity search using AI embeddings

Response 200 OK

[
  {
    "id": "doc-chunk-123",
    "title": "Data Contracts Overview",
    "section": "Contract Definition",
    "content": "Formal agreements between data producers and consumers...",
    "source": "user",
    "path": "/docs/contracts/overview",
    "category": "contracts"
  }
]

---

Reindex Documentation

POST /docs/reindex

Trigger a full reindex of all documentation into Elasticsearch. Scans markdown files from user and developer documentation sites, generates embeddings, and re-indexes them.

Response 200 OK

{
  "indexed": 342,
  "failed": 0,
  "message": "Indexed 342 documentation chunks (0 failed)"
}

Related

• Search — Platform-wide entity search
• Global Search User Guide — End-user search documentation