[{"data":1,"prerenderedAt":499},["ShallowReactive",2],{"docs-nav":3,"content-query-dwCQyu1AzN":265},[4,8,11,14,17,21,25,29,32,36,40,44,48,52,56,60,63,67,71,75,79,83,87,91,95,99,103,107,111,115,118,121,124,127,130,133,136,139,142,145,148,151,154,157,160,163,166,169,172,175,178,181,184,187,190,193,196,199,202,205,208,211,214,217,220,223,226,229,232,235,238,241,244,247,250,253,256,259,262],{"_path":5,"title":6,"order":7},"/docs/getting-started","Getting Started",1,{"_path":9,"title":10,"order":7},"/docs/views/grid","Grid View",{"_path":12,"title":13,"order":7},"/docs/api/server","Server API",{"_path":15,"title":16,"order":7},"/docs/self-hosting/all-in-one","All-in-One Setup",{"_path":18,"title":19,"order":20},"/docs/core-concepts","Core Concepts",10,{"_path":22,"title":23,"order":24},"/docs/crdt","What is a CRDT?",11,{"_path":26,"title":27,"order":28},"/docs/api/client-http","Client HTTP API",2,{"_path":30,"title":31,"order":28},"/docs/self-hosting/separate-containers","Separate Containers Setup",{"_path":33,"title":34,"order":35},"/docs/interface-overview","Interface Overview",20,{"_path":37,"title":38,"order":39},"/docs/global-search","Global Search",22,{"_path":41,"title":42,"order":43},"/docs/filters","Filters",24,{"_path":45,"title":46,"order":47},"/docs/sorting","Sorting",25,{"_path":49,"title":50,"order":51},"/docs/tagging-and-selection","Tagging & Selection",26,{"_path":53,"title":54,"order":55},"/docs/quick-view","Quick View",28,{"_path":57,"title":58,"order":59},"/docs/api/cli","CLI",3,{"_path":61,"title":62,"order":59},"/docs/self-hosting/remote-access-tailscale","Remote Access with Tailscale",{"_path":64,"title":65,"order":66},"/docs/block-actions","Block Actions",30,{"_path":68,"title":69,"order":70},"/docs/deleting-blocks","Deleting Blocks & Trash",32,{"_path":72,"title":73,"order":74},"/docs/self-hosting","Self-Hosting",4,{"_path":76,"title":77,"order":78},"/docs/managing-heaps","Managing Heaps",40,{"_path":80,"title":81,"order":82},"/docs/file-scanning","File Scanning & Importing",42,{"_path":84,"title":85,"order":86},"/docs/storage-management","Storage Management",44,{"_path":88,"title":89,"order":90},"/docs/daily-notes","Daily Notes & Calendar",46,{"_path":92,"title":93,"order":94},"/docs/api","API",5,{"_path":96,"title":97,"order":98},"/docs/views","Views",60,{"_path":100,"title":101,"order":102},"/docs/authentication","Authentication & User Management",70,{"_path":104,"title":105,"order":106},"/docs/licenses-privacy","Licenses & Privacy",72,{"_path":108,"title":109,"order":110},"/docs/faq","FAQ",80,{"_path":112,"title":113,"order":114},"/docs/changelog","Changelog",99,{"_path":116,"title":117},"/docs/changelog/v16.16.37","v16.16.37",{"_path":119,"title":120},"/docs/changelog/v16.16.38","v16.16.38",{"_path":122,"title":123},"/docs/changelog/v16.11.0","v16.11.0",{"_path":125,"title":126},"/docs/changelog/v16.16.29","v16.16.29",{"_path":128,"title":129},"/docs/changelog/v16.16.28","v16.16.28",{"_path":131,"title":132},"/docs/changelog/v16.16.1","v16.16.1",{"_path":134,"title":135},"/docs/changelog/v16.10.0","v16.10.0",{"_path":137,"title":138},"/docs/changelog/v16.16.8","v16.16.8",{"_path":140,"title":141},"/docs/changelog/v16.7.0","v16.7.0",{"_path":143,"title":144},"/docs/changelog/v16.16.14","v16.16.14",{"_path":146,"title":147},"/docs/changelog/v16.16.7","v16.16.7",{"_path":149,"title":150},"/docs/changelog/v16.16.36","v16.16.36",{"_path":152,"title":153},"/docs/changelog/v16.16.32","v16.16.32",{"_path":155,"title":156},"/docs/changelog/v16.16.41","v16.16.41",{"_path":158,"title":159},"/docs/changelog/v16.6.0","v16.6.0",{"_path":161,"title":162},"/docs/changelog/v16.16.4","v16.16.4",{"_path":164,"title":165},"/docs/changelog/v16.16.0","v16.16.0",{"_path":167,"title":168},"/docs/changelog/v16.16.40","v16.16.40",{"_path":170,"title":171},"/docs/changelog/v16.16.20","v16.16.20",{"_path":173,"title":174},"/docs/changelog/v16.16.16","v16.16.16",{"_path":176,"title":177},"/docs/changelog/v16.16.25","v16.16.25",{"_path":179,"title":180},"/docs/changelog/v16.16.17","v16.16.17",{"_path":182,"title":183},"/docs/changelog/v16.17.8","v16.17.8",{"_path":185,"title":186},"/docs/changelog/v16.16.33","v16.16.33",{"_path":188,"title":189},"/docs/changelog/v16.16.22","v16.16.22",{"_path":191,"title":192},"/docs/changelog/v16.16.23","v16.16.23",{"_path":194,"title":195},"/docs/changelog/v16.16.35","v16.16.35",{"_path":197,"title":198},"/docs/changelog/v16.16.24","v16.16.24",{"_path":200,"title":201},"/docs/changelog/v16.16.5","v16.16.5",{"_path":203,"title":204},"/docs/changelog/v16.16.11","v16.16.11",{"_path":206,"title":207},"/docs/changelog/v16.16.27","v16.16.27",{"_path":209,"title":210},"/docs/changelog/v16.16.19","v16.16.19",{"_path":212,"title":213},"/docs/changelog/v16.16.13","v16.16.13",{"_path":215,"title":216},"/docs/changelog/v16.16.3","v16.16.3",{"_path":218,"title":219},"/docs/changelog/v16.9.0","v16.9.0",{"_path":221,"title":222},"/docs/changelog/v16.16.43","v16.16.43",{"_path":224,"title":225},"/docs/changelog/v16.16.2","v16.16.2",{"_path":227,"title":228},"/docs/changelog/v16.16.18","v16.16.18",{"_path":230,"title":231},"/docs/changelog/v16.16.30","v16.16.30",{"_path":233,"title":234},"/docs/changelog/v16.16.21","v16.16.21",{"_path":236,"title":237},"/docs/changelog/v16.16.26","v16.16.26",{"_path":239,"title":240},"/docs/changelog/v16.16.6","v16.16.6",{"_path":242,"title":243},"/docs/changelog/v16.16.31","v16.16.31",{"_path":245,"title":246},"/docs/changelog/v16.16.39","v16.16.39",{"_path":248,"title":249},"/docs/changelog/v16.16.34","v16.16.34",{"_path":251,"title":252},"/docs/changelog/v16.16.12","v16.16.12",{"_path":254,"title":255},"/docs/changelog/v16.8.0","v16.8.0",{"_path":257,"title":258},"/docs/changelog/v16.16.10","v16.16.10",{"_path":260,"title":261},"/docs/changelog/v16.16.9","v16.16.9",{"_path":263,"title":264},"/docs/changelog/v16.16.15","v16.16.15",{"_path":92,"_dir":266,"_draft":267,"_partial":267,"_locale":268,"title":93,"description":269,"order":94,"body":270,"_type":493,"_id":494,"_source":495,"_file":496,"_stem":497,"_extension":498},"docs",false,"","Developer docs for Heaper's server API, local client HTTP API, and CLI.",{"type":271,"children":272,"toc":488},"root",[273,282,288,295,342,348,452,458],{"type":274,"tag":275,"props":276,"children":278},"element","h1",{"id":277},"heaper-api-docs",[279],{"type":280,"value":281},"text","Heaper API Docs",{"type":274,"tag":283,"props":284,"children":285},"p",{},[286],{"type":280,"value":287},"These pages are for developers building things with or on top of Heaper.\nThey currently only cover the API's not yet the in beta plugin interfaces for building custom code into the heaper apps or server.",{"type":274,"tag":289,"props":290,"children":292},"h2",{"id":291},"pick-the-right-surface",[293],{"type":280,"value":294},"Pick the Right Surface",{"type":274,"tag":296,"props":297,"children":298},"ul",{},[299,316,329],{"type":274,"tag":300,"props":301,"children":302},"li",{},[303,305,314],{"type":280,"value":304},"Use the ",{"type":274,"tag":306,"props":307,"children":308},"strong",{},[309],{"type":274,"tag":310,"props":311,"children":312},"a",{"href":12},[313],{"type":280,"value":13},{"type":280,"value":315}," when you want to talk to a self-hosted or remote Heaper server over HTTP.",{"type":274,"tag":300,"props":317,"children":318},{},[319,320,327],{"type":280,"value":304},{"type":274,"tag":306,"props":321,"children":322},{},[323],{"type":274,"tag":310,"props":324,"children":325},{"href":26},[326],{"type":280,"value":27},{"type":280,"value":328}," when you want to automate the Electron desktop app running on the same machine but focus on local first (offline capable automations).",{"type":274,"tag":300,"props":330,"children":331},{},[332,333,340],{"type":280,"value":304},{"type":274,"tag":306,"props":334,"children":335},{},[336],{"type":274,"tag":310,"props":337,"children":338},{"href":57},[339],{"type":280,"value":58},{"type":280,"value":341}," when you want terminal-friendly access without writing HTTP calls yourself, likely AI useage for claude code or codex to access your data.",{"type":274,"tag":289,"props":343,"children":345},{"id":344},"at-a-glance",[346],{"type":280,"value":347},"At a Glance",{"type":274,"tag":349,"props":350,"children":351},"table",{},[352,381],{"type":274,"tag":353,"props":354,"children":355},"thead",{},[356],{"type":274,"tag":357,"props":358,"children":359},"tr",{},[360,366,371,376],{"type":274,"tag":361,"props":362,"children":363},"th",{},[364],{"type":280,"value":365},"Surface",{"type":274,"tag":361,"props":367,"children":368},{},[369],{"type":280,"value":370},"Best for",{"type":274,"tag":361,"props":372,"children":373},{},[374],{"type":280,"value":375},"Transport",{"type":274,"tag":361,"props":377,"children":378},{},[379],{"type":280,"value":380},"Auth",{"type":274,"tag":382,"props":383,"children":384},"tbody",{},[385,408,430],{"type":274,"tag":357,"props":386,"children":387},{},[388,393,398,403],{"type":274,"tag":389,"props":390,"children":391},"td",{},[392],{"type":280,"value":13},{"type":274,"tag":389,"props":394,"children":395},{},[396],{"type":280,"value":397},"Remote integrations, self-hosted tooling, custom clients",{"type":274,"tag":389,"props":399,"children":400},{},[401],{"type":280,"value":402},"HTTPS + WebSocket",{"type":274,"tag":389,"props":404,"children":405},{},[406],{"type":280,"value":407},"Server-issued bearer token",{"type":274,"tag":357,"props":409,"children":410},{},[411,415,420,425],{"type":274,"tag":389,"props":412,"children":413},{},[414],{"type":280,"value":27},{"type":274,"tag":389,"props":416,"children":417},{},[418],{"type":280,"value":419},"Desktop automation, local scripts, local integrations",{"type":274,"tag":389,"props":421,"children":422},{},[423],{"type":280,"value":424},"Localhost HTTP",{"type":274,"tag":389,"props":426,"children":427},{},[428],{"type":280,"value":429},"Local API bearer token",{"type":274,"tag":357,"props":431,"children":432},{},[433,437,442,447],{"type":274,"tag":389,"props":434,"children":435},{},[436],{"type":280,"value":58},{"type":274,"tag":389,"props":438,"children":439},{},[440],{"type":280,"value":441},"Shell workflows, quick inspection, scripting",{"type":274,"tag":389,"props":443,"children":444},{},[445],{"type":280,"value":446},"CLI wrapper over local HTTP API",{"type":274,"tag":389,"props":448,"children":449},{},[450],{"type":280,"value":451},"Same local API bearer token",{"type":274,"tag":289,"props":453,"children":455},{"id":454},"references",[456],{"type":280,"value":457},"References",{"type":274,"tag":296,"props":459,"children":460},{},[461,470,479],{"type":274,"tag":300,"props":462,"children":463},{},[464],{"type":274,"tag":310,"props":465,"children":467},{"href":466},"/docs/api/server-reference",[468],{"type":280,"value":469},"Server API Reference",{"type":274,"tag":300,"props":471,"children":472},{},[473],{"type":274,"tag":310,"props":474,"children":476},{"href":475},"/docs/api/client-http-reference",[477],{"type":280,"value":478},"Client HTTP API Reference",{"type":274,"tag":300,"props":480,"children":481},{},[482],{"type":274,"tag":310,"props":483,"children":485},{"href":484},"/docs/api/cli-reference",[486],{"type":280,"value":487},"CLI Reference",{"title":268,"searchDepth":28,"depth":28,"links":489},[490,491,492],{"id":291,"depth":28,"text":294},{"id":344,"depth":28,"text":347},{"id":454,"depth":28,"text":457},"markdown","content:docs:api:index.md","content","docs/api/index.md","docs/api/index","md",1777640557759]