Skip To Main Content
All modules

Files

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.

Filefile

A file stored in Vritto: its name, tags, sensitivity, and links.

files_getFileFindthrough vritto_find

Fetch one asset's metadata by ID.

FieldTypeDescription
assetId*stringAsset ID.
files_listAiContextFilesFindthrough vritto_find

List available assets in the ai_context scope that are marked AI-exposable, the files AI may cite as grounding context. Rows are compact summaries; use files_getFile for full metadata.

FieldTypeDescription
detailone of summary, fullRow shape: "summary" (default, id/name/kind/scope + description preview) or "full" (every field).
limitintegerMax records to return (default 50 in summary mode).
files_queryFilesFindthrough vritto_find

Search assets by free text with optional kind, scope, sensitivity, module, entity, AI-exposure, and status filters. Returns available assets by default. Rows are compact summaries (name, kind, scope, description preview); use files_getFile or files_resolveFiles for full metadata.

FieldTypeDescription
querystringSearch query.
kindone of image, document, audio, video, archive, data, otherAsset kind.
scopeone of module, profile, ai_context, systemAsset scope (defaults to module).
sensitivityone of normal, private, sensitivePrivacy sensitivity (defaults to normal). 'private' files are readable by AI only when aiExposable is set; 'sensitive' files are never readable by AI and cannot be AI-exposed at all.
moduleIdstringOwning or linked module ID.
entityIdstringOwning record ID.
aiExposablebooleanOnly assets that are (or are not) available to AI.
statusone of available, archived, trashedFilter to one status.
includeArchivedbooleanInclude archived assets alongside available ones.
detailone of summary, fullRow shape: "summary" (default, id/name/kind/scope + description preview) or "full" (every field incl. full description and render URLs).
limitintegerMax records to return (default 50 in summary mode).
files_resolveFilesFindthrough vritto_find

Resolve up to 100 asset IDs to full metadata; missing or deleted IDs are flagged instead of failing.

FieldTypeDescription
ids*list of stringAsset IDs to resolve.
files_restoreFileUpdatethrough vritto_update

Restore an archived or trashed asset back to available.

FieldTypeDescription
assetId*stringAsset ID.
expectedRevision*integerCurrent record revision; the write aborts if it changed elsewhere.
files_setFileArchivedUpdatethrough vritto_update

Archive or unarchive an asset without deleting the file.

FieldTypeDescription
assetId*stringAsset ID.
archived*booleanTrue to archive, false to restore.
expectedRevision*integerCurrent record revision; the write aborts if it changed elsewhere.
files_updateFileUpdatethrough vritto_update

Update an asset's metadata (name, scope, sensitivity, tags, description, owner link, About person, AI exposure). The file bytes are unchanged. This is a PATCH: a field you omit keeps its stored value, and a field sent as an empty string clears it. Send only what is changing.

FieldTypeDescription
asset*objectFields to change; id and displayName are required. Everything else is optional and omitting it preserves the stored value.
asset.id*stringAsset ID.
asset.displayName*stringDisplay name.
asset.scopeone of module, profile, ai_context, systemAsset scope (defaults to module).
asset.sensitivityone of normal, private, sensitivePrivacy sensitivity (defaults to normal). 'private' files are readable by AI only when aiExposable is set; 'sensitive' files are never readable by AI and cannot be AI-exposed at all.
asset.tagslist of stringTags (unique, case-insensitive). Replaces the whole list when sent; omit to keep the stored tags.
asset.descriptionstringDescription. Send an empty string to clear it.
asset.moduleIdstringOwning module ID. This is who pays for the file's bytes in the storage report, so clearing it re-attributes them to 'unattributed'.
asset.entityIdstringOwning record ID.
asset.subjectPersonIdstringPerson this document is about (a child's birth certificate, a spouse's passport). Send an empty string to clear it.
asset.aiExposablebooleanWhether AI may use this asset as grounding context. Ignored (forced false) on assets whose sensitivity is 'sensitive'.
expectedRevision*integerCurrent record revision; the write aborts if it changed elsewhere.
files_deleteFileDeletethrough vritto_delete

Delete an asset. By default it moves to trash (recoverable with files_restoreFile for 30 days); with deleteStorageObject true the file is permanently removed.

Note: Deleting moves the file to trash, recoverable for 30 days.

FieldTypeDescription
assetId*stringAsset ID.
expectedRevision*integerCurrent record revision; the write aborts if it changed elsewhere.
deleteStorageObjectbooleanTrue to permanently delete the stored file (defaults to false).

Kept in the Vritto app

  • files_createFileUploadTarget: Moves file bytes, which MCP apps cannot send or receive here.
  • files_finalizeFileUpload: Moves file bytes, which MCP apps cannot send or receive here.
  • files_getFileDownloadUrl: Moves file bytes, which MCP apps cannot send or receive here.