Skip To Main Content
All modules

Places

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.

Placeplace

A saved place in the user's atlas. The same operations reach custom lists of places (type 'list') and logged visits to saved places (type 'visit').

places_findFindthrough vritto_find

Read Places: one place by placeKey (with its revision and visits), saved places filtered by text, category, list, role or favorite, several placeKeys, places near coordinates, the custom lists (type 'list'), or visits (type 'visit') by place, trip, dates or rating. No filter gives the saved places and lists.

Note: One placeKey returns the place with its revision and visits. type 'list' reads the custom lists; type 'visit' reads visits by place, trip, dates or rating.

FieldTypeDescription
typeone of place, list, visitWhich records to read: 'place' (default), 'list' or 'visit'.
placeKeystringOne place, with its logged visits; with type 'visit', that place's visits.
placeKeyslist of stringResolve several places to display summaries; missing or archived ones are flagged.
querystringText to match a place's name, label, address or tags.
categoryone of medical, dining, grocery, shopping, property, automotive, lodging, travel, personal, event, entertainment, generalPlace category, derived from the capturing module (multi-valued on a place).
listIdstringOnly places in this custom list.
roleone of home, workOnly home or work.
favoritebooleanOnly favorites.
moduleIdstringRecents captured by this module (in-context picker).
archivedbooleanList archived/removed places.
coordinatesobjectSaved places near here, nearest first.
coordinates.lat*numberLatitude.
coordinates.lng*numberLongitude.
radiusMetersnumberWith coordinates: search radius in meters (default 2000).
tripIdstringType 'visit': only this trip's visits.
fromstringType 'visit': earliest visit date, inclusive.
tostringType 'visit': latest visit date, inclusive. ALWAYS pass from/to when the question concerns a period.
minRatingnumberType 'visit': only visits rated at least this.
limitintegerMax results.
Example input
{
  "query": "coffee",
  "category": "dining"
}
places_addCreate or Updatethrough vritto_create or vritto_update

Add one record: a visit to a saved place (type 'visit': placeKey, visitedOn, rating only when stated; an id updates that visit), a custom list (type 'list': name, emoji), or a private place Google doesn't know (name, address). Resolve or save the place first; save Google places with places_upsertPlaceFromProvider.

Note: Google places are saved in the app; this adds a private place (name, address), a custom list (type 'list'), or a visit to a saved place (type 'visit').

FieldTypeDescription
typeone of place, list, visitRecord type: 'place' (default) a saved place in the atlas; 'list' a custom list of places; 'visit' a logged visit to a saved place.
namestringA place's or list's name. Required for those.
addressobjectType 'place': its address.
address.formatted*stringFull formatted address.
address.localitystringCity/locality.
address.regionstringState/region.
address.postalCodestring
address.countryCodestringISO 3166-1 alpha-2, e.g. US.
coordinatesobjectType 'place': where it is.
coordinates.lat*numberLatitude.
coordinates.lng*numberLongitude.
emojistringType 'list': an emoji.
descriptionstringType 'list': what it collects.
idstringType 'visit': an existing visit to update. Omit to log a new one.
placeKeystringType 'visit': the saved place visited.
visitedOnstringType 'visit': local date YYYY-MM-DD ('yesterday' resolves against the user's timezone). Required to log one.
kindone of see, do, shop, otherType 'visit': defaults to 'see'.
ratingnumberType 'visit': 1–5, halves allowed, ONLY when the user stated it.
notestring
photoAssetIdslist of stringType 'visit': Files asset IDs of photos from the visit.
tripIdstringType 'visit': resolve via trips_find.
personIdslist of stringType 'visit': companion People IDs.
journalEntryIdstringType 'visit': Journal entry ID this visit links to.
Example input
{
  "type": "visit",
  "placeKey": "google:ChIJN1t_tDeuEmsRUsoyG83frY4",
  "visitedOn": "2026-09-20",
  "kind": "see",
  "rating": 4.5
}
places_changeUpdatethrough vritto_update

Change one place by placeKey with its expectedRevision from places_find: label (null clears), favorite, role home or work (null clears), tags (REPLACES the set), archived, or listId with member to add it to or take it off a list. Type 'visit' changes a visit by its id.

Note: A place change needs its expectedRevision from places_find. tags replaces the whole set; read the place first.

FieldTypeDescription
typeone of place, list, visitRecord type: 'place' (default) a saved place in the atlas; 'list' a custom list of places; 'visit' a logged visit to a saved place.
placeKeystringThe place to change; for a visit, its place.
expectedRevisionintegerRequired for a place: its current revision from places_find.
labelstringThe place's own label, which wins over the provider name; null clears it.
favoriteboolean
roleone ofThe user's home or work (the previous holder is released); null clears it.
tagslist of stringFull replacement list of tags; [] clears them.
archivedbooleanArchive (remove) or restore the place without deleting it.
listIdstringA custom list, with member.
memberbooleanWith listId: true adds the place to the list, false takes it off.
idstringType 'visit': the visit to change.
visitedOnstringType 'visit': local date YYYY-MM-DD ('yesterday' resolves against the user's timezone). Required to log one.
kindone of see, do, shop, otherType 'visit': defaults to 'see'.
ratingnumberType 'visit': 1–5, halves allowed, ONLY when the user stated it.
notestring
photoAssetIdslist of stringType 'visit': Files asset IDs of photos from the visit.
tripIdstringType 'visit': resolve via trips_find.
personIdslist of stringType 'visit': companion People IDs.
journalEntryIdstringType 'visit': Journal entry ID this visit links to.
Example input
{
  "placeKey": "google:ChIJN1t_tDeuEmsRUsoyG83frY4",
  "favorite": true,
  "expectedRevision": 3
}
places_removeDeletethrough vritto_delete

Remove one record on an explicit ask: a visit by id (archived), or a place by placeKey with its expectedRevision (archived, restorable with places_change). Get ids from places_find.

Note: A visit by id; a place by placeKey and expectedRevision is archived, restorable with places_change.

FieldTypeDescription
typeone of place, list, visitRecord type: 'place' (default) a saved place in the atlas; 'list' a custom list of places; 'visit' a logged visit to a saved place.
idstringThe visit to remove.
visitIdstringOlder name for id.
placeKeystringThe place to archive.
expectedRevisionintegerWith placeKey: the place's current revision.

Kept in the Vritto app

  • places_searchSuggestions: Google Maps content may only be shown with a Google map, inside the app.
  • places_getPlaceDetails: Google Maps content may only be shown with a Google map, inside the app.
  • places_upsertPlaceFromProvider: Google Maps content may only be shown with a Google map, inside the app.
  • places_geocode: Google Maps content may only be shown with a Google map, inside the app.
  • places_reverseGeocode: Google Maps content may only be shown with a Google map, inside the app.
  • places_getTimeZone: Google Maps content may only be shown with a Google map, inside the app.
  • places_estimateTravelTime: Google Maps content may only be shown with a Google map, inside the app.
  • places_listPlaceReferences: Internal links between records that each module keeps in step itself.