minimusdocs
Help center

TV shows

Create a TV show

POST/tv/series/

write Change: creates or edits. Scopes

Adds a TV show. Fill its seasons and episodes from TMDB (…/tmdb-sync/) or from files (…/import/plan/, then …/import/).

Body

  • namestringrequired
  • categorystring (uuid)required

    The one category this show reports as its own where exactly one is allowed: the M3U playlist group of every episode, and the title-uniqueness rule below. Always among categories.

  • categoriesstring (uuid)[]

    Every category this show appears under. Browsing and filtering read this; it always contains category.

  • bouquetsstring (uuid)[]

    Bouquets this show belongs to. A line with none of them in common cannot watch any of its episodes.

  • plotstring
  • poster_urlstring (uri)
  • backdrop_urlstring (uri)
  • trailer_urlstring (uri)
  • yearintegercan be null
  • release_datestring (date)can be null
  • ratingstring (decimal)can be null

    Out of 10.

  • genrestring
  • caststring
  • directorstring

    The show's creators — what TMDB lists for a series instead of a director.

  • countrystring
  • tmdb_idstring

    Set when the show was matched on TMDB. Seasons and episodes are looked up under it, so a sync fills every episode's own metadata without searching again.

  • is_activeboolean

    An inactive show disappears from playlists and refuses playback of every episode, without anything being deleted.

  • sort_orderinteger

Response

201 OK

  • idstring (uuid)requiredread-only
  • xtream_idintegerrequiredread-only

    The number players know it by, in player links and the player API. Given when it is created, never changed or reused, because players save favourites against it.

  • namestringrequired
  • categorystring (uuid)required

    The one category this show reports as its own where exactly one is allowed: the M3U playlist group of every episode, and the title-uniqueness rule below. Always among categories.

  • category_namestringrequiredread-only
  • categoriesstring (uuid)[]

    Every category this show appears under. Browsing and filtering read this; it always contains category.

  • bouquetsstring (uuid)[]

    Bouquets this show belongs to. A line with none of them in common cannot watch any of its episodes.

  • plotstring
  • poster_urlstring (uri)
  • backdrop_urlstring (uri)
  • trailer_urlstring (uri)
  • yearintegercan be null
  • release_datestring (date)can be null
  • ratingstring (decimal)can be null

    Out of 10.

  • genrestring
  • caststring
  • directorstring

    The show's creators — what TMDB lists for a series instead of a director.

  • countrystring
  • tmdb_idstring

    Set when the show was matched on TMDB. Seasons and episodes are looked up under it, so a sync fills every episode's own metadata without searching again.

  • is_activeboolean

    An inactive show disappears from playlists and refuses playback of every episode, without anything being deleted.

  • sort_orderinteger
  • season_countintegerrequiredread-only
  • episode_countintegerrequiredread-only
  • playable_countintegerrequiredread-only

    Episodes with a file a viewer could be sent to right now — the same reading as an episode's own is_playable, counted in the database by the viewset.

  • created_bystring (uuid)requiredread-onlycan be null
  • created_by_usernamestringrequiredread-only
  • created_atstring (date-time)requiredread-only
  • updated_atstring (date-time)requiredread-only

Errors

  • 400 Something sent is not valid. Each field that is wrong is named with what is wrong.
  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means