Skip to main content
POST
Feature Search

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.

Body

application/json
query
FeatureSearchQuery · object
required

Search query.

collection_identifiers
string[]

Collection IDs or names to search. OPTIONAL: omit (or pass []) on standalone/BYOV namespaces to search the namespace's direct-upsert documents without naming a collection.

feature_uri
string
default:mixpeek://text_extractor@v1/embedding

Feature URI to search against.

top_k
integer
default:25

Number of results to return.

Required range: 1 <= x <= 1000
filters
Filters · object | null

Pre-filters to apply before search.

Response

Successful Response