Skip to main content
Rate limit tier: general, 600 requests/min. See Rate limits. Ranks a workflow’s knowledge corpus by relevance (BM25) to query — for a topic-style question such as “where is termination discussed”, not an exact string, a count, or a sum. For an answer with citations, use Ask; for the full tree, use List. Each hit carries a relevance rank (higher first) and a snippet: a window of text around the best-matching term, wrapped in «». Ranking is relevance, not match count — a document matching the query term fewer times can still outrank one matching it more, and a document matching no query term as a whole word is not returned.

Requires a knowledge base

Same requirement as ask: the workflow needs a knowledge node, or this returns 409 KNOWLEDGE_NOT_ENABLED. 409 KNOWLEDGE_NOT_READY means no usable snapshot has ever been published. Unlike ask, search is never billed, so 402 cannot occur here.

Folder

folder narrows ranking to one top-level source folder — the first path segment (e.g. contracts), not a nested path. Omitting it merges every folder’s statistics into one corpus-wide ranking. An unrecognized folder name is a 404.

Query length

query is 1 to 512 characters.

Limit

limit caps the number of hits, 1 to 50, default 10.

Errors