API Documentation Index
Use this page as the API documentation entry point. The canonical endpoint-to-handler map is Complete API Reference, which is maintained against src/api/httproutes.cpp.
Main References
| Page | Use it for |
|---|---|
| API Overview | Request conventions, auth, route families, and common errors. |
| Complete API Reference | Full public route table with route actions and handlers. |
| Route Handlers | Implementation ownership and dispatch flow. |
| System Endpoints | Health, readiness, metrics, storage, maintenance, links, and runtime metadata. |
| Collections API | Collection lifecycle and schemas. |
| Documents API | Document CRUD, import, context, and by-query writes. |
| Search API | Lexical search, global search, SQL, multi-search, facets, export, and suggestions. |
| Vector Search API | Dedicated vector search and vector route aliases. |
| Aliases API | Stable names for collection targets. |
| API Keys | Scoped API keys and permissions. |
Route Families
System and Runtime
| Methods | Routes |
|---|---|
| GET | /, /status, /query, /ready, /ping, /startup, /boot-status |
| ANY | /health |
| GET | /stats, /metrics, /metrics.json, /metrics/history, /metrics-history |
| GET | /connections, /doctotal, /etc, /search-config |
| GET | /rocksdb, /_rocksdb, /admin/storage_status |
| GET/POST | /update-counters, /repair |
| GET | /debug/counters, /integrity, /consistency, /self-check |
| POST | /flush |
Collections and Documents
| Methods | Routes |
|---|---|
| GET/POST | /collections |
| GET | /collections/distributed |
| GET/DELETE | /collections/{collection} |
| GET | /collections/{collection}/lang |
| POST | /collections/{collection}/update |
| GET/POST/DELETE | /collections/{collection}/documents |
| POST | /collections/{collection}/documents/import |
| GET/PUT/DELETE | /collections/{collection}/documents/{id} |
| GET | /collections/{collection}/documents/{id}/context |
| POST | /collections/{collection}/documents/_update_by_query |
| POST | /collections/{collection}/documents/_delete_by_query |
Search
| Methods | Routes |
|---|---|
| GET/POST | /collections/{collection}/documents/search |
| GET/POST | /collections/{collection}/documents/facet_counts |
| GET/POST | /collections/{collection}/documents/export |
| GET/POST | /collections/{collection}/documents/maybe |
| GET/POST | /collections/{collection}/vector_search |
| GET/POST | /collections/{collection}/search |
| GET/POST | /multi_search, /search, /sql |
/collections/{collection}/search is routed to vector search. Use /collections/{collection}/documents/search for lexical document search.
Relevance Controls
| Methods | Routes |
|---|---|
| GET | /synonyms, /synonyms/global |
| POST/PUT, GET, DELETE | /synonyms/global/{id} |
| GET | /collections/{collection}/synonyms |
| POST/PUT, GET, DELETE | /collections/{collection}/synonyms/{id} |
| GET | /stopwords, /stopwords/global |
| POST | /stopwords/global |
| DELETE | /stopwords/global/{word} |
| GET/POST | /collections/{collection}/stopwords |
| DELETE | /collections/{collection}/stopwords/{word} |
| GET | /collections/{collection}/overrides |
| POST/PUT, GET, DELETE | /collections/{collection}/overrides/{id} |
| GET | /aliases, /collections/{collection}/aliases |
| POST/PUT, GET, DELETE | /aliases/{alias} |
Access, Links, and Modules
| Methods | Routes |
|---|---|
| GET/POST | /keys, /users |
| GET/PUT/DELETE | /keys/{id}, /users/{name} |
| GET | /links, /links/ping, /modules, /modules/{module}/syntax |
| POST | /links/connect, /links/disconnect, /loadmodule, /loadmodule/{module}, /unloadmodule, /unloadmodule/{module} |
| GET/POST/PUT/DELETE | /modules/{module}/... |
| POST | /analytics/click |
Route Actions
Route actions are internal dispatch names. The current action set includes:
| Area | Actions |
|---|---|
| System | Status, Health, Ready, Ping, Startup, Stats, Metrics, MetricsHistory, Connections, RocksDB, DocTotal, Etc, SearchConfig |
| Maintenance | Flush, UpdateCounters, DebugCounters, Repair, Integrity, SelfCheck, StorageStatus |
| Collections | ListCollections, ListCollectionsDistributed, CreateCollection, GetCollection, GetCollectionLanguage, UpdateCollection, DeleteCollection |
| Documents | ListDocuments, AddDocument, BulkImportDocuments, GetDocument, GetDocumentContext, UpdateDocument, DeleteDocument, DeleteDocumentsByFilter, UpdateByQuery, DeleteByQuery |
| Search | DocumentSearch, VectorSearch, MultiSearch, GlobalSearch, FacetCounts, ExportDocuments, MaybeSuggest |
| Relevance | ListSynonyms, ListAllSynonyms, ListGlobalSynonyms, UpsertSynonym, UpsertGlobalSynonym, GetSynonym, GetGlobalSynonym, DeleteSynonym, DeleteGlobalSynonym, ListStopwords, ListAllStopwords, ListGlobalStopwords, CreateStopword, CreateGlobalStopword, DeleteStopword, DeleteGlobalStopword, ListOverrides, UpsertOverride, GetOverride, DeleteOverride, ListAliases, UpsertAlias, GetAlias, DeleteAlias |
| Access and runtime | ListUsers, CreateUser, GetUser, UpdateUser, DeleteUser, ListKeys, CreateKey, GetKey, UpdateKey, DeleteKey, LinksList, LinksPing, LinksConnect, LinksDisconnect, ListModules, GetModuleSyntax, ModuleAPI, AnalyticsClick |
Testing and Clients
- API Testing
- Testing Examples
- Testing Detailed Guide
- API Clients Overview
- Node.js Client
- Python Client
- PHP Client