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.

notes_getNoteFindthrough vritto_find

Fetch one note by its ID. Requires a real noteId; use notes_queryNotes first when the ID is unknown.

FieldTypeDescription
noteId*stringNote ID.
notes_queryNotesFindthrough vritto_find

Search notes by free text, kind, notebook, tag, or linked module record. Results are ordered by most recently updated. Supports an updated-date range, ALWAYS pass updatedFrom/updatedTo when the question concerns a period (a year, a month, 'recently'). Rows are compact summaries; pass detail 'full' or fetch one note with notes_getNote when the user needs the full body.

FieldTypeDescription
querystringSearch query.
kindone of note, daily, meeting, decision, idea, reference
notebookstringNotebook filter.
tagstringExact tag filter.
updatedFromstringOnly notes updated ON or AFTER this YYYY-MM-DD date.
updatedTostringOnly notes updated ON or BEFORE this YYYY-MM-DD date.
linkedModuleIdstringOnly notes linked to records of this module.
linkedEntityIdstringOnly notes linked to this record ID.
notebookIdstringOnly notes filed in this notebook.
viewone of active, archived, trashWhich slice to read: "active" (default), "archived", or "trash" (notes deleted in the last 30 days).
includeArchivedbooleanInclude archived notes alongside active ones; default false.
detailone of summary, fullRow shape: "summary" (default, id/title/excerpt/tags/updatedAt/checklistCount) or "full" (every field incl. the complete body and checklist).
limitintegerMax records to return (default 50 in summary mode).
notes_createNoteCreatethrough vritto_create

Create a note for durable context, meeting notes, ideas, decisions, references, or freeform capture. Preserve title, body (HTML or plain text), kind, notebook, tags, checklist, and linked records from the user's words. Example: title 'Meeting notes', body 'Decisions...', kind 'meeting', tags ['work'].

FieldTypeDescription
note*objectNote fields; title is required.
note.title*stringNote title.
note.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.
note.kindone of note, daily, meeting, decision, idea, referenceNote kind (default 'note').
note.statusone of active, archived, deletedNote lifecycle status (default 'active'). Set 'archived' to archive a note without deleting it.
note.notebookstringNotebook or collection name.
note.tagslist of stringTags.
note.linkedRefslist of objectLinked module records this note references.
note.sourceRefslist of objectModule records this note was captured from (its provenance).
note.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 from getNote or queryNotes first. Items live inside the note body, so add new ones by writing the body, not here.
note.notebookIdstringNotebook ID; prefer this over the name when known.
note.pinnedbooleanPinned note.
note.favoritebooleanFavorite note.
note.aiContextEnabledbooleanAvailable to SahAI context retrieval (default true).
note.idempotencyKeystringStable dedupe key.
Example input
{
  "note": {
    "title": "Kitchen remodel ideas",
    "body": "Open shelving, warmer lighting, move the fridge.",
    "kind": "idea",
    "tags": [
      "home"
    ]
  }
}
notes_patchNoteUpdatethrough vritto_update

Apply a partial update to one note; only the fields present in patch change. Requires noteId; pass expectedRevision to guard against concurrent edits.

FieldTypeDescription
noteId*stringNote ID.
patch*objectFields to change.
patch.titlestringNote title.
patch.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.
patch.kindone of note, daily, meeting, decision, idea, referenceNote kind (default 'note').
patch.statusone of active, archived, deletedNote lifecycle status (default 'active'). Set 'archived' to archive a note without deleting it.
patch.notebookstringNotebook or collection name.
patch.tagslist of stringTags.
patch.linkedRefslist of objectLinked module records this note references.
patch.sourceRefslist of objectModule records this note was captured from (its provenance).
patch.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 from getNote or queryNotes first. Items live inside the note body, so add new ones by writing the body, not here.
patch.notebookIdstringNotebook ID; prefer this over the name when known.
patch.pinnedbooleanPinned note.
patch.favoritebooleanFavorite note.
patch.aiContextEnabledbooleanAvailable to SahAI context retrieval (default true).
patch.idempotencyKeystringStable dedupe key.
expectedRevisionintegerRevision guard from the last read.
Example input
{
  "noteId": "note_kitchen",
  "patch": {
    "pinned": true
  }
}
notes_restoreNoteUpdatethrough vritto_update

Bring a note back from Trash (or from archived) and make it active again.

FieldTypeDescription
noteId*stringNote ID.
notes_deleteNoteDeletethrough vritto_delete

Move one note to Trash, where it stays recoverable for 30 days. Only for explicit deletion requests.

Note: Moves the note to trash, recoverable for 30 days.

FieldTypeDescription
noteId*stringNote ID.
expectedRevisionintegerRevision guard from the last read.

Notebooknotebook

A notebook that files notes.

notes_queryNotebooksFindthrough vritto_find

List the user's notebooks with their note counts. Use this to resolve a notebook name to an ID before filing a note.

FieldTypeDescription
includeArchivedbooleanInclude archived notebooks; default false.
notes_createNotebookCreatethrough vritto_create

Create a notebook. Creating one that already exists returns the existing notebook rather than a duplicate.

FieldTypeDescription
notebook*objectNotebook fields; name is required.
notebook.name*stringNotebook name.
notebook.accentintegerAccent colour index.
Example input
{
  "notebook": {
    "name": "Home"
  }
}
notes_patchNotebookUpdatethrough vritto_update

Rename a notebook or change its accent colour. Renaming also restamps the label on every note filed in it.

FieldTypeDescription
notebookId*stringNotebook ID.
patch*objectFields to change.
patch.namestring
patch.accentinteger
notes_deleteNotebookDeletethrough vritto_delete

Delete a notebook and move its notes elsewhere (Inbox by default). The notes themselves are never deleted.

FieldTypeDescription
notebookId*stringNotebook ID.
moveToNotebookIdstringWhere its notes should go; defaults to Inbox.

Kept in the Vritto app

  • notes_updateNote: Replaces a whole record and clears omitted fields; the merge operation is on MCP instead.