API ReferenceCollections

Search Collection

Search within a collection identified by readable ID.

Args: readable_id: The readable ID of the collection to search query: The search query response_type: Type of response (raw results or AI completion) db: The database session current_user: The current user

Returns: dict: Search results or AI completion response

Path parameters

readable_idstringRequired

Headers

x-api-keystringRequired

Query parameters

querystringRequired

Search query

response_typeenumOptional

Type of response: raw search results or AI completion

Allowed values:

Response

Successful Response

resultslist of maps from strings to any
response_typeenum

Response type for search results.

Allowed values:
statusenum

Status for search results.

Allowed values:
completionstringOptional

Errors