API Key
🗒️ Apple Notes
Read, search and write Apple Notes on your Mac from anywhere.
What you can do
- List folders and notes, and search note titles and text
- Read a note as Markdown, plain text or HTML
- Create notes from Markdown, HTML or text, from a file or a pipe
- Rename a note, replace its body, move it to another folder, or delete it
Setup
Run apple-notes-api on the Mac that has Notes, then:
agentio notes profile add --url https://mac-mini.example.ts.net
agentio asks for the API key the server printed when it was installed.
Good to know
- Note ids look like
x-coredata://…. Quote them in the shell. update --bodyreplaces the whole body. Read the note first if you want to keep any of it. A new body turns checklists into plain lists, losing which items are ticked; moving a note with--folderalone leaves its body untouched.deletemoves the note to Recently Deleted, where Notes keeps it for 30 days.- A folder is found by its name, so two accounts with a folder of the same name are ambiguous.
- Locked notes cannot be read or changed.
getshows which checklist items are ticked (- [x]) when the server has Full Disk Access on the Mac. Ticking items is not possible.
Command reference
-
agentio notes foldersList folders, with the account each belongs to
--profile <name>--json -
agentio notes listList notes (title, folder, dates), without their bodies
--profile <name>--json--folder <name>--limit <n> -
agentio notes search <query>Find notes whose title or text contains a phrase (case does not matter)
--profile <name>--json--folder <name>--limit <n> -
agentio notes get <id>Read a note
--profile <name>--json--format <format> -
agentio notes createCreate a note
--profile <name>--json--title <title>--body <text>--file <path>--format <format>--folder <name> -
agentio notes update <id>Change a note's title, replace its body, or move it to another folder
--profile <name>--json--title <title>--body <text>--file <path>--format <format>--folder <name> -
agentio notes delete <id>Move a note to Recently Deleted
--profile <name>--json