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
| Tool | Description |
|---|---|
hm_store | Create a node; triggers background enrichment and entity detection |
hm_update | Update a node’s fields; re-embeds on description change |
hm_recall | Hybrid search (BM25 + vector + edge BM25 + regex) |
hm_find_related | Graph traversal from a starting node |
hm_get_overview | Graph stats, top nodes, type distribution |
hm_forget | Delete a node with optional cascade |
hm_ingest | Decompose dense text into graph entities in one LLM pass |
hm_list_orphans | List nodes with zero edges (pagination via limit / offset) |
File tools
| Tool | Description |
|---|---|
hm_upload_file | S3 upload + AI summary + graph node (Pro+ plans) |
hm_list_files | Query uploaded files by type or name |
Timeline tools
| Tool | Description |
|---|---|
hm_timeline | Temporal recall with query, period, date range, and node_key filters |
hm_timeline_write | Write 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.
| Method | Path | Maps to |
|---|---|---|
| POST | /api/v1/memory/store | hm_store |
| POST | /api/v1/memory/recall | hm_recall |
| POST | /api/v1/memory/update | hm_update |
| POST | /api/v1/memory/forget | hm_forget |
| POST | /api/v1/memory/ingest | hm_ingest |
| GET | /api/v1/memory/overview | hm_get_overview |
| POST | /api/v1/memory/relationships | hm_add_relationships |
| GET | /api/v1/memory/relationships/{key} | hm_get_relationships |
| POST | /api/v1/memory/find-related | hm_find_related |
| POST | /api/v1/memory/timeline | hm_timeline |
| POST | /api/v1/memory/timeline/write | hm_timeline_write |
| GET | /api/v1/memory/health | Lightweight liveness ({"status":"ok"}) |
| GET | /api/v1/memory/ready | Readiness via internal hm_health dependency checks (503 if unhealthy) |
| GET | /api/v1/memory/export | Full 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/...).