Beta

Videos are the imported videos grouped under Video Groups. They are very similar to videos, but they are grouped under Videos Groups. On this page, we’ll dive into the different video endpoints you can use to read video information programmatically from the Channels library.

The video model

The video model contains all the information about your imported videos that are part of a Video Group, such as its title, summary, poster art, watch status, duration, etc.

Properties

id string

The unique identifier for the video.

video_group_id string

The unique identifier for the video's parent video group.

path string

The full path to the video file.

season_number integer

The season number of the video.

episode_number integer

The episode number of the video.

title string

The title of the video's parent show.

video_title string

The title of the video.

summary string

The short summary of the video.

full_summary string

The full summary of the video.

content_rating string

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

image_url string

The URL of the poster image for the video.

thumbnail_url string

The URL of the thumbnail image for the video.

duration float

The duration of the video in seconds.

playback_time integer

The playback position the video will resume at in seconds.

original_air_date string

The date the video originated.

genres array

An array of strings for the genres of the video.

tags array

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

labels array

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

categories array

An array of strings for the categories of the video. Categories describe the type of content the video is such as Internet Video, Concert, etc.

watched boolean

Whether or not the video has been watched.

favorited boolean

Whether or not the video has been favorited.

processed boolean

Whether or not the video has completed post-processing.

verified boolean

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

last_watched_at timestamp

The timestamp of the last time the video was watched.

created_at timestamp

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

updated_at timestamp

The timestamp of when the video was last updated.

GET /api/v1/videos

List all videos

Returns a list of all videos in the library.

Optional Attributes

watched boolean

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

favorited boolean

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

verified boolean

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

Sorting Attributes

sort string

Sort the response based on the passed in value.

Options

  • date_added default

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

  • date_released

    Sort by the date the video originated.

  • date_watched

    Sort by the date the video was last watched.

  • duration

    Sort by length of the video.

order string

Set the order of the response.

Options

  • asc

    Ascending order.

  • desc default

    Descending order.

Request
GET /api/v1/videos
curl http://192.168.1.3:8089/api/v1/videos
Response 
[{
  "id": "32074",
  "video_group_id": "videos-912b6855d3497def488a22bb41000081c6128dad7bbf71b67b602454960cc92c",
  "path": "/media/videos/Stand Up Specials/Patton Oswalt - My Inner Child Doesn't Feel Like Chopping Wood Today [IuzCilEFBgo].webm",
  "title": "Stand Up Specials",
  "video_title": "Patton Oswalt - My Inner Child Doesn't Feel Like Chopping Wood Today",
  "summary": "Patton Oswalt gripes about watching old movies in L.A., remembers buying weed at a coffee shop in Amsterdam and reveals why he got thrown out of the Anne Frank House.",
  "image_url": "http://192.168.1.3:8089/dvr/uploads/125/content",
  "thumbnail_url": "https://i3.ytimg.com/vi/IuzCilEFBgo/maxresdefault.jpg",
  "duration": 1240.621,
  "playback_time": 0,
  "original_air_date": "1999-08-14",
  "genres": [
    "Stand Up Comedy"
  ],
  "tags": [
    "HD",
    "Stereo"
  ],
  "categories": [
    "Internet Video"
  ],
  "watched": false,
  "favorited": false,
  "delayed": false,
  "cancelled": false,
  "corrupted": false,
  "completed": false,
  "processed": true,
  "locked": false,
  "verified": false,
  "created_at": 1673040351000,
  "updated_at": 1673042668376
},{
  "id": "31254",
  "video_group_id": "videos-912b6855d3497def488a22bb41000081c6128dad7bbf71b67b602454960cc92c",
  ...
}]

GET /api/v1/videos/:id

Retrieve a video

This endpoint allows you to retrieve a video by using its unique identifier.

Required Attributes

id string

The unique identifier of the video.

Request
GET /api/v1/videos/31260
curl http://192.168.1.3:8089/api/v1/videos/31260
Response 
{
  "id": "32074",
  "video_group_id": "videos-912b6855d3497def488a22bb41000081c6128dad7bbf71b67b602454960cc92c",
  "path": "/media/videos/Stand Up Specials/Patton Oswalt - My Inner Child Doesn't Feel Like Chopping Wood Today [IuzCilEFBgo].webm",
  "title": "Stand Up Specials",
  "video_title": "Patton Oswalt - My Inner Child Doesn't Feel Like Chopping Wood Today",
  "summary": "Patton Oswalt gripes about watching old movies in L.A., remembers buying weed at a coffee shop in Amsterdam and reveals why he got thrown out of the Anne Frank House.",
  "image_url": "http://192.168.1.3:8089/dvr/uploads/125/content",
  "thumbnail_url": "https://i3.ytimg.com/vi/IuzCilEFBgo/maxresdefault.jpg",
  "duration": 1240.621,
  "playback_time": 0,
  "original_air_date": "1999-08-14",
  "genres": [
    "Stand Up Comedy"
  ],
  "tags": [
    "HD",
    "Stereo"
  ],
  "categories": [
    "Internet Video"
  ],
  "watched": false,
  "favorited": false,
  "delayed": false,
  "cancelled": false,
  "corrupted": false,
  "completed": false,
  "processed": true,
  "locked": false,
  "verified": false,
  "created_at": 1673040351000,
  "updated_at": 1673042668376
}