Heaper API Docs
These pages are for developers building things with or on top of Heaper. They currently only cover the API's not yet the in beta plugin interfaces for building custom code into the heaper apps or server.
Pick the Right Surface
- Use the Server API when you want to talk to a self-hosted or remote Heaper server over HTTP.
- Use the Client HTTP API when you want to automate the Electron desktop app running on the same machine but focus on local first (offline capable automations).
- Use the CLI when you want terminal-friendly access without writing HTTP calls yourself, likely AI useage for claude code or codex to access your data.
At a Glance
| Surface | Best for | Transport | Auth |
|---|---|---|---|
| Server API | Remote integrations, self-hosted tooling, custom clients | HTTPS + WebSocket | Server-issued bearer token |
| Client HTTP API | Desktop automation, local scripts, local integrations | Localhost HTTP | Local API bearer token |
| CLI | Shell workflows, quick inspection, scripting | CLI wrapper over local HTTP API | Same local API bearer token |