API Documentation
Document Ingestion
Retrieval
User Documents
User Auth
Collections
- POSTCreate Collection
- GETGet Collection
- PUTUpdate Collection
- DELDelete Collection
- GETList Collections
- POSTAdd User to Collection
- POSTRemove User from Collection
- GETGet Users in Collection
- GETGet Collections for User
- GETCollections Overview
- POSTAssign Document to Collection
- POSTRemove Document from Collection
- GETGet Document Collections
Admin
Analytics and Observability
Status
Search
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Search query
Vector search settings
Whether to use vector search
Whether to perform a hybrid search (combining vector and keyword search)
Filters to apply to the vector search
Filters to apply to the vector search
Maximum number of results to return
Offset to paginate search results
Collection IDs to search for
The distance measure to use for indexing
Whether to include search score values in the search results
Whether to include element metadata in the search results
Number of ivfflat index lists to query. Higher increases accuracy but decreases speed.
Size of the dynamic candidate list for HNSW index search. Higher increases accuracy but decreases speed.
Settings for hybrid search
Weight to apply to full text search
Weight to apply to semantic search
Maximum number of results to return from full text search
K-value for RRF (Rank Reciprocal Fusion)
Search strategy to use (e.g., 'default', 'query_fusion', 'hyde')
Knowledge graph search settings
Filters to apply to the vector search
Filters to apply to the vector search
Collection IDs to search for
The system prompt for the graphrag map prompt.
The system prompt for the graphrag reduce prompt.
Whether to use KG search
KG search type
KG search level
Configuration for text generation during graph search.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Search query
Vector search settings
Knowledge graph search settings
Response
Was this page helpful?