Skip to navigation

Search a collection

Needs the knowledge:read scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

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

Path parameters

cidstringRequired
The collection id.

Query parameters

qstringRequired
The question or words to look for.

Response

OK
idstring
A UUID.
textstring
scoredouble

Cosine similarity, 0–1.

relevancedoubleOptional

The fused rank score the hits are ordered by; higher is better.

matchedlist of enumsOptional
Allowed values:
sourceobjectOptional
The document the passage came from.

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error