Skip to navigation

Semantic search over a space's indexed files

View as Markdown

Runs semantic search over every indexed file in the space :spaceId. Authorization: the caller needs space:read on the space; organization administrators bypass this check. Lacking access returns 404 (existence is hidden), never 403. Query params: q (required) is the natural-language query text; callers never send vectors. An empty or whitespace-only q returns 400. limit (optional, default 20) is a positive integer, capped at 100; larger values are clamped to 100, and a non-integer or < 1 returns 400. The search is always scoped to the space in the path. Returns { matches }, an array ranked by relevance; each match has id, namespace, tags[], score (higher = closer), and a metadata object carrying file grounding (file id, page, bbox, and/or audio timecode) when the source was indexed with it. There is no cursor pagination — bound the result count with limit.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired

Query parameters

qstringRequired>=1 character

Natural-language query text. Empty or whitespace-only returns 400. Callers never send vectors.

limitintegerOptional1-100Defaults to 20

Maximum matches, clamped to 100. A non-integer or value below 1 returns 400.

Response

Ranked semantic matches within the space.
matcheslist of objects
Ranked by relevance. No cursor.