REFERENCE.md
# agentmemory REST API reference
Generated from `src/triggers/api.ts`. Do not edit the block below by hand; run `npm run skills:gen` after changing the registered endpoints.
<!-- AUTOGEN:rest START - generated by scripts/skills/generate.ts, do not edit by hand -->
The REST API is the primary surface. All paths are under `http://localhost:3111` (override with `--port`). Send `Authorization: Bearer <secret>`: the value of `AGENTMEMORY_SECRET`, or the one generated into `~/.agentmemory/secret` on first start when it is unset. Writes must use `Content-Type: application/json`.
147 registered endpoints:
| Method | Path |
| --- | --- |
| GET | `/agentmemory/actions` |
| POST | `/agentmemory/actions` |
| POST | `/agentmemory/actions/edges` |
| GET | `/agentmemory/actions/get` |
| POST | `/agentmemory/actions/update` |
| GET | `/agentmemory/audit` |
| POST | `/agentmemory/auto-forget` |
| GET | `/agentmemory/branch/detect` |
| GET | `/agentmemory/branch/sessions` |
| GET | `/agentmemory/branch/worktrees` |
| GET | `/agentmemory/capture` |
| POST | `/agentmemory/capture/drain` |
| POST | `/agentmemory/capture/retry` |
| POST | `/agentmemory/cascade-update` |
| GET | `/agentmemory/checkpoints` |
| POST | `/agentmemory/checkpoints` |
| POST | `/agentmemory/checkpoints/resolve` |
| GET | `/agentmemory/claude-bridge/read` |
| POST | `/agentmemory/claude-bridge/sync` |
| GET | `/agentmemory/commits` |
| POST | `/agentmemory/compress-file` |
| GET | `/agentmemory/compression` |
| POST | `/agentmemory/compression/retry` |
| GET | `/agentmemory/config/flags` |
| POST | `/agentmemory/consolidate` |
| POST | `/agentmemory/consolidate-pipeline` |
| GET | `/agentmemory/consolidation/status` |
| POST | `/agentmemory/context` |
| GET | `/agentmemory/counts` |
| GET | `/agentmemory/crystals` |
| POST | `/agentmemory/crystals/auto` |
| POST | `/agentmemory/crystals/create` |
| POST | `/agentmemory/diagnostics` |
| GET | `/agentmemory/diagnostics/followup` |
| POST | `/agentmemory/diagnostics/heal` |
| POST | `/agentmemory/enrich` |
| POST | `/agentmemory/evict` |
| POST | `/agentmemory/evolve` |
| GET | `/agentmemory/export` |
| GET | `/agentmemory/facets` |
| POST | `/agentmemory/facets` |
| POST | `/agentmemory/facets/query` |
| POST | `/agentmemory/facets/remove` |
| GET | `/agentmemory/facets/stats` |
| POST | `/agentmemory/file-context` |
| POST | `/agentmemory/flow/compress` |
| POST | `/agentmemory/forget` |
| GET | `/agentmemory/frontier` |
| POST | `/agentmemory/generate-rules` |
| POST | `/agentmemory/governance/bulk-delete` |
| DELETE | `/agentmemory/governance/memories` |
| POST | `/agentmemory/graph/build` |
| POST | `/agentmemory/graph/compact` |
| POST | `/agentmemory/graph/extract` |
| POST | `/agentmemory/graph/import-graphify` |
| GET | `/agentmemory/graph/index` |
| POST | `/agentmemory/graph/index/migrate` |
| POST | `/agentmemory/graph/index/resume` |
| GET | `/agentmemory/graph/node` |
| POST | `/agentmemory/graph/query` |
| POST | `/agentmemory/graph/reset` |
| POST | `/agentmemory/graph/snapshot-rebuild` |
| GET | `/agentmemory/graph/stats` |
| GET | `/agentmemory/health` |
| POST | `/agentmemory/import` |
| GET | `/agentmemory/insights` |
| POST | `/agentmemory/insights/search` |
| POST | `/agentmemory/leases/acquire` |
| POST | `/agentmemory/leases/release` |
| POST | `/agentmemory/leases/renew` |
| GET | `/agentmemory/lessons` |
| POST | `/agentmemory/lessons` |
| POST | `/agentmemory/lessons/delete` |
| POST | `/agentmemory/lessons/get` |
| POST | `/agentmemory/lessons/search` |
| POST | `/agentmemory/lessons/strengthen` |
| GET | `/agentmemory/livez` |
| GET | `/agentmemory/memories` |
| GET | `/agentmemory/memories/:id` |
| GET | `/agentmemory/mesh/export` |
| GET | `/agentmemory/mesh/peers` |
| POST | `/agentmemory/mesh/peers` |
| POST | `/agentmemory/mesh/receive` |
| POST | `/agentmemory/mesh/sync` |
| POST | `/agentmemory/migrate` |
| GET | `/agentmemory/next` |
| GET | `/agentmemory/observations` |
| GET | `/agentmemory/observations/locate` |
| POST | `/agentmemory/observe` |
| POST | `/agentmemory/obsidian/export` |
| POST | `/agentmemory/patterns` |
| GET | `/agentmemory/procedural` |
| GET | `/agentmemory/profile` |
| POST | `/agentmemory/reflect` |
| GET | `/agentmemory/relations` |
| POST | `/agentmemory/relations` |
| POST | `/agentmemory/remember` |
| POST | `/agentmemory/replay/import-jsonl` |
| GET | `/agentmemory/replay/load` |
| GET | `/agentmemory/replay/sessions` |
| GET | `/agentmemory/routines` |
| POST | `/agentmemory/routines` |
| POST | `/agentmemory/routines/run` |
| GET | `/agentmemory/routines/status` |
| POST | `/agentmemory/search` |
| GET | `/agentmemory/semantic` |
| GET | `/agentmemory/sentinels` |
| POST | `/agentmemory/sentinels` |
| POST | `/agentmemory/sentinels/cancel` |
| POST | `/agentmemory/sentinels/check` |
| POST | `/agentmemory/sentinels/trigger` |
| GET | `/agentmemory/session/by-commit` |
| POST | `/agentmemory/session/commit` |
| POST | `/agentmemory/session/end` |
| POST | `/agentmemory/session/start` |
| GET | `/agentmemory/sessions` |
| GET | `/agentmemory/signals` |
| POST | `/agentmemory/signals/send` |
| GET | `/agentmemory/sketches` |
| POST | `/agentmemory/sketches` |
| POST | `/agentmemory/sketches/add` |
| POST | `/agentmemory/sketches/discard` |
| POST | `/agentmemory/sketches/gc` |
| POST | `/agentmemory/sketches/promote` |
| DELETE | `/agentmemory/slot` |
| GET | `/agentmemory/slot` |
| POST | `/agentmemory/slot` |
| POST | `/agentmemory/slot/append` |
| POST | `/agentmemory/slot/reflect` |
| POST | `/agentmemory/slot/replace` |
| GET | `/agentmemory/slots` |
| POST | `/agentmemory/smart-search` |
| POST | `/agentmemory/snapshot/create` |
| POST | `/agentmemory/snapshot/restore` |
| GET | `/agentmemory/snapshots` |
| GET | `/agentmemory/status` |
| POST | `/agentmemory/summarize` |
| GET | `/agentmemory/team/feed` |
| GET | `/agentmemory/team/profile` |
| POST | `/agentmemory/team/share` |
| POST | `/agentmemory/timeline` |
| POST | `/agentmemory/verify` |
| GET | `/agentmemory/viewer` |
| GET | `/agentmemory/viewer/events` |
| GET | `/agentmemory/viewer/snapshot` |
| POST | `/agentmemory/vision-embed` |
| POST | `/agentmemory/vision-search` |
<!-- AUTOGEN:rest END -->
SKILL.md
---
name: agentmemory-rest-api
description: The agentmemory HTTP REST API surface, the primary protocol for talking to the memory server. Use when calling agentmemory over HTTP, when MCP is unavailable and you need a fallback, or when integrating a host that does not speak MCP.
user-invocable: false
---
REST is agentmemory's primary surface. MCP is a bridge on top of it. Every memory operation has an HTTP endpoint under `http://localhost:3111/agentmemory/*`.
## Quick start
```bash
# liveness
curl -fsS http://localhost:3111/agentmemory/livez
# For this fixed loopback URL only. Do not print the value or enable shell tracing.
agentmemory_secret="${AGENTMEMORY_SECRET:-$(cat "$HOME/.agentmemory/secret")}"
test -n "$agentmemory_secret" || exit 1
# save
curl -fsS -X POST http://localhost:3111/agentmemory/remember \
-H "Authorization: Bearer $agentmemory_secret" \
-H "Content-Type: application/json" \
-d '{"content":"chose JWT refresh rotation","concepts":["jwt-refresh-rotation"]}'
# recall
curl -fsS -X POST http://localhost:3111/agentmemory/smart-search \
-H "Authorization: Bearer $agentmemory_secret" \
-H "Content-Type: application/json" \
-d '{"query":"auth token strategy","limit":5}'
```
## Auth
Every endpoint except liveness requires `Authorization: Bearer <secret>`, including on localhost. The server always has a secret: `AGENTMEMORY_SECRET` when you set one, otherwise one it generates at first start. Requests without the header get `401`. Liveness is public. The example uses an explicit environment secret or the generated local secret file; if the daemon uses a secret from its `.env`, load that value locally without displaying it. For a remote daemon, require an explicit credential for that endpoint and HTTPS. Never forward a local-file secret or follow an authenticated redirect to another host. See [TROUBLESHOOTING.md](TROUBLESHOOTING.md).
## Conventions
- Save returns `201`, reads return `200`, validation errors return `400`.
- Use documented fields only. A successful response does not prove an unsupported field was applied.
- The REST port defaults to `3111` and is configurable with `--port` or `--instance`. The viewer defaults to `3113`; the internal engine WebSocket defaults to `49134`.
## See also
- agentmemory-mcp-tools for the MCP equivalents.
- agentmemory-config for local configuration and the secret.
## Reference
The full endpoint list with methods lives in REFERENCE.md, generated from `src/triggers/api.ts`.
TROUBLESHOOTING.md
<!-- AUTOGEN:troubleshooting START - generated by scripts/skills/generate.ts, do not edit by hand -->
# Troubleshooting agentmemory skills
Recovery steps for separately installed skills. This document is generated into
each skill directory so native skill readers can open it without parent traversal.
## "MCP tool not available"
Missing tools can mean a stopped MCP process, a disconnected daemon, or an
explicitly reduced tool surface. Walk these in order:
1. Identify the host. In Claude Code, inspect `/plugin list` and `/mcp`.
In Hermes, inspect the configured memory provider and `mcp_servers` separately.
In OpenClaw, validate the host configuration and inspect its MCP servers and
native plugins separately. In Pi or OMP, inspect `/agentmemory-status` and the
MCP inventory separately; native save/search does not prove the broader tools
are connected. Do not run another host's setup commands.
2. Restart or reload the affected host connection after configuration changes.
3. Inspect the connected tool inventory. Hermes may namespace MCP tools; invoke
the actual advertised names and schemas. A native memory provider is not
proof that every MCP tool or shared skill is available.
4. Check `agentmemory status` and the daemon's `AGENTMEMORY_TOOLS` setting.
Codex's bundled bridge lists the daemon's enabled tools. The standalone shim
used by other hosts can fall back to seven basic tools with a separate store.
Do not claim full daemon functionality based on those seven tools.
5. If `agentmemory connect codex` and the Codex plugin are both enabled, choose
one MCP connection. Check `/hooks` before adding global hook fallbacks.
Hermes, OpenClaw, Pi and OMP connector installations bundle skills; other hosts
may install them separately. Check the host's skill inventory and open this file
from the installed skill directory. Test automatic capture with a real turn and
a recorded observation; tool connectivity alone does not establish lifecycle
capture.
An outage or timeout is not an empty search result. Report the failure. A write
may have committed before the response was lost; inspect state before retrying.
## REST fallback
When the MCP tools stay unavailable but the daemon is running, call the REST
API directly:
1. Set `AGENTMEMORY_URL` to the daemon base URL (default `http://localhost:3111`).
2. The REST API requires a bearer credential by default. Use the host's explicit
`AGENTMEMORY_SECRET`; for loopback URLs only, fall back to the secret in
`~/.agentmemory/.env` and then `~/.agentmemory/secret`. Load the value locally
without displaying it. Never send a local-file secret to a remote URL.
If `AGENTMEMORY_CREDENTIAL_MODE=explicit`, require the explicit host credential
and do not read local credential files.
Authenticated REST fallback requests require HTTPS for non-loopback
URLs; HTTP is allowed for loopback URLs (`localhost`, `127.0.0.0/8`, or `[::1]`).
Reject redirects on authenticated requests. Do not print or save the secret.
Endpoint map by skill:
| Skill | REST call |
| --------------- | --------------------------------------------------------------- |
| remember | `POST /agentmemory/remember` |
| recall | `POST /agentmemory/smart-search` |
| recap | `GET /agentmemory/sessions` + `POST /agentmemory/smart-search` |
| handoff | `GET /agentmemory/sessions` + `POST /agentmemory/smart-search` |
| session-history | `GET /agentmemory/sessions` |
| commit-context | `GET /agentmemory/session/by-commit?sha=<sha>` |
| commit-history | `GET /agentmemory/commits` (URL-encode every query param) |
The MCP host reads the plugin MCP configuration. Restart the daemon after
changing its configuration, then restart or reconnect the host MCP process after
changing its URL or explicit secret. The local bridge reads the credential files
for each request; it does not inherit other daemon `.env` settings.
<!-- AUTOGEN:troubleshooting END -->