Getting Started
What is VectorScaleDB?
VectorScaleDB is a coupling intelligence engine built on a temporal-semantic database. The coupling matrix discovers cross-domain behavioral relationships that no other system can see — not by being told what to look for, but by learning what your data actually is.
Time-series data and vector embeddings share a unified proprietary index. This architecture enables queries impossible in any existing database: trajectory similarity search, behavioral compression, regime detection, cross-domain cascade prediction, and coupling traversal. Instead of stitching together a time-series database, a vector store, and a streaming engine, VectorScaleDB provides a single system with intelligence at the core.
VectorScaleDB is designed for cross-domain behavioral intelligence, real-time entity tracking, anomaly detection, pattern matching, and coupling-driven prediction across a growing catalog of entity types spanning 20+ domains. Safety is enforced by mathematics, not policy.
Key Capabilities
- Temporal-Semantic Index -- Time-partitioned vector search with temporal continuity edges, sub-millisecond KNN across any time range, snapshot/restore
- Vector-Aware Compression -- 200–16,500x compression via drift-based regime detection, intelligent write elimination, coupling-enhanced prediction, crash-safe durability, and adaptive threshold tuning
- 4D Scene Intelligence -- Native 4D Gaussian Splatting storage, scene differencing, LOD streaming, anchor-relative offset storage
- Trajectory Analysis -- Trajectory similarity matching, anomaly scoring, behavioral forecasting, change-point detection, density-based semantic clustering
- Enterprise Security -- AES-256-GCM envelope encryption, per-tenant key management, automated key rotation, RBAC, SHA-256 audit chains, GDPR deletion, differential privacy
- Distributed Intelligence -- consistent-hash sharding, gossip-based membership protocol, CRDTs, scatter-gather coordination, entity migration, federated template exchange
- Cross-Domain Intelligence -- Cascade detection, predictive forecasting, cross-domain alerting pipeline, density-based domain composition analysis
- Decentralized Architecture -- P2P transport layer, content-addressed segment archival with CIDs, differential privacy on segments
- Fleet-Scale Pattern Matching -- Behavioral pattern detection across millions of entities, cross-node federated template discovery
- Cloud Platform -- Multi-tenant backend with JWT auth, API keys, plan-based quotas (Free/Pro/Enterprise), and a Next.js 15 management dashboard
- AI Agent Integration -- MCP server with 30+ tools across 6 categories for connecting AI agents directly to VectorScaleDB via the Model Context Protocol
- Full GraphQL API -- 55+ queries, 9+ mutations, and real-time subscriptions alongside the REST and gRPC interfaces
- Advanced Analytics -- Variable-density clustering, distribution-aware distance for distribution comparison, topological anomaly detection via structural pattern analysis
- Trust Network -- Threshold signing, behavioral trust scoring, anti-impersonation, license governance, and bilateral consent
- Unified Storage -- Vectors, documents, graphs, blobs, and full-text search in a single storage layer with four-frequency data lifecycle
- Adaptive Deployment -- One binary spans a continuous range from microcontroller-class devices to datacenter clusters, auto-tuning compression, indexing, and resource allocation to whatever hardware it lands on. Three operational modes -- fully-federated, lightly-coupled, and air-gapped -- govern how a node participates in the wider network
- Neuroscience Architecture -- Pattern separation, operating mode detection, and neuroscience-inspired intelligence for behavioral analysis
- Virtual Filesystem -- Mount your database as a filesystem via ProjFS (Windows) or FUSE (Linux/macOS) for seamless cross-platform data access
- Self-Awareness Engine -- Coupling matrix for cross-entity behavioral prediction, dream daemon for offline consolidation, convergence tracking, and Weissman compression scoring
Quick Start
1. Connect
The substrate is the VectorScaleDB network at https://api.vectorscaledb.com. Authenticate with an API key (or sign in with OAuth) — create one on the Authentication page, then pass it to the client. Running an air-gapped, standalone, or co-located node or cluster? Point the client at it directly instead — e.g. http://localhost:5434 for a VSDB or VSOS node on this device or local network.
from vectorscaledb import Client
client = Client("https://api.vectorscaledb.com", api_key="your-api-key")
# Verify connectivity
curl https://api.vectorscaledb.com/health
2. Ingest Data
client.ingest(
entity_id="sensor-42",
vector=[0.1, 0.8, 0.3, 0.9],
entity_type="LINK_METRIC"
)
curl -X POST https://api.vectorscaledb.com/v1/ingest \
-H "Authorization: Bearer $VSDB_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"entity_id": "sensor-42",
"vector": [0.1, 0.8, 0.3, 0.9],
"entity_type": "LINK_METRIC"
}'
3. Query
results = client.temporal_knn(
query_vector=[0.1, 0.7, 0.4, 0.8],
start_time="2025-01-01T00:00:00Z",
end_time="2025-12-31T23:59:59Z",
k=5
)
curl -X POST https://api.vectorscaledb.com/v1/query/temporal-knn \
-H "Authorization: Bearer $VSDB_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query_vector": [0.1, 0.7, 0.4, 0.8],
"start_time": "2025-01-01T00:00:00Z",
"end_time": "2025-12-31T23:59:59Z",
"k": 5
}'
Temporal KNN combines vector similarity with time-range filtering in a single index traversal -- no post-filtering required. This is what makes it faster than chaining a vector search with a time-series query.
Supported Protocols
- REST API -- 450+ endpoints covering ingestion, querying, administration, and streaming
- gRPC -- Protocol Buffer definitions for high-throughput, low-latency communication
- GraphQL -- 55+ queries, 9+ mutations, and real-time subscriptions for flexible data access
- MCP -- Model Context Protocol server with 30+ tools across 6 categories for AI agent integration
- SSE / WebSocket -- Server-Sent Events and WebSocket streams for real-time notifications
- SDKs -- Native clients for Python, Rust, and Node.js with full type safety
Industry Adapters
VectorScaleDB includes adapters that translate domain-specific formats into temporal-semantic vectors on ingest:
| Category | Formats |
|---|---|
| Autonomous Vehicles | MCAP, LAS/PCD, SPZ, glTF |
| Financial Markets | FIX 4.4/5.0, CSV tick data, ITCH/OUCH |
| Networking & CDN | NetFlow/sFlow/IPFIX, SNMP, gNMI, Prometheus |
| Bio-Computing | NWB, HDF5, NEV/NSx, SpikeInterface, MEA streams, FlyWire connectome, FlyGM GNN, Brian2/NEST spike trains, MuJoCo behavior |
| IoT & Industrial | MQTT (JSON/CBOR), Modbus, OPC-UA, CoAP |
| Film & VFX | BVH, C3D motion capture, camera tracking |
| Gaming & NPC AI | Game engine state, faction dynamics, social bonds |
| Geospatial | ADS-B, AIS, TLE, weather, earthquake, fire, transit |
| Social Dynamics | Social simulation, survey data |
| Genomics & DNA | VCF variants, gene expression (bulk/single-cell), DNA foundation model embeddings |
| BCI & Cognitive | BCI EEG signal frames, cognitive state decodings |
Adapters handle format parsing, vector extraction, and entity type mapping automatically. You send raw domain data; VectorScaleDB indexes it as temporal-semantic vectors.
Next Steps
- API Reference -- Full endpoint documentation for REST, gRPC, and GraphQL
- SDKs -- Installation, configuration, and usage for Python, Rust, and Node.js
- Entity Types -- Reference for the core entity types across 20+ domains
- Configuration -- Deployment options, tuning parameters, and environment setup
- FAQ -- Common questions and troubleshooting