v1

latestOpenAPI 3.0.02026-07-26870415.2 KB
kb

Search knowledge base

Hybrid search over the workspace knowledge base. Returns the top matching chunks with their parent node titles and relevance scores.

post/v1/kb/search

Query parameters

workspace_idstring required

Workspace to query.

Example:j57demo8f8x7c9v0n2q4r6t8y1u3i5o

Request body

querystring required

Natural-language search query.

entity_idsstring[]

Restrict results to nodes scoped to any of these entities.

max_resultsinteger

Maximum number of results to return.

Example request

{
  "query": "what time is checkout",
  "max_results": 10
}

Response

Knowledge search results