/query/suggestions | gideononline

Returns type-ahead suggestions for an incomplete query, using the same search backend as POST /query. Each item includes display text and an optional category.

Query parameters

Name	Required	Description
`q`	Yes	Prefix or partial term to match.
`limit`	No	Default 10; values above 20 are capped at 20; invalid values fall back to 10.
`cache`	No	`true` or `false`; if omitted, follows the server’s default caching behavior.

Response

{ "data": [ { "text": "...", "category": "..." } ] } — category may be null.

Errors

400 — q is missing or empty.
503 — Search service is not configured.
502 — Search service request failed.

Authentication

Authorizationstring

API Key authentication via header

Query parameters

qstringOptional

Partial search text (required).

limitintegerOptional

Max suggestions (default 10, maximum 20).

cachebooleanOptional

Optional. When true, a cached response may be returned if server caching is enabled.

Response

datalist of objects