Request body
| Field | Type | Required | Description |
|---|---|---|---|
query | string | Yes | What to search for. Max 4,000 characters |
limit | number | No | Most results to return. Default 10, capped at 100 |
group_ids | string[] | No | Search only these source groups |
widget_id | string | No | A saved widget’s id. The request must pass that widget’s Enabled switch and Allowed origins, as a chat with widget_id does |
Response
Abbreviated.chunk and document carry a few more fields than shown.
chunk.contentis the matching passage.chunk.heading_pathis its section breadcrumb.documentis the page it belongs to. One page can appear more than once.- Results come in ranked order, most relevant first.
| Score | Meaning |
|---|---|
rrf_score | Combined rank of semantic and keyword search. Only compare it within one response |
vector_score | Semantic similarity, 0 to 1. Comparable across queries |
text_score | Keyword match strength, 0 to 1 |
rerank_score | Relevance from the reranking model. Higher is more relevant. 0 when no reranker ran |
Good to know
- You can get fewer results than
limit, or none, when nothing is relevant enough. - Restricted documents are never returned.
- For a short “read next” list with one entry per page, use related articles.