SearchResults

A request or response body; the type column links to the schemas it refers to.

SearchResults

FieldTypeRequiredDescription
querystringyes

The query as searched (trimmed).

modestringyes

How the groups were matched.

one of "keyword" | "semantic" | "combined"

noticestring | nullyes

Why the answer is less than the mode promised — the AI matches missing because the embedding provider did not answer — or null.

groupsarray of SearchResultGroupyes

Every entity group in a fixed order, empty ones included — less the groups of any feature the deployment has switched off (`GET /api/feature-flags`).

jsonExample
{
  "query": "welding",
  "mode": "keyword",
  "notice": null,
  "groups": [
    {
      "title": "Learning records",
      "hits": [
        {
          "key": "6f3b34d8-…",
          "name": "Welding safety induction",
          "href": "/records/6f3b34d8-3c5e-4dd9-9f4e-2b52f0d9a1c7",
          "context": "Jordan Lee",
          "badges": []
        }
      ],
      "truncated": true,
      "view_all_href": "/records?q=welding"
    }
  ]
}