Skip To Main Content
All modules

TV Series

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.

TV Seriestv_series

A series in the user's library, with progress and rating. The same operations reach its watch logs, each a date and a season and episode range (type 'watch_log'), and a person's recommendations and favorite or disliked series (type 'recommendation' and 'taste').

tv_series_findFindthrough vritto_find

Read TV Series: the library (query, status 'watching'), episodes watched in a period (type 'watch_log' with from/to), counts (view 'stats'), one person's links (personId), or one record by id.

Note: type 'watch_log' with from/to reads episodes watched in a period; view 'stats' counts them by year and month; personId reads one person's recommendations, shared watches and tastes. Record rows carry nextEpisode, the next one to watch.

FieldTypeDescription
typeone of record, watch_logDefault 'record' (shows).
idstringJust this record of the type.
viewone of list, stats'stats': watches and episodes by year and month, and ratings.
querystringMatches a saved show's title, overview, genres and tags.
statusone of want_to_watch, watching, watched, completed, dropped, on_hold
fromstringWatched on or after.
tostringWatched on or before. ALWAYS pass from/to when the question concerns a period.
yearstringWith view 'stats'.
mediaRecordIdstringOne show's watch logs.
personIdstringA People ID: what they recommended, watched with the user, love or avoid.
detailone of summary, full
limitinteger
cursorstring
Example input
{
  "status": "watching"
}
tv_series_addCreate or Updatethrough vritto_create or vritto_update

Add to TV Series: a show by TMDB providerId (or a record), watched episodes of a saved show (type 'watch_log': one run, or many with segments), or a person's recommendation or taste. An id there updates that record.

Note: Pass providerId from vritto_lookup (tv_catalog) to save with full details. type 'watch_log' logs episodes; for many at once send segments (runs of episodes, each with when it was watched) and the server reads air dates itself.

FieldTypeDescription
typeone of record, watch_log, recommendation, taste'record' (default) a show; 'watch_log' a sitting; 'recommendation'; 'taste' a person's favorite or disliked show.
providerIdstringA show's TMDB ID: saves it with full details.
statusone of want_to_watch, watching, watched, completed, dropped, on_holdWith providerId, for a new show.
mediaRecordIdstringA saved show to overwrite with record.
recordobjectA whole show; it replaces what is stored.
record.providerRef*object
record.title*string
record.originalTitlestring
record.overviewstring
record.firstAirDatestring
record.runtimeMinutesnumber
record.genreslist of string
record.numberOfSeasonsinteger
record.numberOfEpisodesinteger
record.currentSeasoninteger
record.currentEpisodeinteger
record.statusone of want_to_watch, watching, watched, completed, dropped, on_holdDefault watching; completed when finished.
record.ratingone of dislike, okay, like, love
record.journalNotesstring
record.recommendedByPersonIdslist of stringPeople who recommended it.
record.tagslist of string
watchLogIdstring
logobjectWith segments, only mediaRecordId (and a platform).
log.mediaRecordId*stringThe saved show's ID, from tv_series_find.
log.watchedOnstringOmit for episodeAirDate or the first air date, marked as a default.
log.episodeAirDatestring
log.seasonFrominteger
log.episodeFrominteger
log.seasonTointeger
log.episodeTointeger
log.platformstringWhere, e.g. Netflix.
log.platformTypeone of theater, streaming, television, other
log.platformServicestring
log.platformCountryone of US, IN
log.placeKeystring
log.locationLabelstring
log.watchedWithPersonIdslist of stringPeople the user watched with.
log.notesstring
log.ratingone of dislike, okay, like, love
segmentslist of objectMany episodes at once: runs, each with when it was watched.
batchIdstringWith segments: reuse to retry or re-date a batch.
recommendationIdstring
recommendationobject
recommendation.mediaRecordId*string
recommendation.personId*stringThe recommender's People ID.
recommendation.statusone of open, accepted, dismissed, watched
recommendation.notestring
personTasteIdstring
personTasteobject
personTaste.personId*string
personTaste.providerRef*object
personTaste.taste*one of favorite, dislike
personTaste.notestring
Example input
{
  "providerId": "95396",
  "status": "watching"
}
tv_series_changeUpdatethrough vritto_update

Change one TV Series record by id; sent fields merge. A show's status, rating (the user's own) or notes; a watch log's date, episodes or details.

Note: Sent fields merge into the stored record. A rating set on the show is the user's own. Progress follows the logs: log episodes rather than setting currentEpisode.

FieldTypeDescription
typeone of record, watch_logDefault 'record' (a show).
idstring
recordobjectA show's fields to change; the rest stay.
record.statusone of want_to_watch, watching, watched, completed, dropped, on_hold
record.ratingone ofThe user's own rating; null clears it.
record.journalNotesstring
record.tagslist of string
record.recommendedByPersonIdslist of string
record.titlestring
logobjectA watch log's fields to change.
log.mediaRecordIdstringThe saved show's ID, from tv_series_find.
log.watchedOnstringOmit for episodeAirDate or the first air date, marked as a default.
log.episodeAirDatestring
log.seasonFrominteger
log.episodeFrominteger
log.seasonTointeger
log.episodeTointeger
log.platformstringWhere, e.g. Netflix.
log.platformTypeone of theater, streaming, television, other
log.platformServicestring
log.platformCountryone of US, IN
log.placeKeystring
log.locationLabelstring
log.watchedWithPersonIdslist of stringPeople the user watched with.
log.notesstring
log.ratingone of dislike, okay, like, love
watchLogIdstringOlder name for id.
Example input
{
  "id": "tv_severance",
  "record": {
    "rating": "love"
  }
}
tv_series_removeDeletethrough vritto_delete

Remove one show with its watch logs, one watch log, or every log of one batch (batchId). Only for explicit removals.

Note: type 'watch_log' removes one log; batchId removes every log one multi-episode log wrote.

FieldTypeDescription
typeone of record, watch_logDefault 'record' (a show).
idstring
batchIdstringEvery log of one batch.
mediaRecordIdstringOlder name for id.
watchLogIdstringOlder name for id.

TV Catalogtv_catalog

TMDB reference data for series and seasons.

tv_series_discoverTvSeriesLook Upthrough vritto_lookup

Browse TMDB TV discovery lists (popular, airing today, on the air, top rated) when the user wants suggestions rather than a title search.

FieldTypeDescription
categoryone of popular, airing_today, on_the_air, top_ratedDiscovery list; defaults to "popular".
pageintegerTMDB result page, starting at 1.
tv_series_getTvSeriesDetailsLook Upthrough vritto_lookup

Fetch full TMDB details (overview, seasons, episodes, genres, cast/crew) for one TV series by TMDB ID.

FieldTypeDescription
providerId*stringTMDB TV series ID (numeric string).
tv_series_getTvSeriesSeasonDetailsLook Upthrough vritto_lookup

Fetch TMDB details for one season of a TV series: episode list with names, numbers, and air dates. Use this to resolve an episodeAirDate before logging a watch.

FieldTypeDescription
providerId*stringTMDB TV series ID (numeric string).
seasonNumber*integerSeason number (0 is usually specials).
tv_series_searchTvSeriesLook Upthrough vritto_lookup

Search TMDB for TV series by title; an empty query returns popular series. Returns provider metadata, not the user's saved library: use tv_series_find for saved series.

FieldTypeDescription
querystringSearch text. Omit to return popular series.
pageintegerTMDB result page, starting at 1.