SDK & API Reference

REST API

Cloud

The REST API is RushDB Cloud's API. A self-hosted engine does not serve it: reach the engine through the SDKs' direct mode, or its own native protocol, PostgreSQL wire, gRPC and Bolt listeners.

Base URL: https://api.rushdb.com/api/v1 Auth: Authorization: Bearer YOUR_API_KEY

curl -X POST https://api.rushdb.com/api/v1/records \
  -H "Authorization: Bearer $RUSHDB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"MOVIE","data":{"title":"Inception","rating":8.8}}'

Interactive docs: Swagger UI · OpenAPI JSON

Endpoints

Group	Description
Records	Create, read, update, delete, search, import, export
Relationships	Attach and detach edges between records
Labels	Query which types exist and their counts
Properties	Inspect field names, types, and value ranges
Transactions	Atomic multi-step operations
AI & Semantic Search	Schema export, embedding indexes, vector and hybrid search
Keyword Search	Text indexes and BM25 keyword search
Raw Queries	openCypher statements run by the engine

Endpoints​

Endpoints