invidious_video_api.yaml

trending:
  title: Trending
  url: /api/v1/trending
  cacheSeconds: 21600 # 6 hours
  queryParams:
    type:
      type:
        - Music
        - Gaming
        - Movies
    region:
      type: "#ISO3166"
      default: GetUserCountryCode

popular:
  title: Popular
  url: /api/v1/popular

search:
  title: Search
  url: /api/v1/search
  paginationType: Pages
  queryParams:
    q:
      type: string
    sort:
      type:
        - relevance
        - rating
        - date
        - views
    date:
      type:
        - hour
        - today
        - week
        - month
        - year
    duration:
      type:
        - short
        - long
    type:
      type:
        - video
        - playlist
        - channel
        - all
      arrayType: CommaSeparated
    features:
      type:
        - hd
        - subtitles
        - creative_commons
        - 3d
        - live
        - purchased
        - 4k
        - 360
        - location
        - hdr
      arrayType: CommaSeparated
    region:
      type: "#ISO3166"
      default: GetUserCountryCode
  cacheSeconds: 300 # 5 minutes

# Auth endpoints
auth_feed:
  title: Subscriptions
  url: /api/v1/auth/feed
  authenticated: true
  queryParams:
    max_results:
      type: number
      default: 20
  paginationType: Pages
  responseHandler: AuthFeedHandler

auth_playlists:
  title: Playlists
  url: /api/v1/auth/playlists
  authenticated: true
  paginationType: Continuation

playlist:
  title: Playlist
  url: /api/v1/playlists/{plid}
  responseHandler: PlaylistHandler
  paginationType: Pages

# video_info, playlist_info and channel_info are used by the
# Bookmarks, so they are cached for longer
video_info:
  title: Video
  url: /api/v1/videos/{id}
  responseHandler: VideoInfoHandler
  cacheSeconds: 259200 # 3 days

playlist_info:
  title: Playlist
  url: /api/v1/playlists/{plid}
  responseHandler: PlaylistInfoHandler
  cacheSeconds: 259200 # 3 days

channel_info:
  title: Channel
  url: /api/v1/channels/{ucid}
  responseHandler: ChannelInfoHandler
  cacheSeconds: 259200 # 3 days
  tryCount: 3

# Channel endpoints
channel_videos:
  title: Channel videos
  url: /api/v1/channels/{ucid}/videos
  responseHandler: ChannelVideosHandler
  paginationType: Continuation
  tryCount: 3
  queryParams:
    sort_by:
      # defaults to newest
      type:
        - newest
        - oldest
        - popular

channel_playlists:
  title: Channel playlists
  url: /api/v1/channels/{ucid}/playlists
  responseHandler: ChannelPlaylistsHandler
  paginationType: Continuation
  tryCount: 3
  queryParams:
    sort_by:
      default: newest
      type:
        - newest
        - last

channel_shorts:
  title: Channel shorts
  url: /api/v1/channels/{ucid}/shorts
  responseHandler: ChannelVideosHandler
  paginationType: Continuation
  tryCount: 3

channel_streams:
  title: Channel streams
  url: /api/v1/channels/{ucid}/streams
  responseHandler: ChannelVideosHandler
  paginationType: Continuation
  tryCount: 3

channel_podcasts:
  title: Channel podcasts
  url: /api/v1/channels/{ucid}/podcasts
  responseHandler: ChannelPlaylistsHandler
  paginationType: Continuation
  tryCount: 3

channel_releases:
  title: Channel releases
  url: /api/v1/channels/{ucid}/releases
  responseHandler: ChannelPlaylistsHandler
  paginationType: Continuation
  tryCount: 3

# This is implemented only by Playlet backend.
# Created because auto-generated channels don't have tabs except for "featured"
channel_featured:
  title: Channel Home
  url: /api/v1/channels/{ucid}/featured
  responseHandler: ChannelVideosHandler
  paginationType: Continuation

watch_history:
  title: Watch history
  url: /api/v1/auth/history
  authenticated: true
  paginationType: Pages
  responseHandler: WatchHistoryHandler