API Reference

API Reference

All 12 MCP tools on HyperMemory

API Reference

HyperMemory exposes 12 MCP tools over Streamable HTTP at https://api.hypermemory.io/mcp.

Most tools have a matching /api/v1/memory/* REST route for JSON-over-HTTP clients—see REST API Endpoints. hm_upload_file, hm_list_files, and hm_list_orphans are not mirrored under /api/v1/memory/* (files use MCP/CLI or the dashboard file API; orphans are MCP/CLI only). The hm CLI calls the same tool implementations as MCP.

MCP tools

Core tools

ToolDescription
hm_storeCreate a node; triggers background enrichment and entity detection
hm_updateUpdate a node’s fields; re-embeds on description change
hm_recallHybrid search (BM25 + vector + edge BM25 + regex)
hm_find_relatedGraph traversal from a starting node
hm_get_overviewGraph stats, top nodes, type distribution
hm_forgetDelete a node with optional cascade
hm_ingestDecompose dense text into graph entities in one LLM pass
hm_list_orphansList nodes with zero edges (pagination via limit / offset)

File tools

ToolDescription
hm_upload_fileS3 upload + AI summary + graph node (Pro+ plans)
hm_list_filesQuery uploaded files by type or name

Timeline tools

ToolDescription
hm_timelineTemporal recall with query, period, date range, and node_key filters
hm_timeline_writeWrite an explicit diary entry

REST API endpoints (/api/v1/memory)

These routes live on https://api.hypermemory.io and proxy to the MCP server. They accept JSON bodies (where applicable) and require Authorization: Bearer hm_YOUR_KEY or a Supabase JWT, depending on your integration.

MethodPathMaps to
POST/api/v1/memory/storehm_store
POST/api/v1/memory/recallhm_recall
POST/api/v1/memory/updatehm_update
POST/api/v1/memory/forgethm_forget
POST/api/v1/memory/ingesthm_ingest
GET/api/v1/memory/overviewhm_get_overview
POST/api/v1/memory/relationshipshm_add_relationships
GET/api/v1/memory/relationships/{key}hm_get_relationships
POST/api/v1/memory/find-relatedhm_find_related
POST/api/v1/memory/timelinehm_timeline
POST/api/v1/memory/timeline/writehm_timeline_write
GET/api/v1/memory/healthLightweight liveness ({"status":"ok"})
GET/api/v1/memory/readyReadiness via internal hm_health dependency checks (503 if unhealthy)
GET/api/v1/memory/exportFull graph export (hm_export_full) — not one of the 12 public MCP tools

There is no /api/v1/memory/... route for hm_list_orphans, hm_upload_file, or hm_list_files. For HTTP file upload outside MCP, use the dashboard-authenticated dashboard file API (/api/files/...).