HTTP And Admin API
ShrikeDB has two HTTP-facing surfaces:
-
the HTTP REST API under
/api/v1, -
the admin health server under
/health.
Send a request
Use the HTTP listener for /api/v1 routes and the admin listener for /health routes. In the local guide configuration these are ports 8182 and 9190 respectively.
curl --fail-with-body http://127.0.0.1:8182/api/v1/health
curl --fail-with-body http://127.0.0.1:9190/health/readyPOST requests with JSON bodies need Content-Type: application/json. Add the appropriate credential and x-shrikedb-database header for a shared or multi-database deployment; see Connect To ShrikeDB. A successful HTTP status for an MCP request can still contain a JSON-RPC error.
Request examples for data operations are in Your first multimodal dataset, Import a dataset, and Geospatial and spatiotemporal indexing. The tables below identify routes; they are not shell commands.
HTTP REST API
| Method | Path | Purpose |
|---|---|---|
|
|
Create a schema. |
|
|
Add a semantic mapping rule. |
|
|
Put a KV record with base64 value. |
|
|
Get a KV record. |
|
|
Insert a graph block. |
|
|
HTTP service health. |
|
|
KV namespace report. |
|
|
Vector namespace report. |
|
|
Cross-modality alignment report. |
Trace Endpoints
| Method | Path | Purpose |
|---|---|---|
|
|
Recent vector traces. |
|
|
Perfetto vector trace. |
|
|
Live vector trace stream. |
|
|
Read or update vector trace config. |
|
|
Recent query plan traces. |
|
|
Perfetto query plan trace. |
|
|
Live query plan trace stream. |
|
|
Read or update query plan trace config. |
Admin Operations
| Method | Path | Purpose |
|---|---|---|
|
|
Prewarm vector learned router state. |
|
|
Prewarm graph predicate inbound cache. |
|
|
Backfill one KV namespace’s raw u64 keys. |
|
|
Backfill known KV raw u64 keys in batch. |