API ReferenceCollections

Search Collection (Legacy)

Deprecated
**DEPRECATED**: Use POST /collections/{readable_id}/search instead. This legacy GET endpoint provides basic search functionality via query parameters. Migrate to the POST endpoint for access to advanced features like: - Structured filters - Query expansion - Reranking - Streaming responses

Authentication

x-api-keystring
API Key authentication via header

Path parameters

readable_idstringRequired
The unique readable identifier of the collection to search

Query parameters

querystringRequired
The search query text to find relevant documents and data
response_typeenumOptional

Format of the response: ‘raw’ returns search results, ‘completion’ returns AI-generated answers

Allowed values:
limitintegerOptional1-1000Defaults to 100
Maximum number of results to return
offsetintegerOptional>=0Defaults to 0
Number of results to skip for pagination
recency_biasdouble or nullOptional0-1

How much to weigh recency vs similarity (0=similarity only, 1=recency only)

Response

Search results
resultslist of maps from strings to any
Array of search result objects
response_typeenum

Indicates whether results are raw search matches or AI-generated completions

Allowed values:
statusenum
Status of the search operation
Allowed values:
completionstring or null

AI-generated natural language answer when response_type is ‘completion’

Errors