API ReferenceCollections

Search

Search across all data sources within the specified collection.

This GET endpoint provides basic search functionality. For advanced filtering and options, use the POST /search endpoint.

Path parameters

readable_idstringRequired
The unique readable identifier of the collection to search

Headers

x-api-keystringRequired

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:
limitintegerOptional>=1<=1000Defaults to 20
Maximum number of results to return
offsetintegerOptional>=0Defaults to 0
Number of results to skip for pagination
recency_biasdouble or nullOptional>=0<=1

How much to weigh recency vs similarity (0..1). 0 = no recency effect; 1 = rank by recency only.

Response

Successful Response
resultslist of maps from strings to any
Array of search result objects containing the found documents, records, or data entities.
response_typeenum

Indicates whether results are raw search matches or AI-generated completions based on the found content.

Allowed values:
statusenum

Status of the search operation indicating the quality and availability of results:
• success: Search found relevant results matching your query
• no_relevant_results: Search completed but found no sufficiently relevant matches
• no_results: Search found no results at all, possibly indicating empty collections or very specific queries

Allowed values:
completionstring or null

AI-generated natural language answer when response_type is ‘completion’. This provides natural language answers to your query based on the content found across your connected data sources.

Errors