PinMark

Create a new text note in PinMark. Content is Markdown. Alternatively create it from a template (template id from list_templates); a template cannot be combined with content. The note is not put on the desktop unless open is true (or pin_note is called later); isPinned in the result tells. Returns the new note.

Create an image note in PinMark from an image file on this Mac (PNG, JPEG, HEIC, GIF, …). The file is copied into PinMark; the original is not changed. The note is not put on the desktop unless open is true (or pin_note is called later); isPinned in the result tells.

Append Markdown text to an existing text note (e.g. to maintain a running log). Does not act on notes in the trash.

Update an existing note. Provide at least one of content, color, paper (text notes), title, or caption (image notes). content replaces the whole body: start from get_note's content (verbatim Markdown, including pinmark-asset:/// addresses), never from visibleText or preview. Does not act on notes in the trash.

Fetch one note by id. Text notes return content (verbatim Markdown; base edits on it), visibleText (readable text for reading only) and assets (embedded images and drawings). Image notes return the caption and, by default, the image itself as image content; a long image comes in overlapping tiles, a few per call — continue with imageOffset = imageInfo.nextOffset.

List notes. Excludes the trash unless includeTrash is set. Results are sorted by last edit time (newest first, ties by noteId) and paged with offset/limit; page tells whether more remain. Paging is not a snapshot: notes edited, added or deleted between calls can shift results, and since is a filter, not a sync cursor.

Search notes by title, content, caption, or image filename. Results are sorted by last edit time (newest first, ties by noteId) and paged with offset/limit; page tells whether more remain. Paging is not a snapshot: notes edited, added or deleted between calls can shift results, and since is a filter, not a sync cursor.

List the note templates in PinMark, for create_note's template parameter. usable tells whether the current plan allows a template.

無需輸入參數。

Move a note to the trash. Recoverable with restore_note; not a permanent delete. Idempotent.

Restore a note from the trash.

Pin a note to the desktop: show it as a note window on the desktop. Idempotent. This is not 'float on top' (a separate window setting in the app). The result's isPinned tells whether the note is on the desktop.

Unpin a note from the desktop: close its desktop window. The note stays in the workspace. Idempotent; fails with unpin_blocked if the note could not be saved and stays on the desktop.

Bring a note to the foreground on the desktop (this one intentionally activates PinMark).