Skip to main content
GET
Typeahead

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace
string
header
required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Query Parameters

q
string
required

The typed prefix.

Required string length: 1 - 200
fields
string | null

Comma-separated metadata field paths to suggest values from (e.g. metadata.talent,metadata.production). Each field should carry a keyword index; at most 5 are consulted. Omit to skip the field-value source.

limit
integer
default:10

Max suggestions per source.

Required range: 1 <= x <= 50

Response

Successful Response

Prefix suggestions for a search box (UF-15).

Three sources, each scoped to the caller's namespace and organization: metadata-field values (index-backed facet, prefix-filtered), collection names, and the caller's own recent search queries. suggestions is the flat ranked convenience list (recent searches first, then field values by count, then collection names, case-insensitively deduplicated). A source that fails or times out is dropped and named in warnings instead of failing the request.

query
string
required

The prefix that was matched.

suggestions
string[]

Flat ranked suggestion texts across all sources.

values
TypeaheadValueSuggestion · object[]

Field-value suggestions with per-value document counts.

collections
TypeaheadCollectionSuggestion · object[]

Collections whose name matches the prefix.

recent_searches
string[]

The caller's own recent queries matching the prefix, newest first.

warnings
string[]

Sources that could not be consulted this request.