Workspace

Search pages

Search pages using combined semantic and keyword matching. Results are ranked by relevance and include a snippet showing why each page matched.

Authentication

x-api-keystring

Your Living Brain API key. Create one from the dashboard; keys are scoped to an organization and carry the role of the member they were issued to.

Path parameters

brainIdstringRequired
Brain id

Headers

x-subject-idstringRequired
Identifies the end user the request is made on behalf of. Brains are owned by a subject, so this determines which brains the caller can see.

Request

This endpoint expects an object.
querystringRequired
Search query
topKintegerOptionalDefaults to 5
Max results
minSimilaritydoubleOptionalDefaults to 0.35

Minimum similarity (0-1)

Response

pageIdstring
Page id
slugstring

URL-safe identifier, unique within the brain.

titlestring

Human-readable title.

summarystring
Summary of the matched page.
pageTypeenum
What kind of knowledge this page holds.
statusenum
Lifecycle state. Deprecated and archived items are hidden from listings by default.
similaritydouble

Similarity score (0-1)

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error