Search
Operations of the Search API. Paths are relative to your deployment's API host.
GET /api/search-api/search
Search documents across the project
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
docTypes | query | array of string | no | Filter by document types |
expandQuery | query | boolean | no | Expand query with LLM-generated related terms |
facets | query | boolean | no | Include faceted aggregations (docType, tags, phase, date) |
fuzziness | query | string | no | Fuzziness level |
limit | query | number | no | Number of results |
offset | query | number | no | Offset for pagination |
phase | query | string | no | Filter by phase |
query | query | string | yes | Search query string |
searchMode | query | one of "text", "semantic", "hybrid" | no | Search mode: text (BM25), semantic (kNN), or hybrid (BM25+kNN with RRF) |
tags | query | array of string | no | Filter by tags |
x-caller-service | header | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json SearchResultDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/search-api/search/facets
Get faceted aggregations without document results
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
nested | query | boolean | no | Include nested sub-aggregations (e.g. phases per docType) |
q | query | string | no | Optional filter query |
| Status | Description | Body |
|---|---|---|
| 200 | application/json FacetResponseDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |