Skip To Main Content
All modules

Notes

Fields marked * are required. Updates keep every field they are not given. An AI app can ask vritto_describe for the same details, filtered to what its connection may use.

Notenote

A note, meeting note, idea, decision, or reference. The same operations reach the notebooks that file notes (type 'notebook').

notes_findFindthrough vritto_find

Read Notes: search notes by free text, kind, notebook, tag or linked record, most recently updated first, one note by id, or type 'notebook' for the notebooks with their note counts. ALWAYS pass from/to (updated dates) when the question concerns a period. Compact rows unless detail is 'full'.

FieldTypeDescription
typeone of note, notebook'note' (default) or 'notebook' (lists notebooks; includeArchived for archived ones).
idstringReturn just this note.
noteIdstringOlder name for id.
querystringSearch text.
kindone of note, daily, meeting, decision, idea, reference
notebookstringNotebook name filter.
notebookIdstringOnly notes filed in this notebook.
tagstringExact tag filter.
fromstringOnly notes updated ON or AFTER this YYYY-MM-DD date.
tostringOnly notes updated ON or BEFORE this YYYY-MM-DD date.
updatedFromstringOlder name for from.
updatedTostringOlder name for to.
linkedModuleIdstringOnly notes linked to records of this module.
linkedEntityIdstringOnly notes linked to this record ID.
viewone of active, archived, trash"active" (default), "archived", or "trash" (notes deleted in the last 30 days).
includeArchivedbooleanInclude archived notes (or notebooks) alongside active ones; default false.
detailone of summary, full"summary" (default, id/title/excerpt/tags/updatedAt/checklistCount) or "full" (every field incl. the complete body and checklist).
limitintegerMax records (default 50 in summary mode).
Example input
{
  "query": "kitchen"
}
notes_addCreatethrough vritto_create

Add a note for durable context, meeting notes, ideas, decisions, references, or freeform capture: a title, plus body (HTML or plain text), kind, notebook, tags, checklist and linked records from the user's words. type 'notebook' adds a notebook (a name already on file returns it).

FieldTypeDescription
typeone of note, notebook'note' (default) or 'notebook'.
recordobjectThe note (title required) or, with type 'notebook', the notebook (name required).
record.titlestringNote title.
record.bodystringNote body as HTML or plain text. Write ordinary prose markup (p, h1-h3, ul/ol, blockquote, pre/code, tables, and task lists via <ul data-type="taskList">); it is converted to the note's rich document server-side.
record.kindone of note, daily, meeting, decision, idea, referenceNote kind (default 'note').
record.statusone of active, archived, deletedNote lifecycle status (default 'active'). Set 'archived' to archive a note without deleting it.
record.notebookstringNotebook or collection name.
record.tagslist of stringTags.
record.linkedRefslist of objectLinked module records this note references.
record.sourceRefslist of objectModule records this note was captured from (its provenance).
record.checklistlist of objectChecklist edits addressed BY ID: pass {id, done} to tick or untick an existing item, {id, title} to rename it. Read the ids with notes_find first. Items live inside the note body, so add new ones by writing the body, not here.
record.notebookIdstringNotebook ID; prefer this over the name when known.
record.pinnedbooleanPinned note.
record.favoritebooleanFavorite note.
record.aiContextEnabledbooleanAvailable to SahAI context retrieval (default true).
record.idempotencyKeystringStable dedupe key.
record.namestringType 'notebook': its name. Required when adding one.
record.accentintegerType 'notebook': accent colour index.
noteobjectOlder form of record (notes_createNote).
note.titlestring
notebookobjectOlder form (notes_createNotebook): the notebook.
notebook.namestring
Example input
{
  "record": {
    "title": "Kitchen remodel ideas",
    "body": "Open shelving, warmer lighting, move the fridge.",
    "kind": "idea",
    "tags": [
      "home"
    ]
  }
}
notes_changeUpdatethrough vritto_update

Change one note by record.id: sent fields change, others are kept. Pin, favorite, archive (status 'archived'), tick a checklist item by id, or bring a deleted note back from Trash (status 'active'). type 'notebook' renames a notebook or changes its accent.

Note: Archive with status 'archived'; status 'active' brings a note back from Trash.

FieldTypeDescription
typeone of note, notebook'note' (default) or 'notebook'.
recordobjectThe record's id plus the fields to change.
record.titlestringNote title.
record.bodystringNote body as HTML or plain text. Write ordinary prose markup (p, h1-h3, ul/ol, blockquote, pre/code, tables, and task lists via <ul data-type="taskList">); it is converted to the note's rich document server-side.
record.kindone of note, daily, meeting, decision, idea, referenceNote kind (default 'note').
record.statusone of active, archived, deletedNote lifecycle status (default 'active'). Set 'archived' to archive a note without deleting it.
record.notebookstringNotebook or collection name.
record.tagslist of stringTags.
record.linkedRefslist of objectLinked module records this note references.
record.sourceRefslist of objectModule records this note was captured from (its provenance).
record.checklistlist of objectChecklist edits addressed BY ID: pass {id, done} to tick or untick an existing item, {id, title} to rename it. Read the ids with notes_find first. Items live inside the note body, so add new ones by writing the body, not here.
record.notebookIdstringNotebook ID; prefer this over the name when known.
record.pinnedbooleanPinned note.
record.favoritebooleanFavorite note.
record.aiContextEnabledbooleanAvailable to SahAI context retrieval (default true).
record.idempotencyKeystringStable dedupe key.
record.id*stringThe note (or notebook) to change.
record.namestringType 'notebook': its name. Required when adding one.
record.accentintegerType 'notebook': accent colour index.
expectedRevisionintegerRevision guard from the last read.
noteIdstringOlder form: the note, with patch (notes_patchNote) or alone to restore it (notes_restoreNote).
patchobjectOlder form, with noteId or notebookId: the fields to change.
patch.aiContextEnabledboolean
noteobjectOlder form (notes_updateNote): the note's fields with its id.
note.idstring
note.aiContextEnabledboolean
notebookIdstringOlder form (notes_patchNotebook): the notebook, with patch.
Example input
{
  "record": {
    "id": "note_kitchen",
    "pinned": true
  }
}
notes_removeDeletethrough vritto_delete

Move one note to Trash, where it stays recoverable for 30 days, or (type 'notebook') delete a notebook and move its notes elsewhere (Inbox by default; notes are never deleted). Only for explicit deletion requests.

Note: Moves the note to trash, recoverable for 30 days. type 'notebook' deletes a notebook; its notes move to the Inbox.

FieldTypeDescription
typeone of note, notebook'note' (default) or 'notebook'.
idstringThe note (or notebook) to delete.
expectedRevisionintegerRevision guard from the last read.
moveToNotebookIdstringType 'notebook': where its notes go; defaults to Inbox.
noteIdstringOlder name for id (a note).
notebookIdstringOlder name for id (a notebook).