Search

Typeahead page suggestions (typo-tolerant; role: viewer+)

Ranked suggestions for a partial query, combining stemmed full-text matches on page content with trigram (fuzzy) matches on titles and paths, so a typo still finds the page. Content matches carry a snippet whose matched runs are wrapped in the plain-text sentinels ⟪ and ⟫ — never HTML. Limit defaults to 8 and is clamped to 20.

get/api/search/suggest

Request

  • Base URL: https://api.witwiki.app
  • URL: https://api.witwiki.app/api/search/suggest
  • Auth: HTTP bearer

Query parameters

qstring required
limitinteger

Headers

X-Project-IDstring

Active project ID. Required on the JWT-session auth path; ignored when using a project API key.

Response

Ranked suggestions, best match first

Changes

No recorded changes to this operation across all 1 revision of this API.