API Documentation

Novyx RAM API

Persistent memory, semantic search, rollback, audit trails, replay debugging, and cortex intelligence for AI agents.

Base URL: https://novyx-ram-api.fly.dev

Authentication

All authenticated endpoints require a Bearer token:

Authorization: Bearer nram_{tenant_id}_{signature}

Get a free API key at novyxlabs.com or via POST /v1/keys.

Python SDK

pip install novyx

PyPI

JavaScript / TypeScript SDK

npm install novyx

npm

System Memories Auth & Keys Audit Rollback Context Spaces Sharing Knowledge Graph Traces Replay Cortex Context Plans & Billing Pricing

System

MethodPathAuthDescription
GET/healthNoHealth check (disk, memory, Redis, audit)
GET/healthzNoLightweight liveness probe
GET/v1/statusOptionalAPI status and metrics
GET/metricsYesPrometheus metrics
curl https://novyx-ram-api.fly.dev/health

Memories

MethodPathDescription
POST/v1/memoriesStore a new memory
GET/v1/memoriesList memories with filters
GET/v1/memories/searchSemantic search
GET/v1/memories/statsMemory statistics
GET/v1/memories/graphMemory graph (nodes and edges)
GET/v1/memories/analyticsQuality analytics
POST/v1/memories/bulkBulk delete/update
POST/v1/memories/linkCreate edge between memories
DELETE/v1/memories/linkRemove edge
GET/v1/memories/edgesList all edges
GET/v1/memories/{id}Get specific memory
GET/v1/memories/{id}/historyMerge history (Enterprise)
GET/v1/memories/{id}/linksGet edges for a memory
PATCH/v1/memories/{id}Update memory fields
DELETE/v1/memories/{id}Delete memory

Store a memory

curl -X POST https://novyx-ram-api.fly.dev/v1/memories \
  -H "Authorization: Bearer nram_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "observation": "User prefers dark mode",
    "tags": ["preferences"],
    "importance": 8
  }'

Semantic search

curl "https://novyx-ram-api.fly.dev/v1/memories/search?query=user+preferences&limit=5" \
  -H "Authorization: Bearer nram_your_key"

List memories

curl "https://novyx-ram-api.fly.dev/v1/memories?limit=20&min_importance=7" \
  -H "Authorization: Bearer nram_your_key"

Auth & API Keys

MethodPathAuthDescription
POST/v1/keysNoSelf-serve API key signup
POST/v1/verifyNoVerify email and activate key
GET/v1/verifyNoVerify email via GET link
POST/v1/keys/rotateYesRotate API key (24h grace)
POST/v1/keys/{id}/revokeYesRevoke a key
GET/v1/keysYesList tenant's API keys
GET/v1/usageYesCurrent usage vs limits
POST/admin/keysAdminAdmin key creation
POST/v1/keys/force-revokeAdminForce revoke by ID
GET/v1/keys/analytics/signupsAdminSignup analytics

Audit Trail

MethodPathTierDescription
GET/v1/auditAllAccess audit log
GET/v1/audit/summaryAllAudit summary statistics
GET/v1/audit/healthAllAudit trail health
GET/v1/audit/verifyAllVerify chain integrity
GET/v1/audit/exportPro+Export as CSV/JSON
curl "https://novyx-ram-api.fly.dev/v1/audit?limit=20" \
  -H "Authorization: Bearer nram_your_key"

Rollback Pro+

MethodPathDescription
POST/v1/rollbackExecute rollback to timestamp or relative time
GET/v1/rollback/previewPreview rollback changes (all tiers)
GET/v1/rollback/suggestAI-suggested rollback point
GET/v1/rollback/historyPast rollback operations
POST/v1/memories/rollbackRollback by tag/criteria
# Preview
curl "https://novyx-ram-api.fly.dev/v1/rollback/preview?target=2+hours+ago" \
  -H "Authorization: Bearer nram_your_key"

