Skip to content
Engram Docs
Search
Ctrl
K
Cancel
GitHub
Discord
Select theme
Dark
Light
Auto
Menu
Getting Started
Why Engram
Feature list
Compare
Obsidian Plugin
Obsidian Plugin
Install
First Sync
Sync Center
Conflicts
Mobile
Troubleshooting
Web App
Web App
Onboarding
Browser
Editor
Search
AI Integrations
AI Integrations
Connect Engram to your AI
Claude Desktop
Claude Code
Cursor
ChatGPT
Meta Muse
Windsurf
GitHub Copilot
Cline
OpenCode
Open WebUI
Continue
LobeChat
Grok (xAI API)
Mistral (Le Chat)
Antigravity
Gemini
Devin
MCP
About MCP
MCP Config
Tools
Scopes
Troubleshooting
API Reference
Overview
Notes
Overview
Append text to a note (creating it if absent)
Rename / move a note
Get a note by path
Delete a note by path
Create or update a note
Retired timestamp change feed
Get backlinks for a note
Move notes to a folder (idempotent)
Delete notes by id (idempotent)
Get a note by id
Delete a note by id
Folders
Overview
Create many folders
List folders
Create a folder
Rename / move a folder
Move folders under a new parent (idempotent)
Delete a folder by path
List notes in a folder (metadata only)
List notes in a folder by id (metadata only)
List explicitly-created (empty-capable) folders
Delete folders by id (idempotent)
Search
Overview
Search notes (vector / keyword / hybrid)
Tags
Overview
List all tags in the vault
Vaults
Overview
List vaults
Register or fetch a vault by client_id (idempotent)
Restore a soft-deleted vault
Permanently purge a vault
Get a vault by id
Soft-delete a vault
Update a vault
Get the whole vault tree in one read
Account
Overview
Get storage usage and caps
Get the current user
Delete the current user's account
Update the current user's profile
Attachments
Overview
Retired timestamp change feed
Delete attachments by path (idempotent)
Get an attachment
Delete an attachment
Move attachments to a folder (idempotent)
Rename / move an attachment
List attachments (metadata only)
Upload an attachment
Sync
Overview
Get the full vault manifest
Check whether the server still owes this vault sync work
API Keys
Overview
Revoke an API key
List API keys
Create an API key
Connections
Overview
Revoke an OAuth client connection
Change an OAuth connection's vault access
Revoke a device connection
Create a personal access token
Revoke a personal access token
Change a personal access token's vault access
List active connections
Types
List all OKF types in the vault
Self-Host
Self-Host
Why Self-Host
Architecture
Quickstart
Environment Variables
Encryption Setup
Backup & Restore
Upgrade Path
Troubleshooting
Usage statistics
Billing
Billing
Tiers
Upgrade & Downgrade
Refund & Cancel
Concepts
Concepts
Semantic Search
Encryption Model
Sync Algorithm
File Types
Open Knowledge Format
Remote vs local MCP
Changelog
GitHub
Discord
Select theme
Dark
Light
Auto
Vaults API
Vaults
Section titled “Vaults”
Create, manage, soft-delete, restore, and purge vaults.
Operations
Section titled “Operations”
GET
/vaults
POST
/vaults/register
POST
/vaults/{id}/restore
POST
/vaults/{id}/purge
GET
/vaults/{id}
DELETE
/vaults/{id}
PATCH
/vaults/{id}
GET
/vault/tree