v13

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-015232292.9 KB

Knowledge Bases

Search Knowledge Base

Search across one or more knowledge bases. Supports semantic search via query text, tag-based filtering, or a combination of both. Set searchMode to hybrid to additionally run a full-text keyword leg and fuse it with the semantic results.

post/api/v1/knowledge/search

Request body

workspaceIdstring required

The workspace containing the knowledge bases.

querystring

Search query text for semantic similarity search. Either query or tagFilters must be provided.

topKinteger

Maximum number of results to return.

searchMode'vector' | 'hybrid'

Retrieval strategy. vector ranks purely on embedding similarity. hybrid also runs a full-text keyword search and fuses the two rankings by reciprocal rank, which retrieves exact tokens — error codes, ticket keys, identifiers, rare product names — that embeddings alone rank poorly. Ignored when only tagFilters are provided.

Response

Search results.

successboolean

Whether the request was successful.