Documents

Documents and folders: write or upload them, edit Markdown together, keep versions, link them to records, and import from Google Drive.

Commands

PostMake a document from an uploaded filedocuments.document.add_fileFiles an uploaded file (a PDF, a photo, anything) as a document.
PostChange a document between Markdown and HTMLdocuments.document.convertConverts a document's text to the other format.
PostMake targeted changes to a documentdocuments.document.editApplies changes to a Markdown or HTML document in order: replace an exact passage ({find, replace}), insert at the end of a heading's section ({after_heading, insert}), or add to the end ({append}).
PostLink a document to a recorddocuments.document.linkLinks a document to any record in the household (a task, a recipe, a piece of equipment), so the record shows it.
PostDelete a documentdocuments.document.removeDeletes a document with its text, versions, extracts and links.
PostSave the text read from a filedocuments.document.save_textRecords the text of an uploaded file: a PDF's text layer, or what you read from a scan or photo.
PostRemove a document's link to a recorddocuments.document.unlinkRemoves the link between a document and a record.
PostRename, file or describe a documentdocuments.document.updateChanges a document's title, folder or summary; only the fields given change. folder_id null takes it out of its folder (unfiled), summary null clears the summary.
PostReplace a document's whole textdocuments.document.writeReplaces the text of a Markdown or HTML document.
PostWrite a new documentdocuments.document.write_newCreates a Markdown or HTML document with the given text.
PostSave what you extracted from a documentdocuments.extract.saveKeeps structured information you worked out from a document (a policy's number and dates, a statement's lines), so the next question doesn't need the file read again.
PostCreate a folderdocuments.folder.createMakes a folder, at the top level or inside another folder.
PostMove a folderdocuments.folder.moveMoves a folder, with everything in it, into another folder or to the top level.
PostDelete an empty folderdocuments.folder.removeDeletes a folder that has nothing in it.
PostRename a folderdocuments.folder.renameChanges a folder's name.
PostImport from Google Drivedocuments.google.importImports chosen Google Drive folders and files as documents.
PostDismiss a finished importdocuments.import.dismissRemoves a finished import (done or failed) from the library, so it stops showing.
PostRestore an earlier version of a documentdocuments.version.restoreMakes an earlier version's text and title current.

Queries

GetDocuments linked to a recorddocuments.document.for_recordThe documents linked to a record (a task, a recipe, a piece of equipment), oldest link first, each with the link's note.
GetRead a documentdocuments.document.readA document's text, with its title, kind, summary, folder, saved extracts and links.
GetFind documents by what they saydocuments.document.searchFinds documents with all of the words you give in their title, summary, text or extracted information, best matches first.
GetWhat is in a folderdocuments.folder.listThe folders and documents directly inside a folder, or at the top level when folder_id is left out (where unfiled documents are too).
GetA document's historydocuments.version.listThe saved earlier versions of a Markdown or HTML document, newest first: when, why, who, and how much text each change added and removed (comparing each version with the next newer one, the newest with the current text).

Routes

GetBrowse a connected Google Drivedocuments.google_filesLists one page of a Google Drive folder through a connected Google Drive account, folders first and then by name, 100 to a page. parent_id is root (My Drive), shared (Shared with me) or a folder's Drive ID.