API reference
Fast-lookup, per-surface contract pages for the Amnesia plugin API. Each page documents one surface, shows its stability label, lists its methods or events, and states the capability it requires.
New to the API? Start with the overview or the Connect to the Amnesia API guide.
Shipped surfaces
Section titled “Shipped surfaces”| Page | Surface | Stability |
|---|---|---|
| Access the API | window.Amnesia container + connect() handle |
Shipped |
| Capabilities and permissions | expandCapabilities, PermissionError, hierarchy |
Shipped |
commands.notes |
Notes CRUD, search, export | Shipped |
commands.links |
Links create/get/delete/navigate | Shipped |
commands.mupdf |
PDF text, selection, annotation primitives | Shipped |
| Events | on / off / once delivery mechanism |
Shipped (mechanism) |
Experimental surfaces
Section titled “Experimental surfaces”| Page | Surface | Stability |
|---|---|---|
| Experimental surfaces | version, state.*, commands.library/highlights/bookmarks, hooks, connect() scoping, ready handshake |
Experimental |
Readiness legend
Section titled “Readiness legend”- Shipped —
public-stable: wired, proven, safe to depend on; breaking changes only on a major version bump with a deprecation window. - Experimental —
public-experimental: wired but unproven; may change or break without a major bump; no compatibility promise. - Not yet available — specified or scaffolded but not reachable through the live API; documented nowhere as callable. Listed under Not yet available.
Per-event convention
Section titled “Per-event convention”The .events delivery mechanism is shipped, but individual event readiness is labeled per event,
at the tier of the facade that emits it. The Events page
carries the full per-event table: note-* and link-* are shipped; highlight-* are experimental;
reader, content, navigation, and collection events do not fire today.
Reference verified as of 2026-06-28.