Document the 3.7.0 search release
Add the answer reranker (when it runs, measured effect and cost, its self
check, RERANK_MODE through the config API), questions phrased the way agents
ask, underscore identifiers and CJK-adjacent identifiers, short-word and
common-word routing through the index, lower compute on brains with many long
notes (measured locally), oldest-first export with either-order import, the
new /config section in the API reference, upgrade notes, and the contributor
eval (npm run eval:recall, npm run test:eval:full).
Document reminders and proactive push
Wiki: exports carry projects (version 3 payload)
Wiki: /projects write-route shapes, ambiguous-slug 400, and GET /tags counts
Wiki: digest error message quotes the corrected 10-entry threshold
Wiki: document the /projects endpoints and project parameter
Adds GET/POST/PATCH/DELETE /projects, the project= param on POST /capture,
GET /list, GET /recall, GET /digest (tag XOR project), and GET /graph
(including the 404 + known_projects error on reads and auto-create on
capture), and extends the MCP tools table with list_projects and the
project param on remember/recall/list_recent.
Wiki: US English spelling throughout
Wiki: align with v3.0.0 source (auth, invites, capture sources, Windsurf, upgrade wording)
Document v3 Team Edition across the wiki
Document the workspace parameter for the API, CLI and MCP tools
Document the v2.3 dashboard, /entry and /brief
Web-UI.md had drifted furthest from the product. It described three views
where there are four, and told people Forget sits inline on recall sources
and Recent rows — it was deliberately removed from the former and moved
behind an overflow on the latter, precisely because it cannot be undone.
It also covered none of what the dashboard now does: the daily brief on
Recall, opening a memory to see what the pipeline decided about it, capture
receipts, cited answers, and restoring from a backup.
API-Reference.md gains GET /entry, which was never documented and now
carries importance, recall count, the contradiction record and whether a
memory is indexed at all; and GET /brief, which is new. POST /capture's
success response documents the `tags` it now returns — what actually landed
on the entry, which is not always what was sent.
Two behaviour changes are called out where people will look for them:
top_tags no longer ranks the Worker's own bookkeeping ahead of real topics,
and a hashtag that is only digits is treated as a reference rather than a
tag, in both the API reference and the capture guide.
Correct the API reference against the shipped Worker
Several sections described behaviour the Worker no longer has. Verified
every documented route and tool against the released code and fixed what
had drifted.
GET /recall was the furthest out of date — it still documented the
pre-bounded-recall response. It now covers the kind, hops and full query
params, the query_used and semantic_unavailable fields, the per-result
truncated/full_length markers and graph-provenance fields, and the
snippet sizing rules that make content a preview rather than the whole
memory by default. Also records that deprecated and unreviewed
auto-pattern entries never appear in results.
Other corrections:
- /append and /update: document the 409 returned for managed mirrors,
which cannot be edited through the API because the next sync would
overwrite the change.
- /update: document the 500 path, note that content is only committed
after re-embedding succeeds, and correct the tag behaviour — hashtags
are merged into existing tags, not replaced.
- /stats: add unvectorized, vectorize_grace_ms and unclassified, and
describe every field.
- MCP tools: add the missing get tool, add recall's kind and hops
params, and record that recall and list_recent return bounded output
so callers know to fetch truncated entries in full.
Document the relationship and status endpoints and their MCP tools
The API reference covered 12 of the 25 routes on main and 6 of the 11 MCP
tools. Add the four user-facing endpoints that mirror MCP tools, and the
four tool rows that go with them, so both sides of each pair are described
in the same place:
- POST /status and set_status
- POST /link and link
- POST /unlink and unlink
- GET /connections and connections
Includes the behaviour that is not evident from the request shape: the
8-neighbour fanout cap on /connections and the fact that ?type= filters
after that cap, the canonical ordering of undirected relates_to edges,
idempotent re-linking, direction-agnostic unlink returning deleted:0
rather than a 404, and status being stored as a status: tag.
docs: document recall- and contradiction-aware compression protection
docs: contradiction-aware recall scoring; correct contradiction outcome (deprecate + canonical protection)
Updated API Reference (markdown)
Updated API Reference (markdown)
Created API Reference (markdown)