Beta

Episodes are a core part of Channels, these are the recordings and imported videos grouped under Shows. On this page, we’ll dive into the different episode endpoints you can use to read episode information programmatically from the Channels library.

The episode model

The episode model contains all the information about your recordings and videos that are part of a Show, such as its title, season number, episode number, duration, watch status, etc.

Properties

id string

The unique identifier for the episode.

show_id string

The unique identifier for the episode's parent show.

program_id string

The unique identifier for the episode according to the indexer.

path string

The full path to the video file.

channel string

The channel number the episode was recorded from.

season_number integer

The season number of the episode.

episode_number integer

The episode number of the episode.

title string

The title of the episode's parent show.

episode_title string

The title of the episode.

event_title string

The title of the episode if it is a sporting event.

summary string

The short summary of the episode.

full_summary string

The full summary of the episode.

content_rating string

The content rating of the episode. This is typically a TV rating such as TV-14, TV-PG, etc.

image_url string

The URL of the poster image for the episode.

thumbnail_url string

The URL of the thumbnail image for the episode.

duration float

The duration of the episode in seconds.

playback_time integer

The playback position the episode will resume at in seconds.

original_air_date string

The date the episode originally aired.

genres array

An array of strings for the genres of the episode.

tags array

An array of strings for the tags of the episode. Tags indicate information about the recording such as Live, HD, 4K, CC, Dolby Digital, etc.

labels array

An array of strings for the labels of the episode. Labels are self assigned strings used for organizing items in the library.

categories array

An array of strings for the categories of the episode. Categories describe the type of content the episode is such as Special, Sports event, etc.

cast array

An array of strings for the cast of the episode.

directors array

An array of strings for the directors of the episode.

commercials Array of floats

An array of floats denoting the commercial breaks in the episode.

watched boolean

Whether or not the episode has been watched.

favorited boolean

Whether or not the episode has been favorited.

delayed boolean

Whether or not the episode's recording was delayed when recording began.

cancelled boolean

Whether or not the episode's recording was cancelled early.

corrupted boolean

Whether or not the episode was corrupted while recording.

completed boolean

Whether or not recording of the episode has completed.

processed boolean

Whether or not the recording has completed post-processing.

locked boolean

Whether or not the episode is set to be skipped by the auto pruner of its Series Pass.

verified boolean

Whether or not the episode's commercials have been manually verified.

last_watched_at timestamp

The timestamp of the last time the episode was watched.

created_at timestamp

The timestamp of when the episode was first added to the library.

updated_at timestamp

The timestamp of when the episode was last updated.

GET /api/v1/episodes

List all episodes

Returns a list of all episodes in the library.

Optional Attributes

watched boolean

Only return episodes with watch status corresponding to the passed in value.

favorited boolean

Only return episodes with favorited status corresponding to the passed in value.

verified boolean

Only return episodes with verified status corresponding to the passed in value.

source string

Only return episodes sourced from the passed in value.

Options

  • recordings

    Episodes recorded directly via Channels.

  • imports

    Episodes added to the library via local content sources.

  • playon-cloud

    Episodes added to the library from PlayOn Cloud.

  • stream-links

    Episodes added to the library via a Stream Link.

  • stream-files

    Episodes added to the library via a Stream File.

Sorting Attributes

sort string

Sort the response based on the passed in value.

Options

  • date_added default

    Sort by the date the episode was added to the library.

  • date_released

    Sort by the date the episode originally aired.

  • date_watched

    Sort by the date the episode was last watched.

  • duration

    Sort by length of the episode.

order string

Set the order of the response.

Options

  • asc

    Ascending order.

  • desc default

    Descending order.

Request
GET /api/v1/episodes
curl http://192.168.1.3:8089/api/v1/episodes
Response
[{
  "id": "31260",
  "show_id": "183983",
  "program_id": "EP000176170013",
  "path": "/shares/DVR/TV/Law & Order/Law & Order S01E18 1991-03-12 The Secret Sharers 2022-11-25-2359.mpg",
  "channel": "512",
  "season_number": 1,
  "episode_number": 18,
  "title": "Law & Order",
  "episode_title": "The Secret Sharers",
  "summary": "The probe of a felon's murder is hobbled by a cover-up to protect the killer.",
  "full_summary": "A community rallies to protect a teen who shot a neighborhood drug dealer in front of a church gathering.",
  "content_rating": "TV-PG",
  "image_url": "https://tmsimg.fancybits.co/assets/p183983_b_h9_bl.jpg?w=720&h=540",
  "thumbnail_url": "/dvr/files/31260/preview.jpg",
  "duration": 3671.601367,
  "playback_time": 0,
  "original_air_date": "1991-03-12",
  "genres": [
    "Crime drama"
  ],
  "tags": [
    "CC",
    "HD 1080i",
    "HDTV",
    "Stereo"
  ],
  "categories": [
    "Episode",
    "Series"
  ],
  "cast": [
    "George Dzundza",
    "Chris Noth",
    "Dann Florek"
  ],
  "commercials": [
    55.09,
    100.60000000000001,
    259.03000000000003,
    471.14,
    1053.52,
    1280.48,
    1724.42,
    1956.52,
    2527.56,
    2759.52,
    3332.46,
    3528.76
  ],
  "watched": false,
  "favorited": false,
  "delayed": false,
  "cancelled": false,
  "corrupted": false,
  "completed": true,
  "processed": true,
  "locked": false,
  "verified": false,
  "created_at": 1669438770000,
  "updated_at": 1669733074609
},{
  "id": "31254",
  "show_id": "183983",
  ...
}]

        

GET /api/v1/episodes/:id

Retrieve an episode

This endpoint allows you to retrieve an episode by using its unique identifier.

Required Attributes

id string

The unique identifier of the Episode.

Request
GET /api/v1/episodes/31260
curl http://192.168.1.3:8089/api/v1/episodes/31260
Response
{
  "id": "31260",
  "show_id": "183983",
  "program_id": "EP000176170013",
  "path": "/shares/DVR/TV/Law & Order/Law & Order S01E18 1991-03-12 The Secret Sharers 2022-11-25-2359.mpg",
  "channel": "512",
  "season_number": 1,
  "episode_number": 18,
  "title": "Law & Order",
  "episode_title": "The Secret Sharers",
  "summary": "The probe of a felon's murder is hobbled by a cover-up to protect the killer.",
  "full_summary": "A community rallies to protect a teen who shot a neighborhood drug dealer in front of a church gathering.",
  "content_rating": "TV-PG",
  "image_url": "https://tmsimg.fancybits.co/assets/p183983_b_h9_bl.jpg?w=720&h=540",
  "thumbnail_url": "/dvr/files/31260/preview.jpg",
  "duration": 3671.601367,
  "playback_time": 0,
  "original_air_date": "1991-03-12",
  "genres": [
    "Crime drama"
  ],
  "tags": [
    "CC",
    "HD 1080i",
    "HDTV",
    "Stereo"
  ],
  "categories": [
    "Episode",
    "Series"
  ],
  "cast": [
    "George Dzundza",
    "Chris Noth",
    "Dann Florek"
  ],
  "commercials": [
    55.09,
    100.60000000000001,
    259.03000000000003,
    471.14,
    1053.52,
    1280.48,
    1724.42,
    1956.52,
    2527.56,
    2759.52,
    3332.46,
    3528.76
  ],
  "watched": false,
  "favorited": false,
  "delayed": false,
  "cancelled": false,
  "corrupted": false,
  "completed": true,
  "processed": true,
  "locked": false,
  "verified": false,
  "created_at": 1669438770000,
  "updated_at": 1669733074609
}