Alpha: Document API is currently alpha and subject to breaking changes.Back to full reference Primary read and write operations.
Core operations
Core operation reference from the canonical Document API contract.
Was this page helpful?
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Core operation reference from the canonical Document API contract.
Alpha: Document API is currently alpha and subject to breaking changes.Back to full reference Primary read and write operations.
| Operation | Member path | Mutates | Idempotency | Tracked | Dry run |
|---|---|---|---|---|---|
get | get | No | idempotent | No | No |
find | find | No | idempotent | No | No |
getNode | getNode | No | idempotent | No | No |
getNodeById | getNodeById | No | idempotent | No | No |
getText | getText | No | idempotent | No | No |
getMarkdown | getMarkdown | No | idempotent | No | No |
getHtml | getHtml | No | idempotent | No | No |
markdownToFragment | markdownToFragment | No | idempotent | No | No |
info | info | No | idempotent | No | No |
clearContent | clearContent | Yes | conditional | No | No |
insert | insert | Yes | non-idempotent | Yes | Yes |
replace | replace | Yes | conditional | Yes | Yes |
delete | delete | Yes | conditional | Yes | Yes |
Was this page helpful?