API Reference
Complete REST, gRPC, and GraphQL API for VectorScaleDB. 450+ endpoints across 27 categories: temporal-semantic queries, IoT, NPC AI, geospatial, social dynamics, real-time subscriptions, authentication, trust network, and enterprise administration.
Base URL
https://api.vectorscaledb.com — the production VectorScaleDB network. Staging is at https://staging-api.vectorscaledb.com.
Air-gapped, standalone, or co-located deployments are addressed directly instead of the network — point at the node or cluster itself (e.g. http://localhost:5434 for a VSDB or VSOS node running on this device or local network).
Authentication
Every request is authenticated against the network. Send an API key as Authorization: Bearer <key>, or sign in with OAuth and send the returned access token. Create keys and manage sign-in on the Authentication page.
Safety as physics
Behind these endpoints, the core safety guarantees are compile-time invariants enforced by the type system — universal irrevocable consent, no self-propagation, and a vast-majority governance quorum that no single party can reach alone. See Enterprise Security and the Trust Network.
Endpoint Categories
Core
Health checks and Prometheus metrics.
2 endpoints
Ingestion
Vectors, 3D scenes, MCAP, point clouds, network telemetry, financial feeds, neural recordings.
22 endpoints
Temporal-Semantic Queries
KNN, trajectory similarity, anomaly scoring, forecasting.
7 endpoints
Networking
Route optimization, traffic anomaly detection, CDN profiling, topology tracing.
4 endpoints
Financial Markets
Market regime detection, correlation analysis, historical pattern replay.
3 endpoints
Bio-Computing
Learning onset, stimulus-response, cross-organoid comparison, synchrony, fleet ranking.
5 endpoints
Patterns & Intelligence
Behavioral pattern CRUD: create, list, retrieve, and delete stored patterns for fleet-scale matching.
4 endpoints
Gaussian / Scene
Scene differencing and LOD streaming for 4D Gaussian Splatting.
2 endpoints
IoT Platform
MQTT ingestion, sensor anomaly detection, predictive maintenance, fleet health, geofence analysis.
11 endpoints
NPC AI
Brain tiers, personality modeling, faction dynamics, social cascade prediction, emergent behavior.
7 endpoints
Geospatial
ADS-B aviation, AIS maritime, satellite TLE, weather, fire, transit. Spatial clustering and proximity alerts.
10 endpoints
Social Dynamics
Social agent management, cascade prediction, group fragmentation, cultural evolution, Dunbar layers.
8 endpoints
Real-Time & Subscriptions
WebSocket subscriptions, reconnection replay, WASM reducers, diagnostics.
9 endpoints
Streaming
Server-Sent Events, webhook registration, real-time notifications.
3 endpoints
Enterprise & Admin
Audit trail, GDPR deletion, SLA monitoring, usage metering, content safety.
7 endpoints
Genomics
VCF variant ingestion, gene expression analysis, DNA embeddings, cell state trajectories.
6 endpoints
Inventory
Container management, item tracking, audit logs, historical reconstruction.
7 endpoints
Portals & Worlds
World partitioning, cross-tenancy portals, HMAC tokens, cross-tenant queries.
11 endpoints
BCI & Cognitive
BCI sessions, consent contracts, skill distillation, immersive reality.
32 endpoints
GraphQL
Queries, mutations, subscriptions, and interactive Playground.
3 endpoints
Authentication
Login, registration, MFA, WebAuthn, OAuth, session management, and password operations.
18 endpoints
Trust Network
Threshold signing, trust scoring, license governance, revocation, and arbiter operations.
12 endpoints
Neuroscience
Pattern separation, operating mode detection, consolidation, self-awareness, and neuroscience-inspired analytics.
17 endpoints
Unified Storage
Document, graph, blob, and full-text search operations on the unified storage layer.
14 endpoints
Deployment Tiers
Tier configuration, resource profiling, throttle status, and system information.
4 endpoints
CDN
Content distribution, caching, purge operations, and edge node statistics.
6 endpoints
Composite Entities
Composite entity CRUD, participant management, skill execution, and skill discovery.
16 endpoints
Authentication
All enterprise and admin endpoints require a Bearer token passed via the Authorization header:
Authorization: Bearer <your-api-key>
Supported Protocols
| Protocol | Endpoint | Use Case |
|---|
| REST | /v1/* | Standard API access, 450+ endpoints |
| gRPC | Port 50051 | High-throughput, low-latency streaming |
| GraphQL | /graphql | Flexible queries with field selection |
| WebSocket | /graphql/ws | Real-time subscriptions |
| SSE | /v1/stream/* | Server-pushed event streams |
| MCP | Stdio transport | AI agent integration (tool surface queried live over stdio) |
Client SDKs
Native clients with full type safety. Every SDK — Python, Rust, and Node.js — is generated from one live OpenAPI 3.1 specification, so all three stay in guaranteed feature parity with the API and never drift. Package-manager distribution is available at launch — the commands below show the published package names: