URL Schemes

The antinote:// URL schemes for creating, opening and exporting notes from scripts, Shortcuts, Raycast, Alfred, or the terminal.

Updated for v2.0

URL Schemes

Design Intent: Antinote supports a few URL schemes to help you control Antinote from other apps.
  • Make sure to percent-encode the value of your parameters.
  • Open Antinote
    antinote://
  • Create a new note
    antinote://x-callback-url/createNote?content=My%20Note
  • Append to current note
    antinote://x-callback-url/appendToCurrent?content=My%20Note
  • Overwrite current note
    antinote://x-callback-url/overwriteCurrent?content=My%20Note
  • Promote and open a note
    antinote://x-callback-url/promoteAndOpen?noteId=123
    The noteId can be found in the SQLite DB or by using the search endpoint.
  • Toggle pinned status
    antinote://x-callback-url/togglePin
  • Trigger global hotkey
    antinote://x-callback-url/hotkey
  • Search notes
    antinote://x-callback-url/search?searchTerm=My%20Search%20Term&x-success=your-callback-url
    Will send the following in the callback as serialized JSON:
    [ "id": UUID, "content": String, "lastModified": String ]
  • Reload DB (Advanced) - for when your script is altering the SQLite DB directly and want those changes to reflect in Antinote.
    antinote://x-callback-url/reloadDB