René's URL Explorer Experiment


Title: API | memhtml

Open Graph Title: API

Description: The generated reference for the workspace packages, one directory per package and one page per module, built from the TSDoc in the source on every site build.

Open Graph Description: The generated reference for the workspace packages, one directory per package and one page per module, built from the TSDoc in the source on every site build.

Opengraph URL: https://memhtml.github.io/api/

Generator: Starlight v0.42.8

direct link

Domain: memhtml.github.io

og:typearticle
og:localeen
og:site_namememhtml
twitter:cardsummary_large_image
og:imagehttps://memhtml.github.io/og/api.png
og:image:typeimage/png
og:image:width1200
og:image:height630
og:image:altA specification cover set on warm paper: “API” over a line of abstract, closed by a red rule.
twitter:imagehttps://memhtml.github.io/og/api.png
twitter:image:altA specification cover set on warm paper: “API” over a line of abstract, closed by a red rule.

Links:

Skip to contenthttps://memhtml.github.io/api/#_top
memhtmlhttps://memhtml.github.io/
GitHubhttps://github.com/memhtml/memhtml
For agentshttps://memhtml.github.io/agents/
Learnhttps://memhtml.github.io/learn/
Audit and publish the corpushttps://memhtml.github.io/learn/operations/audit-and-publish-the-corpus/
Check the discrimination gatehttps://memhtml.github.io/learn/operations/check-the-discrimination-gate/
Configure the environmenthttps://memhtml.github.io/learn/operations/configure-the-environment/
Curate the corpushttps://memhtml.github.io/learn/operations/curate-the-corpus/
Diagnose poor retrievalhttps://memhtml.github.io/learn/operations/diagnose-poor-retrieval/
Hooks and recallhttps://memhtml.github.io/learn/operations/hooks-and-recall/
Index session transcriptshttps://memhtml.github.io/learn/operations/index-session-transcripts/
Initialize a storehttps://memhtml.github.io/learn/operations/initialize-a-store/
Migrate to 0.16https://memhtml.github.io/learn/operations/migrate-to-0-16/
Preserve the state planehttps://memhtml.github.io/learn/operations/preserve-the-state-plane/
Rebuild the indexhttps://memhtml.github.io/learn/operations/rebuild-the-index/
Recover from a lost indexhttps://memhtml.github.io/learn/operations/recover-from-a-lost-index/
Run a head serverhttps://memhtml.github.io/learn/operations/run-a-head-server/
Run the store day to dayhttps://memhtml.github.io/learn/operations/run-the-store-day-to-day/
Set the store policyhttps://memhtml.github.io/learn/operations/set-the-store-policy/
Share one store between a CLI and a serverhttps://memhtml.github.io/learn/operations/share-one-store/
Wire up your coding agenthttps://memhtml.github.io/learn/operations/wire-a-coding-agent/
Write through a sessionhttps://memhtml.github.io/learn/operations/write-through-a-session/
Write your first memoryhttps://memhtml.github.io/learn/tutorial/first-memory/
Retrieve ithttps://memhtml.github.io/learn/tutorial/first-retrieval/
Install memhtml and initialize a storehttps://memhtml.github.io/learn/tutorial/install/
Wire up the MCP serverhttps://memhtml.github.io/learn/tutorial/mcp-server/
Referencehttps://memhtml.github.io/reference/
memhtml agents-dochttps://memhtml.github.io/reference/commands/agents-doc/
memhtml applyhttps://memhtml.github.io/reference/commands/apply/
memhtml archivehttps://memhtml.github.io/reference/commands/archive/
memhtml confighttps://memhtml.github.io/reference/commands/config/
memhtml correcthttps://memhtml.github.io/reference/commands/correct/
memhtml curate collapsehttps://memhtml.github.io/reference/commands/curate-collapse/
memhtml curate mergehttps://memhtml.github.io/reference/commands/curate-merge/
memhtml curate runhttps://memhtml.github.io/reference/commands/curate-run/
memhtml doctorhttps://memhtml.github.io/reference/commands/doctor/
memhtml entity activityhttps://memhtml.github.io/reference/commands/entity-activity/
memhtml eval discriminatehttps://memhtml.github.io/reference/commands/eval-discriminate/
memhtml exechttps://memhtml.github.io/reference/commands/exec/
memhtml head embedhttps://memhtml.github.io/reference/commands/head-embed/
memhtml head searchhttps://memhtml.github.io/reference/commands/head-search/
memhtml head servehttps://memhtml.github.io/reference/commands/head-serve/
memhtml head snapshothttps://memhtml.github.io/reference/commands/head-snapshot/
memhtml head statushttps://memhtml.github.io/reference/commands/head-status/
memhtml helphttps://memhtml.github.io/reference/commands/help/
memhtml hookhttps://memhtml.github.io/reference/commands/hook/
memhtml index embedhttps://memhtml.github.io/reference/commands/index-embed/
memhtml index rebuildhttps://memhtml.github.io/reference/commands/index-rebuild/
memhtml index statushttps://memhtml.github.io/reference/commands/index-status/
memhtml index updatehttps://memhtml.github.io/reference/commands/index-update/
memhtml inithttps://memhtml.github.io/reference/commands/init/
memhtml integrations doctorhttps://memhtml.github.io/reference/commands/integrations-doctor/
memhtml integrations installhttps://memhtml.github.io/reference/commands/integrations-install/
memhtml integrations listhttps://memhtml.github.io/reference/commands/integrations-list/
memhtml integrations shellhttps://memhtml.github.io/reference/commands/integrations-shell/
memhtml integrations uninstallhttps://memhtml.github.io/reference/commands/integrations-uninstall/
memhtml linkhttps://memhtml.github.io/reference/commands/link/
memhtml listhttps://memhtml.github.io/reference/commands/list/
memhtml manifesthttps://memhtml.github.io/reference/commands/manifest/
memhtml neighborshttps://memhtml.github.io/reference/commands/neighbors/
memhtml pathhttps://memhtml.github.io/reference/commands/path/
memhtml publishhttps://memhtml.github.io/reference/commands/publish/
memhtml readhttps://memhtml.github.io/reference/commands/read/
memhtml recallhttps://memhtml.github.io/reference/commands/recall/
memhtml reinforcehttps://memhtml.github.io/reference/commands/reinforce/
memhtml resolvehttps://memhtml.github.io/reference/commands/resolve/
memhtml searchhttps://memhtml.github.io/reference/commands/search/
memhtml serve mcphttps://memhtml.github.io/reference/commands/serve-mcp/
memhtml session commithttps://memhtml.github.io/reference/commands/session-commit/
memhtml session exechttps://memhtml.github.io/reference/commands/session-exec/
memhtml session prunehttps://memhtml.github.io/reference/commands/session-prune/
memhtml session puthttps://memhtml.github.io/reference/commands/session-put/
memhtml session rebasehttps://memhtml.github.io/reference/commands/session-rebase/
memhtml session starthttps://memhtml.github.io/reference/commands/session-start/
memhtml session statushttps://memhtml.github.io/reference/commands/session-status/
memhtml state exporthttps://memhtml.github.io/reference/commands/state-export/
memhtml state importhttps://memhtml.github.io/reference/commands/state-import/
memhtml statushttps://memhtml.github.io/reference/commands/status/
memhtml task addhttps://memhtml.github.io/reference/commands/task-add/
memhtml task listhttps://memhtml.github.io/reference/commands/task-list/
memhtml task statushttps://memhtml.github.io/reference/commands/task-status/
memhtml trace indexhttps://memhtml.github.io/reference/commands/trace-index/
memhtml trace linkshttps://memhtml.github.io/reference/commands/trace-links/
memhtml trace searchhttps://memhtml.github.io/reference/commands/trace-search/
memhtml writehttps://memhtml.github.io/reference/commands/write/
Environment variableshttps://memhtml.github.io/reference/config/
Contractshttps://memhtml.github.io/reference/contracts/
The JSON envelopehttps://memhtml.github.io/reference/envelope/
Error codeshttps://memhtml.github.io/reference/error-codes/
Global flagshttps://memhtml.github.io/reference/global-flags/
The guidehttps://memhtml.github.io/reference/guide/
authoringhttps://memhtml.github.io/reference/guide/authoring/
code-modehttps://memhtml.github.io/reference/guide/code-mode/
conflictshttps://memhtml.github.io/reference/guide/conflicts/
first-callhttps://memhtml.github.io/reference/guide/first-call/
recall-disciplinehttps://memhtml.github.io/reference/guide/recall-discipline/
when-to-batchhttps://memhtml.github.io/reference/guide/when-to-batch/
write-surfaceshttps://memhtml.github.io/reference/guide/write-surfaces/
MCP resourceshttps://memhtml.github.io/reference/mcp-resources/
MCP toolshttps://memhtml.github.io/reference/mcp-tools/
Packageshttps://memhtml.github.io/reference/packages/
Requirementshttps://memhtml.github.io/reference/requirements/
Response typeshttps://memhtml.github.io/reference/response-types/
RRF armshttps://memhtml.github.io/reference/rrf-arms/
Database schema and migrationshttps://memhtml.github.io/reference/schema/
Closed vocabularieshttps://memhtml.github.io/reference/vocabulary/
Overviewhttps://memhtml.github.io/api/
@memhtml/contractshttps://memhtml.github.io/api/contracts/
edgeshttps://memhtml.github.io/api/contracts/edges/
errorshttps://memhtml.github.io/api/contracts/errors/
pathshttps://memhtml.github.io/api/contracts/paths/
slughttps://memhtml.github.io/api/contracts/slug/
typeshttps://memhtml.github.io/api/contracts/types/
@memhtml/traceshttps://memhtml.github.io/api/traces/
@memhtml/evalhttps://memhtml.github.io/api/eval/
@memhtml/domainhttps://memhtml.github.io/api/domain/
@memhtml/llmhttps://memhtml.github.io/api/llm/
@memhtml/headhttps://memhtml.github.io/api/head/
@memhtml/telemetryhttps://memhtml.github.io/api/telemetry/
@memhtml/htmlhttps://memhtml.github.io/api/html/
@memhtml/indexhttps://memhtml.github.io/api/index-package/
@memhtml/sessionhttps://memhtml.github.io/api/session/
@memhtml/integrationshttps://memhtml.github.io/api/integrations/
Internalshttps://memhtml.github.io/internals/
Concurrency and conflictshttps://memhtml.github.io/internals/concurrency-and-conflicts/
Edge encodinghttps://memhtml.github.io/internals/edge-encoding/
Four-arm retrievalhttps://memhtml.github.io/internals/four-arm-retrieval/
The index plane and the state planehttps://memhtml.github.io/internals/index-plane-and-state-plane/
Measured standinghttps://memhtml.github.io/internals/measured-standing/
Packages and dependency directionhttps://memhtml.github.io/internals/packages-and-dependency-direction/
Sessions and the commit pathhttps://memhtml.github.io/internals/sessions-and-the-commit-path/
Store layout and path algebrahttps://memhtml.github.io/internals/store-layout-and-path-algebra/
Testing posturehttps://memhtml.github.io/internals/testing-posture/
The envelope contracthttps://memhtml.github.io/internals/the-envelope-contract/
The extension contracthttps://memhtml.github.io/internals/the-extension-contract/
The indexhttps://memhtml.github.io/internals/the-index/
The memory file formathttps://memhtml.github.io/internals/the-memory-file-format/
The trace indexerhttps://memhtml.github.io/internals/the-trace-indexer/
The write pathhttps://memhtml.github.io/internals/the-write-path/
Glossaryhttps://memhtml.github.io/glossary/
GitHubhttps://github.com/memhtml/memhtml
Overviewhttps://memhtml.github.io/api/#_top
What is coveredhttps://memhtml.github.io/api/#what-is-covered
How to read a pagehttps://memhtml.github.io/api/#how-to-read-a-page
Adding a packagehttps://memhtml.github.io/api/#adding-a-package
Overviewhttps://memhtml.github.io/api/#_top
What is coveredhttps://memhtml.github.io/api/#what-is-covered
How to read a pagehttps://memhtml.github.io/api/#how-to-read-a-page
Adding a packagehttps://memhtml.github.io/api/#adding-a-package
View as Markdownhttps://memhtml.github.io/api.md
Open in ChatGPThttps://chatgpt.com/?q=Read+this+page+of+the+memhtml+documentation%2C+then+answer+questions+about+it.%0AFetch+the+raw+Markdown+rather+than+scraping+the+HTML.%0A%0ATitle%3A+API%0APage%3A+https%3A%2F%2Fmemhtml.github.io%2Fapi%2F%0ARaw+Markdown%3A+https%3A%2F%2Fmemhtml.github.io%2Fapi.md%0A%0A---%0A%0AEvery+page+below+this+one+is+generated+from+the+TSDoc+on+a+package%27s+exported+surface%3B+this+index+is+the+tier%27s+one+authored+page.+The+generated+pages+are+not+committed%3A+%60starlight-typedoc%60+writes+them+into+one+directory+per+package+under+%60api%2F%60+on+every+%60astro+check%60+and+%60astro+build%60%2C+those+directories+are+gitignored%2C+and+so+a+page+always+describes+the+source+at+the+commit+the+site+was+built+from.+When+a+signature+on+a+page+and+a+signature+in+the+source+disagree%2C+the+source+is+newer+and+the+site+is+behind.%0A%0A%23%23+What+is+covered%0A%0A%7C+Package+++++++++++++++++%7C+Pages+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+-----------------------+%7C+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+%7C%0A%7C+%60%40memhtml%2Fcontracts%60++++%7C+%5BOverview%5D%28%2Fapi%2Fcontracts%2F%29+and+one+page+per+import+path%3A+%5Bedges%5D%28%2Fapi%2Fcontracts%2Fedges%2F%29%2C+%5Berrors%5D%28%2Fapi%2Fcontracts%2Ferrors%2F%29%2C+%5Bpaths%5D%28%2Fapi%2Fcontracts%2Fpaths%2F%29%2C+%5Bslug%5D%28%2Fapi%2Fcontracts%2Fslug%2F%29%2C+%5Btypes%5D%28%2Fapi%2Fcontracts%2Ftypes%2F%29.+%7C%0A%7C+%60%40memhtml%2Ftraces%60+++++++%7C+%5BOne+page%5D%28%2Fapi%2Ftraces%2F%29%2C+because+the+package+publishes+a+single+import+path.+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Feval%60+++++++++%7C+%5BOne+page%5D%28%2Fapi%2Feval%2F%29%3A+the+corpus+generator+and+the+discrimination+gate%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fdomain%60+++++++%7C+%5BOne+page%5D%28%2Fapi%2Fdomain%2F%29%3A+the+pure+arithmetic+of+retention%2C+decay%2C+fusion%2C+diversification%2C+merge+guards+and+graph+scores%2C+one+import+path.+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fllm%60++++++++++%7C+%5BOne+page%5D%28%2Fapi%2Fllm%2F%29%3A+the+Bedrock+and+proxy+model+clients%2C+embeddings%2C+the+model+table+and+the+wire+helpers%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fhead%60+++++++++%7C+%5BOne+page%5D%28%2Fapi%2Fhead%2F%29%3A+the+corpus+as+one+immutable+version+per+commit%2C+its+lexical+and+vector+search%2C+and+the+head+gate%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Ftelemetry%60++++%7C+%5BOne+page%5D%28%2Fapi%2Ftelemetry%2F%29%3A+the+opt-in+OTLP+trace+exporter%2C+active+only+when+%60OTEL_EXPORTER_OTLP_ENDPOINT%60+is+set%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fhtml%60+++++++++%7C+%5BOne+page%5D%28%2Fapi%2Fhtml%2F%29%3A+the+memory+file+format%2C+its+parser%2C+serializer%2C+hash%2C+head+editors%2C+template%2C+fence-language+detector+and+closed+vocabulary%2C+one+import+path.+++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Findex%60++++++++%7C+%5BOne+page%5D%28%2Fapi%2Findex-package%2F%29%3A+the+SQLite+schema+and+migrations%2C+the+indexer+that+projects+the+git+tree+into+%60index.db%60%2C+four-arm+retrieval%2C+the+state+plane+and+the+trace+tables%2C+one+import+path.+++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fsession%60++++++%7C+%5BOne+page%5D%28%2Fapi%2Fsession%2F%29%3A+the+session+overlay+log+and+its+lock%2C+the+checkout+lock%2C+the+validator%2C+and+the+commit+path+that+lands+a+session%27s+operations+on+a+ref+as+one+commit%2C+one+import+path.+++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fintegrations%60+%7C+%5BOne+page%5D%28%2Fapi%2Fintegrations%2F%29%3A+what+wires+a+coding+agent+to+a+store+%28its+MCP+entry%2C+hooks%2C+instruction+block%2C+skill+and+install+receipt%29%2C+the+doctor+that+checks+the+wiring%2C+and+uninstall%2C+one+import+path.+++++++++++++%7C%0A%0AEach+package%27s+overview+page+is+its+%60README.md%60+from+the+repository%2C+with+the+module+list+appended+by+the+generator.+The+remaining+workspace+packages+are+added+one+per+maintenance+run%2C+once+their+generated+pages+pass+the+same+gates+as+the+authored+ones.%0A%0A%23%23+How+to+read+a+page%0A%0AEvery+declaration+is+rendered+as+a+fenced+code+block+in+the+shape+TypeScript+would+print+it%2C+followed+by+the+doc+comment+from+the+source.+Parameters+are+listed+one+per+line+rather+than+in+a+table%2C+so+an+object-literal+type+keeps+its+braces+inside+a+code+span.+%22Defined+in%22+lines+are+omitted+on+purpose%3A+the+module+a+symbol+belongs+to+is+the+page+it+sits+on%2C+and+the+%5BReference%5D%28%2Freference%2Fcontracts%2F%29+tier+names+each+symbol%27s+file.%0A%0AThe+generator+excludes+external+symbols%2C+so+a+type+that+comes+from+%60effect%60+is+named+but+not+expanded.+Follow+the+import+path+shown+at+the+top+of+the+page+to+read+it+in+its+own+package.%0A%0A%23%23+Adding+a+package%0A%0AEach+package+is+its+own+%60starlightTypeDoc%60+plugin+instance+in+%60apps%2Fdocs%2Fastro.config.ts%60%2C+writing+to+its+own+directory+under+%60api%2F%60.+The+plugin+refuses+two+instances+whose+output+directories+nest+or+overlap%2C+which+is+why+the+tier+is+one+directory+per+package+rather+than+one+flat+directory.+The+comment+block+above+the+first+instance+records+every+option+and+the+reason+it+is+set.
Open in Claudehttps://claude.ai/new?q=Read+this+page+of+the+memhtml+documentation%2C+then+answer+questions+about+it.%0AFetch+the+raw+Markdown+rather+than+scraping+the+HTML.%0A%0ATitle%3A+API%0APage%3A+https%3A%2F%2Fmemhtml.github.io%2Fapi%2F%0ARaw+Markdown%3A+https%3A%2F%2Fmemhtml.github.io%2Fapi.md%0A%0A---%0A%0AEvery+page+below+this+one+is+generated+from+the+TSDoc+on+a+package%27s+exported+surface%3B+this+index+is+the+tier%27s+one+authored+page.+The+generated+pages+are+not+committed%3A+%60starlight-typedoc%60+writes+them+into+one+directory+per+package+under+%60api%2F%60+on+every+%60astro+check%60+and+%60astro+build%60%2C+those+directories+are+gitignored%2C+and+so+a+page+always+describes+the+source+at+the+commit+the+site+was+built+from.+When+a+signature+on+a+page+and+a+signature+in+the+source+disagree%2C+the+source+is+newer+and+the+site+is+behind.%0A%0A%23%23+What+is+covered%0A%0A%7C+Package+++++++++++++++++%7C+Pages+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+-----------------------+%7C+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+%7C%0A%7C+%60%40memhtml%2Fcontracts%60++++%7C+%5BOverview%5D%28%2Fapi%2Fcontracts%2F%29+and+one+page+per+import+path%3A+%5Bedges%5D%28%2Fapi%2Fcontracts%2Fedges%2F%29%2C+%5Berrors%5D%28%2Fapi%2Fcontracts%2Ferrors%2F%29%2C+%5Bpaths%5D%28%2Fapi%2Fcontracts%2Fpaths%2F%29%2C+%5Bslug%5D%28%2Fapi%2Fcontracts%2Fslug%2F%29%2C+%5Btypes%5D%28%2Fapi%2Fcontracts%2Ftypes%2F%29.+%7C%0A%7C+%60%40memhtml%2Ftraces%60+++++++%7C+%5BOne+page%5D%28%2Fapi%2Ftraces%2F%29%2C+because+the+package+publishes+a+single+import+path.+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Feval%60+++++++++%7C+%5BOne+page%5D%28%2Fapi%2Feval%2F%29%3A+the+corpus+generator+and+the+discrimination+gate%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fdomain%60+++++++%7C+%5BOne+page%5D%28%2Fapi%2Fdomain%2F%29%3A+the+pure+arithmetic+of+retention%2C+decay%2C+fusion%2C+diversification%2C+merge+guards+and+graph+scores%2C+one+import+path.+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fllm%60++++++++++%7C+%5BOne+page%5D%28%2Fapi%2Fllm%2F%29%3A+the+Bedrock+and+proxy+model+clients%2C+embeddings%2C+the+model+table+and+the+wire+helpers%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fhead%60+++++++++%7C+%5BOne+page%5D%28%2Fapi%2Fhead%2F%29%3A+the+corpus+as+one+immutable+version+per+commit%2C+its+lexical+and+vector+search%2C+and+the+head+gate%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Ftelemetry%60++++%7C+%5BOne+page%5D%28%2Fapi%2Ftelemetry%2F%29%3A+the+opt-in+OTLP+trace+exporter%2C+active+only+when+%60OTEL_EXPORTER_OTLP_ENDPOINT%60+is+set%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fhtml%60+++++++++%7C+%5BOne+page%5D%28%2Fapi%2Fhtml%2F%29%3A+the+memory+file+format%2C+its+parser%2C+serializer%2C+hash%2C+head+editors%2C+template%2C+fence-language+detector+and+closed+vocabulary%2C+one+import+path.+++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Findex%60++++++++%7C+%5BOne+page%5D%28%2Fapi%2Findex-package%2F%29%3A+the+SQLite+schema+and+migrations%2C+the+indexer+that+projects+the+git+tree+into+%60index.db%60%2C+four-arm+retrieval%2C+the+state+plane+and+the+trace+tables%2C+one+import+path.+++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fsession%60++++++%7C+%5BOne+page%5D%28%2Fapi%2Fsession%2F%29%3A+the+session+overlay+log+and+its+lock%2C+the+checkout+lock%2C+the+validator%2C+and+the+commit+path+that+lands+a+session%27s+operations+on+a+ref+as+one+commit%2C+one+import+path.+++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fintegrations%60+%7C+%5BOne+page%5D%28%2Fapi%2Fintegrations%2F%29%3A+what+wires+a+coding+agent+to+a+store+%28its+MCP+entry%2C+hooks%2C+instruction+block%2C+skill+and+install+receipt%29%2C+the+doctor+that+checks+the+wiring%2C+and+uninstall%2C+one+import+path.+++++++++++++%7C%0A%0AEach+package%27s+overview+page+is+its+%60README.md%60+from+the+repository%2C+with+the+module+list+appended+by+the+generator.+The+remaining+workspace+packages+are+added+one+per+maintenance+run%2C+once+their+generated+pages+pass+the+same+gates+as+the+authored+ones.%0A%0A%23%23+How+to+read+a+page%0A%0AEvery+declaration+is+rendered+as+a+fenced+code+block+in+the+shape+TypeScript+would+print+it%2C+followed+by+the+doc+comment+from+the+source.+Parameters+are+listed+one+per+line+rather+than+in+a+table%2C+so+an+object-literal+type+keeps+its+braces+inside+a+code+span.+%22Defined+in%22+lines+are+omitted+on+purpose%3A+the+module+a+symbol+belongs+to+is+the+page+it+sits+on%2C+and+the+%5BReference%5D%28%2Freference%2Fcontracts%2F%29+tier+names+each+symbol%27s+file.%0A%0AThe+generator+excludes+external+symbols%2C+so+a+type+that+comes+from+%60effect%60+is+named+but+not+expanded.+Follow+the+import+path+shown+at+the+top+of+the+page+to+read+it+in+its+own+package.%0A%0A%23%23+Adding+a+package%0A%0AEach+package+is+its+own+%60starlightTypeDoc%60+plugin+instance+in+%60apps%2Fdocs%2Fastro.config.ts%60%2C+writing+to+its+own+directory+under+%60api%2F%60.+The+plugin+refuses+two+instances+whose+output+directories+nest+or+overlap%2C+which+is+why+the+tier+is+one+directory+per+package+rather+than+one+flat+directory.+The+comment+block+above+the+first+instance+records+every+option+and+the+reason+it+is+set.
Open in Claude Codehttps://claude.ai/code?prompt=Read+this+page+of+the+memhtml+documentation%2C+then+answer+questions+about+it.%0AFetch+the+raw+Markdown+rather+than+scraping+the+HTML.%0A%0ATitle%3A+API%0APage%3A+https%3A%2F%2Fmemhtml.github.io%2Fapi%2F%0ARaw+Markdown%3A+https%3A%2F%2Fmemhtml.github.io%2Fapi.md%0A%0A---%0A%0AEvery+page+below+this+one+is+generated+from+the+TSDoc+on+a+package%27s+exported+surface%3B+this+index+is+the+tier%27s+one+authored+page.+The+generated+pages+are+not+committed%3A+%60starlight-typedoc%60+writes+them+into+one+directory+per+package+under+%60api%2F%60+on+every+%60astro+check%60+and+%60astro+build%60%2C+those+directories+are+gitignored%2C+and+so+a+page+always+describes+the+source+at+the+commit+the+site+was+built+from.+When+a+signature+on+a+page+and+a+signature+in+the+source+disagree%2C+the+source+is+newer+and+the+site+is+behind.%0A%0A%23%23+What+is+covered%0A%0A%7C+Package+++++++++++++++++%7C+Pages+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+-----------------------+%7C+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+%7C%0A%7C+%60%40memhtml%2Fcontracts%60++++%7C+%5BOverview%5D%28%2Fapi%2Fcontracts%2F%29+and+one+page+per+import+path%3A+%5Bedges%5D%28%2Fapi%2Fcontracts%2Fedges%2F%29%2C+%5Berrors%5D%28%2Fapi%2Fcontracts%2Ferrors%2F%29%2C+%5Bpaths%5D%28%2Fapi%2Fcontracts%2Fpaths%2F%29%2C+%5Bslug%5D%28%2Fapi%2Fcontracts%2Fslug%2F%29%2C+%5Btypes%5D%28%2Fapi%2Fcontracts%2Ftypes%2F%29.+%7C%0A%7C+%60%40memhtml%2Ftraces%60+++++++%7C+%5BOne+page%5D%28%2Fapi%2Ftraces%2F%29%2C+because+the+package+publishes+a+single+import+path.+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Feval%60+++++++++%7C+%5BOne+page%5D%28%2Fapi%2Feval%2F%29%3A+the+corpus+generator+and+the+discrimination+gate%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fdomain%60+++++++%7C+%5BOne+page%5D%28%2Fapi%2Fdomain%2F%29%3A+the+pure+arithmetic+of+retention%2C+decay%2C+fusion%2C+diversification%2C+merge+guards+and+graph+scores%2C+one+import+path.+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fllm%60++++++++++%7C+%5BOne+page%5D%28%2Fapi%2Fllm%2F%29%3A+the+Bedrock+and+proxy+model+clients%2C+embeddings%2C+the+model+table+and+the+wire+helpers%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fhead%60+++++++++%7C+%5BOne+page%5D%28%2Fapi%2Fhead%2F%29%3A+the+corpus+as+one+immutable+version+per+commit%2C+its+lexical+and+vector+search%2C+and+the+head+gate%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Ftelemetry%60++++%7C+%5BOne+page%5D%28%2Fapi%2Ftelemetry%2F%29%3A+the+opt-in+OTLP+trace+exporter%2C+active+only+when+%60OTEL_EXPORTER_OTLP_ENDPOINT%60+is+set%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fhtml%60+++++++++%7C+%5BOne+page%5D%28%2Fapi%2Fhtml%2F%29%3A+the+memory+file+format%2C+its+parser%2C+serializer%2C+hash%2C+head+editors%2C+template%2C+fence-language+detector+and+closed+vocabulary%2C+one+import+path.+++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Findex%60++++++++%7C+%5BOne+page%5D%28%2Fapi%2Findex-package%2F%29%3A+the+SQLite+schema+and+migrations%2C+the+indexer+that+projects+the+git+tree+into+%60index.db%60%2C+four-arm+retrieval%2C+the+state+plane+and+the+trace+tables%2C+one+import+path.+++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fsession%60++++++%7C+%5BOne+page%5D%28%2Fapi%2Fsession%2F%29%3A+the+session+overlay+log+and+its+lock%2C+the+checkout+lock%2C+the+validator%2C+and+the+commit+path+that+lands+a+session%27s+operations+on+a+ref+as+one+commit%2C+one+import+path.+++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fintegrations%60+%7C+%5BOne+page%5D%28%2Fapi%2Fintegrations%2F%29%3A+what+wires+a+coding+agent+to+a+store+%28its+MCP+entry%2C+hooks%2C+instruction+block%2C+skill+and+install+receipt%29%2C+the+doctor+that+checks+the+wiring%2C+and+uninstall%2C+one+import+path.+++++++++++++%7C%0A%0AEach+package%27s+overview+page+is+its+%60README.md%60+from+the+repository%2C+with+the+module+list+appended+by+the+generator.+The+remaining+workspace+packages+are+added+one+per+maintenance+run%2C+once+their+generated+pages+pass+the+same+gates+as+the+authored+ones.%0A%0A%23%23+How+to+read+a+page%0A%0AEvery+declaration+is+rendered+as+a+fenced+code+block+in+the+shape+TypeScript+would+print+it%2C+followed+by+the+doc+comment+from+the+source.+Parameters+are+listed+one+per+line+rather+than+in+a+table%2C+so+an+object-literal+type+keeps+its+braces+inside+a+code+span.+%22Defined+in%22+lines+are+omitted+on+purpose%3A+the+module+a+symbol+belongs+to+is+the+page+it+sits+on%2C+and+the+%5BReference%5D%28%2Freference%2Fcontracts%2F%29+tier+names+each+symbol%27s+file.%0A%0AThe+generator+excludes+external+symbols%2C+so+a+type+that+comes+from+%60effect%60+is+named+but+not+expanded.+Follow+the+import+path+shown+at+the+top+of+the+page+to+read+it+in+its+own+package.%0A%0A%23%23+Adding+a+package%0A%0AEach+package+is+its+own+%60starlightTypeDoc%60+plugin+instance+in+%60apps%2Fdocs%2Fastro.config.ts%60%2C+writing+to+its+own+directory+under+%60api%2F%60.+The+plugin+refuses+two+instances+whose+output+directories+nest+or+overlap%2C+which+is+why+the+tier+is+one+directory+per+package+rather+than+one+flat+directory.+The+comment+block+above+the+first+instance+records+every+option+and+the+reason+it+is+set.
Open in Cursorhttps://cursor.com/link/prompt?text=Read+this+page+of+the+memhtml+documentation%2C+then+answer+questions+about+it.%0AFetch+the+raw+Markdown+rather+than+scraping+the+HTML.%0A%0ATitle%3A+API%0APage%3A+https%3A%2F%2Fmemhtml.github.io%2Fapi%2F%0ARaw+Markdown%3A+https%3A%2F%2Fmemhtml.github.io%2Fapi.md%0A%0A---%0A%0AEvery+page+below+this+one+is+generated+from+the+TSDoc+on+a+package%27s+exported+surface%3B+this+index+is+the+tier%27s+one+authored+page.+The+generated+pages+are+not+committed%3A+%60starlight-typedoc%60+writes+them+into+one+directory+per+package+under+%60api%2F%60+on+every+%60astro+check%60+and+%60astro+build%60%2C+those+directories+are+gitignored%2C+and+so+a+page+always+describes+the+source+at+the+commit+the+site+was+built+from.+When+a+signature+on+a+page+and+a+signature+in+the+source+disagree%2C+the+source+is+newer+and+the+site+is+behind.%0A%0A%23%23+What+is+covered%0A%0A%7C+Package+++++++++++++++++%7C+Pages+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+-----------------------+%7C+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+%7C%0A%7C+%60%40memhtml%2Fcontracts%60++++%7C+%5BOverview%5D%28%2Fapi%2Fcontracts%2F%29+and+one+page+per+import+path%3A+%5Bedges%5D%28%2Fapi%2Fcontracts%2Fedges%2F%29%2C+%5Berrors%5D%28%2Fapi%2Fcontracts%2Ferrors%2F%29%2C+%5Bpaths%5D%28%2Fapi%2Fcontracts%2Fpaths%2F%29%2C+%5Bslug%5D%28%2Fapi%2Fcontracts%2Fslug%2F%29%2C+%5Btypes%5D%28%2Fapi%2Fcontracts%2Ftypes%2F%29.+%7C%0A%7C+%60%40memhtml%2Ftraces%60+++++++%7C+%5BOne+page%5D%28%2Fapi%2Ftraces%2F%29%2C+because+the+package+publishes+a+single+import+path.+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Feval%60+++++++++%7C+%5BOne+page%5D%28%2Fapi%2Feval%2F%29%3A+the+corpus+generator+and+the+discrimination+gate%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fdomain%60+++++++%7C+%5BOne+page%5D%28%2Fapi%2Fdomain%2F%29%3A+the+pure+arithmetic+of+retention%2C+decay%2C+fusion%2C+diversification%2C+merge+guards+and+graph+scores%2C+one+import+path.+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fllm%60++++++++++%7C+%5BOne+page%5D%28%2Fapi%2Fllm%2F%29%3A+the+Bedrock+and+proxy+model+clients%2C+embeddings%2C+the+model+table+and+the+wire+helpers%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fhead%60+++++++++%7C+%5BOne+page%5D%28%2Fapi%2Fhead%2F%29%3A+the+corpus+as+one+immutable+version+per+commit%2C+its+lexical+and+vector+search%2C+and+the+head+gate%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Ftelemetry%60++++%7C+%5BOne+page%5D%28%2Fapi%2Ftelemetry%2F%29%3A+the+opt-in+OTLP+trace+exporter%2C+active+only+when+%60OTEL_EXPORTER_OTLP_ENDPOINT%60+is+set%2C+one+import+path.++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fhtml%60+++++++++%7C+%5BOne+page%5D%28%2Fapi%2Fhtml%2F%29%3A+the+memory+file+format%2C+its+parser%2C+serializer%2C+hash%2C+head+editors%2C+template%2C+fence-language+detector+and+closed+vocabulary%2C+one+import+path.+++++++++++++++++++++++++++++++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Findex%60++++++++%7C+%5BOne+page%5D%28%2Fapi%2Findex-package%2F%29%3A+the+SQLite+schema+and+migrations%2C+the+indexer+that+projects+the+git+tree+into+%60index.db%60%2C+four-arm+retrieval%2C+the+state+plane+and+the+trace+tables%2C+one+import+path.+++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fsession%60++++++%7C+%5BOne+page%5D%28%2Fapi%2Fsession%2F%29%3A+the+session+overlay+log+and+its+lock%2C+the+checkout+lock%2C+the+validator%2C+and+the+commit+path+that+lands+a+session%27s+operations+on+a+ref+as+one+commit%2C+one+import+path.+++++++++++++++++++++++++%7C%0A%7C+%60%40memhtml%2Fintegrations%60+%7C+%5BOne+page%5D%28%2Fapi%2Fintegrations%2F%29%3A+what+wires+a+coding+agent+to+a+store+%28its+MCP+entry%2C+hooks%2C+instruction+block%2C+skill+and+install+receipt%29%2C+the+doctor+that+checks+the+wiring%2C+and+uninstall%2C+one+import+path.+++++++++++++%7C%0A%0AEach+package%27s+overview+page+is+its+%60README.md%60+from+the+repository%2C+with+the+module+list+appended+by+the+generator.+The+remaining+workspace+packages+are+added+one+per+maintenance+run%2C+once+their+generated+pages+pass+the+same+gates+as+the+authored+ones.%0A%0A%23%23+How+to+read+a+page%0A%0AEvery+declaration+is+rendered+as+a+fenced+code+block+in+the+shape+TypeScript+would+print+it%2C+followed+by+the+doc+comment+from+the+source.+Parameters+are+listed+one+per+line+rather+than+in+a+table%2C+so+an+object-literal+type+keeps+its+braces+inside+a+code+span.+%22Defined+in%22+lines+are+omitted+on+purpose%3A+the+module+a+symbol+belongs+to+is+the+page+it+sits+on%2C+and+the+%5BReference%5D%28%2Freference%2Fcontracts%2F%29+tier+names+each+symbol%27s+file.%0A%0AThe+generator+excludes+external+symbols%2C+so+a+type+that+comes+from+%60effect%60+is+named+but+not+expanded.+Follow+the+import+path+shown+at+the+top+of+the+page+to+read+it+in+its+own+package.%0A%0A%23%23+Adding+a+package%0A%0AEach+package+is+its+own+%60starlightTypeDoc%60+plugin+instance+in+%60apps%2Fdocs%2Fastro.config.ts%60%2C+writing+to+its+own+directory+under+%60api%2F%60.+The+plugin+refuses+two+instances+whose+output+directories+nest+or+overlap%2C+which+is+why+the+tier+is+one+directory+per+package+rather+than+one+flat+directory.+The+comment+block+above+the+first+instance+records+every+option+and+the+reason+it+is+set.
Section titled “What is covered”https://memhtml.github.io/api/#what-is-covered
Overviewhttps://memhtml.github.io/api/contracts/
edgeshttps://memhtml.github.io/api/contracts/edges/
errorshttps://memhtml.github.io/api/contracts/errors/
pathshttps://memhtml.github.io/api/contracts/paths/
slughttps://memhtml.github.io/api/contracts/slug/
typeshttps://memhtml.github.io/api/contracts/types/
One pagehttps://memhtml.github.io/api/traces/
One pagehttps://memhtml.github.io/api/eval/
One pagehttps://memhtml.github.io/api/domain/
One pagehttps://memhtml.github.io/api/llm/
One pagehttps://memhtml.github.io/api/head/
One pagehttps://memhtml.github.io/api/telemetry/
One pagehttps://memhtml.github.io/api/html/
One pagehttps://memhtml.github.io/api/index-package/
One pagehttps://memhtml.github.io/api/session/
One pagehttps://memhtml.github.io/api/integrations/
Section titled “How to read a page”https://memhtml.github.io/api/#how-to-read-a-page
Referencehttps://memhtml.github.io/reference/contracts/
Section titled “Adding a package”https://memhtml.github.io/api/#adding-a-package
Edit pagehttps://github.com/memhtml/memhtml/edit/main/apps/docs/src/content/docs/api/index.md
PreviousClosed vocabularieshttps://memhtml.github.io/reference/vocabulary/
Next@memhtml/contractshttps://memhtml.github.io/api/contracts/

Viewport: width=device-width, initial-scale=1

URLs of crawlers that visited me.