# Execute
curl -X POST https://novyx-ram-api.fly.dev/v1/rollback \
  -H "Authorization: Bearer nram_your_key" \
  -H "Content-Type: application/json" \
  -d '{"target": "2 hours ago"}'

Context Spaces

MethodPathDescription
POST/v1/context-spacesCreate space
GET/v1/context-spacesList spaces
GET/v1/context-spaces/{id}Get space
PUT/v1/context-spaces/{id}Update space
DELETE/v1/context-spaces/{id}Delete space
GET/v1/context-spaces/{id}/memoriesList memories in space

Sharing Pro+

MethodPathDescription
POST/v1/spaces/shareGenerate share token
POST/v1/spaces/share/{token}/rotateRotate share token
GET/v1/spaces/sharedList spaces you've shared
GET/v1/spaces/shared-with-meList spaces shared with you
POST/v1/spaces/joinAccept share token
DELETE/v1/spaces/share/{token}Revoke share

Knowledge Graph Pro+

MethodPathDescription
POST/v1/knowledge/triplesCreate triple
GET/v1/knowledge/triplesList triples
GET/v1/knowledge/triples/{id}Get triple
DELETE/v1/knowledge/triples/{id}Delete triple
GET/v1/knowledge/entitiesList entities
GET/v1/knowledge/entities/{id}Traverse entity connections
DELETE/v1/knowledge/entities/{id}Delete entity

Traces Pro+

MethodPathDescription
POST/v1/tracesCreate trace session
POST/v1/traces/{id}/stepsAdd step to trace
POST/v1/traces/{id}/completeFinalize with RSA signature
GET/v1/tracesList traces
GET/v1/traces/{id}Get trace with steps
GET/v1/traces/{id}/certificateGet signed certificate
GET/v1/traces/public-keyRSA public key for verification
POST/v1/traces/{id}/verifyVerify trace integrity

Replay Pro+

Time-travel debugging for AI agent memory.

MethodPathTierDescription
GET/v1/replay/timelinePro+Timeline of memory operations
GET/v1/replay/snapshotPro+Memory state at timestamp T
GET/v1/replay/memory/{id}Pro+Full lifecycle of a memory
POST/v1/replay/recallEnterpriseCounterfactual recall at time T
GET/v1/replay/diffPro+Diff between two timestamps
GET/v1/replay/driftEnterpriseMemory composition drift
curl "https://novyx-ram-api.fly.dev/v1/replay/timeline?limit=20" \
  -H "Authorization: Bearer nram_your_key"

Cortex Pro+

Autonomous memory intelligence. Consolidates near-duplicates, boosts frequently-recalled memories, decays forgotten ones, and generates insights.

MethodPathTierDescription
GET/v1/cortex/statusPro+Status, last run, config
GET/v1/cortex/configPro+Current configuration
PATCH/v1/cortex/configPro+Update configuration
POST/v1/cortex/runPro+Trigger manual cycle
GET/v1/cortex/insightsEnterpriseGenerated insights
curl https://novyx-ram-api.fly.dev/v1/cortex/status \
  -H "Authorization: Bearer nram_your_key"

Context

MethodPathDescription
GET/v1/context/nowTemporal context snapshot (recent memories, upcoming deadlines)

Plans & Billing

MethodPathAuthDescription
GET/v1/plansNoList all tiers and limits
POST/v1/checkoutYesCreate Stripe checkout session
POST/v1/webhook/stripeNoStripe webhook
GET/v1/billingYesStripe customer portal URL

Pricing

TierPriceMemoriesAPI Calls/moRollbacksAudit
Free$05,0005,00010/mo7 days
Starter$12/mo25,00025,00030/mo14 days
Pro$39/moUnlimited100,000Unlimited30 days
Enterprise$199/moUnlimitedUnlimitedUnlimited90 days

Pro+: Replay, Cortex, Traces, Knowledge Graph, Context Spaces sharing, audit export

Enterprise: Cortex insights, counterfactual recall, drift analysis, merge history

Novyx Labs — novyxlabs.comGitHub