Jellyfin

Jellyfin API

Jellyfin API endpoints from Jellyfin

Media & content#openapi#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Jellyfin API endpoints from Jellyfin

Endpoints 400

InstantMix

  • GETCreates an instant playlist based on a given song./Albums/:id/InstantMix?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime&enableImages=true&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary
  • GETCreates an instant playlist based on a given song./Artists/:id/InstantMix?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime&enableImages=true&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary
  • GETCreates an instant playlist based on a given song./Items/:id/InstantMix?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime&enableImages=true&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary
  • GETCreates an instant playlist based on a given song./MusicGenres/:id/InstantMix?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime&enableImages=true&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary
  • GETCreates an instant playlist based on a given song./MusicGenres/:name/InstantMix?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime&enableImages=true&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary
  • GETCreates an instant playlist based on a given song./Playlists/:id/InstantMix?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime&enableImages=true&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary
  • GETCreates an instant playlist based on a given song./Songs/:id/InstantMix?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime&enableImages=true&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary

Library

  • GETGets similar items./Albums/:itemId/Similar?excludeArtistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime
  • GETGets similar items./Artists/:itemId/Similar?excludeArtistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime
  • DELETEDeletes items from the library and filesystem./Items?ids=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • GETGet item counts./Items/Counts?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&isFavorite=true
  • DELETEDeletes an item from the library and filesystem./Items/:itemId
  • GETGets all parents of an item./Items/:itemId/Ancestors?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • GETGets critic review for an item./Items/:itemId/CriticReviewsDeprecated.
  • GETDownloads item media./Items/:itemId/Download
  • GETGet the original file of an item./Items/:itemId/File
  • GETGets similar items./Items/:itemId/Similar?excludeArtistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime
  • GETGet theme songs and videos for an item./Items/:itemId/ThemeMedia?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&inheritFromParent=false
  • GETGet theme songs for an item./Items/:itemId/ThemeSongs?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&inheritFromParent=false
  • GETGet theme videos for an item./Items/:itemId/ThemeVideos?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&inheritFromParent=false
  • GETGets the library options info./Libraries/AvailableOptions?libraryContentType=string&isNewLibrary=true
  • POSTReports that new movies have been added by an external source./Library/Media/Updated
  • GETGets all user media folders./Library/MediaFolders?isHidden=true
  • POSTReports that new movies have been added by an external source./Library/Movies/Added?tmdbId=string&imdbId=string
  • POSTReports that new movies have been added by an external source./Library/Movies/Updated?tmdbId=string&imdbId=string
  • GETGets a list of physical paths from virtual folders./Library/PhysicalPaths
  • GETStarts a library scan./Library/Refresh
  • POSTReports that new episodes of a series have been added by an external source./Library/Series/Added?tvdbId=string
  • POSTReports that new episodes of a series have been added by an external source./Library/Series/Updated?tvdbId=string
  • GETGets similar items./Movies/:itemId/Similar?excludeArtistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime
  • GETGets similar items./Shows/:itemId/Similar?excludeArtistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime
  • GETGets similar items./Trailers/:itemId/Similar?excludeArtistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime

Artists

  • GETGets all artists from a given item, folder, or the entire library./Artists?minCommunityRating=0.0&startIndex=0&limit=0&searchTerm=string&parentId=3fa85f64-5717-4562-b3fc-2c963f66afa6&fields=AirTime&excludeItemTypes=string&includeItemTypes=string&filters=IsFolder&isFavorite=true&mediaTypes=string&genres=string&genreIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&officialRatings=string&tags=string&years=0&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary&person=string&personIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&personTypes=string&studios=string&studioIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&nameStartsWithOrGreater=string&nameStartsWith=string&nameLessThan=string&enableImages=true&enableTotalRecordCount=true
  • GETGets all album artists from a given item, folder, or the entire library./Artists/AlbumArtists?minCommunityRating=0.0&startIndex=0&limit=0&searchTerm=string&parentId=3fa85f64-5717-4562-b3fc-2c963f66afa6&fields=AirTime&excludeItemTypes=string&includeItemTypes=string&filters=IsFolder&isFavorite=true&mediaTypes=string&genres=string&genreIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&officialRatings=string&tags=string&years=0&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary&person=string&personIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&personTypes=string&studios=string&studioIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&nameStartsWithOrGreater=string&nameStartsWith=string&nameLessThan=string&enableImages=true&enableTotalRecordCount=true
  • GETGets an artist by name./Artists/:name?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6

Image

  • GETGet artist image by name./Artists/:name/Images/:imageType/:imageIndex?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • HEADGet artist image by name./Artists/:name/Images/:imageType/:imageIndex?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • GETGet genre image by name./Genres/:name/Images/:imageType?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string&imageIndex=0
  • HEADGet genre image by name./Genres/:name/Images/:imageType?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string&imageIndex=0
  • GETGet genre image by name./Genres/:name/Images/:imageType/:imageIndex?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • HEADGet genre image by name./Genres/:name/Images/:imageType/:imageIndex?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • GETGet item image infos./Items/:itemId/Images
  • GETGets the item's image./Items/:itemId/Images/:imageType?maxWidth=0&maxHeight=0&width=0&height=0&quality=0&tag=string&cropWhitespace=true&format=Bmp&addPlayedIndicator=true&percentPlayed=0.0&unplayedCount=0&blur=0&backgroundColor=string&foregroundLayer=string&imageIndex=0
  • POSTSet item image./Items/:itemId/Images/:imageType
  • DELETEDelete an item's image./Items/:itemId/Images/:imageType?imageIndex=0
  • HEADGets the item's image./Items/:itemId/Images/:imageType?maxWidth=0&maxHeight=0&width=0&height=0&quality=0&tag=string&cropWhitespace=true&format=Bmp&addPlayedIndicator=true&percentPlayed=0.0&unplayedCount=0&blur=0&backgroundColor=string&foregroundLayer=string&imageIndex=0
  • GETGets the item's image./Items/:itemId/Images/:imageType/:imageIndex?maxWidth=0&maxHeight=0&width=0&height=0&quality=0&tag=string&cropWhitespace=true&format=Bmp&addPlayedIndicator=true&percentPlayed=0.0&unplayedCount=0&blur=0&backgroundColor=string&foregroundLayer=string
  • POSTSet item image./Items/:itemId/Images/:imageType/:imageIndex
  • DELETEDelete an item's image./Items/:itemId/Images/:imageType/:imageIndex
  • HEADGets the item's image./Items/:itemId/Images/:imageType/:imageIndex?maxWidth=0&maxHeight=0&width=0&height=0&quality=0&tag=string&cropWhitespace=true&format=Bmp&addPlayedIndicator=true&percentPlayed=0.0&unplayedCount=0&blur=0&backgroundColor=string&foregroundLayer=string
  • POSTUpdates the index for an item image./Items/:itemId/Images/:imageType/:imageIndex/Index?newIndex=0
  • GETGets the item's image./Items/:itemId/Images/:imageType/:imageIndex/:tag/:format/:maxWidth/:maxHeight/:percentPlayed/:unplayedCount?width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • HEADGets the item's image./Items/:itemId/Images/:imageType/:imageIndex/:tag/:format/:maxWidth/:maxHeight/:percentPlayed/:unplayedCount?width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • GETGet music genre image by name./MusicGenres/:name/Images/:imageType?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string&imageIndex=0
  • HEADGet music genre image by name./MusicGenres/:name/Images/:imageType?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string&imageIndex=0
  • GETGet music genre image by name./MusicGenres/:name/Images/:imageType/:imageIndex?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • HEADGet music genre image by name./MusicGenres/:name/Images/:imageType/:imageIndex?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • GETGet person image by name./Persons/:name/Images/:imageType?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string&imageIndex=0
  • HEADGet person image by name./Persons/:name/Images/:imageType?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string&imageIndex=0
  • GETGet person image by name./Persons/:name/Images/:imageType/:imageIndex?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • HEADGet person image by name./Persons/:name/Images/:imageType/:imageIndex?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • GETGet studio image by name./Studios/:name/Images/:imageType?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string&imageIndex=0
  • HEADGet studio image by name./Studios/:name/Images/:imageType?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string&imageIndex=0
  • GETGet studio image by name./Studios/:name/Images/:imageType/:imageIndex?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • HEADGet studio image by name./Studios/:name/Images/:imageType/:imageIndex?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • GETGet user profile image./Users/:userId/Images/:imageType?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string&imageIndex=0
  • POSTSets the user image./Users/:userId/Images/:imageType?index=0
  • DELETEDelete the user's image./Users/:userId/Images/:imageType?index=0
  • HEADGet user profile image./Users/:userId/Images/:imageType?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string&imageIndex=0
  • GETGet user profile image./Users/:userId/Images/:imageType/:imageIndex?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • HEADGet user profile image./Users/:userId/Images/:imageType/:imageIndex?tag=string&format=Bmp&maxWidth=0&maxHeight=0&percentPlayed=0.0&unplayedCount=0&width=0&height=0&quality=0&cropWhitespace=true&addPlayedIndicator=true&blur=0&backgroundColor=string&foregroundLayer=string
  • POSTSets the user image./Users/:userId/Images/:imageType/:index
  • DELETEDelete the user's image./Users/:userId/Images/:imageType/:index

HlsSegment

  • GETGets the specified audio segment for an audio item./Audio/:itemId/hls/:segmentId/stream.aac
  • GETGets the specified audio segment for an audio item./Audio/:itemId/hls/:segmentId/stream.mp3
  • DELETEStops an active encoding./Videos/ActiveEncodings?deviceId=string&playSessionId=string
  • GETGets a hls video playlist./Videos/:itemId/hls/:playlistId/stream.m3u8
  • GETGets a hls video segment./Videos/:itemId/hls/:playlistId/:segmentId.:segmentContainer

DynamicHls

  • GETGets a video stream using HTTP live streaming./Audio/:itemId/hls1/:playlistId/:segmentId.:container?static=true&params=string&tag=string&deviceProfileId=string&playSessionId=string&segmentContainer=string&segmentLength=0&minSegments=0&mediaSourceId=string&deviceId=string&audioCodec=string&enableAutoStreamCopy=true&allowVideoStreamCopy=true&allowAudioStreamCopy=true&breakOnNonKeyFrames=true&audioSampleRate=0&maxAudioBitDepth=0&maxStreamingBitrate=0&audioBitRate=0&audioChannels=0&maxAudioChannels=0&profile=string&level=string&framerate=0.0&maxFramerate=0.0&copyTimestamps=true&startTimeTicks=0&width=0&height=0&videoBitRate=0&subtitleStreamIndex=0&subtitleMethod=Encode&maxRefFrames=0&maxVideoBitDepth=0&requireAvc=true&deInterlace=true&requireNonAnamorphic=true&transcodingMaxAudioChannels=0&cpuCoreLimit=0&liveStreamId=string&enableMpegtsM2TsMode=true&videoCodec=string&subtitleCodec=string&transcodeReasons=string&audioStreamIndex=0&videoStreamIndex=0&context=Streaming&streamOptions={"additionalProp1":"string"}
  • GETGets an audio stream using HTTP live streaming./Audio/:itemId/main.m3u8?static=true&params=string&tag=string&deviceProfileId=string&playSessionId=string&segmentContainer=string&segmentLength=0&minSegments=0&mediaSourceId=string&deviceId=string&audioCodec=string&enableAutoStreamCopy=true&allowVideoStreamCopy=true&allowAudioStreamCopy=true&breakOnNonKeyFrames=true&audioSampleRate=0&maxAudioBitDepth=0&maxStreamingBitrate=0&audioBitRate=0&audioChannels=0&maxAudioChannels=0&profile=string&level=string&framerate=0.0&maxFramerate=0.0&copyTimestamps=true&startTimeTicks=0&width=0&height=0&videoBitRate=0&subtitleStreamIndex=0&subtitleMethod=Encode&maxRefFrames=0&maxVideoBitDepth=0&requireAvc=true&deInterlace=true&requireNonAnamorphic=true&transcodingMaxAudioChannels=0&cpuCoreLimit=0&liveStreamId=string&enableMpegtsM2TsMode=true&videoCodec=string&subtitleCodec=string&transcodeReasons=string&audioStreamIndex=0&videoStreamIndex=0&context=Streaming&streamOptions={"additionalProp1":"string"}
  • GETGets an audio hls playlist stream./Audio/:itemId/master.m3u8?static=true&params=string&tag=string&deviceProfileId=string&playSessionId=string&segmentContainer=string&segmentLength=0&minSegments=0&mediaSourceId=string&deviceId=string&audioCodec=string&enableAutoStreamCopy=true&allowVideoStreamCopy=true&allowAudioStreamCopy=true&breakOnNonKeyFrames=true&audioSampleRate=0&maxAudioBitDepth=0&maxStreamingBitrate=0&audioBitRate=0&audioChannels=0&maxAudioChannels=0&profile=string&level=string&framerate=0.0&maxFramerate=0.0&copyTimestamps=true&startTimeTicks=0&width=0&height=0&videoBitRate=0&subtitleStreamIndex=0&subtitleMethod=Encode&maxRefFrames=0&maxVideoBitDepth=0&requireAvc=true&deInterlace=true&requireNonAnamorphic=true&transcodingMaxAudioChannels=0&cpuCoreLimit=0&liveStreamId=string&enableMpegtsM2TsMode=true&videoCodec=string&subtitleCodec=string&transcodeReasons=string&audioStreamIndex=0&videoStreamIndex=0&context=Streaming&streamOptions={"additionalProp1":"string"}&enableAdaptiveBitrateStreaming=true
  • HEADGets an audio hls playlist stream./Audio/:itemId/master.m3u8?static=true&params=string&tag=string&deviceProfileId=string&playSessionId=string&segmentContainer=string&segmentLength=0&minSegments=0&mediaSourceId=string&deviceId=string&audioCodec=string&enableAutoStreamCopy=true&allowVideoStreamCopy=true&allowAudioStreamCopy=true&breakOnNonKeyFrames=true&audioSampleRate=0&maxAudioBitDepth=0&maxStreamingBitrate=0&audioBitRate=0&audioChannels=0&maxAudioChannels=0&profile=string&level=string&framerate=0.0&maxFramerate=0.0&copyTimestamps=true&startTimeTicks=0&width=0&height=0&videoBitRate=0&subtitleStreamIndex=0&subtitleMethod=Encode&maxRefFrames=0&maxVideoBitDepth=0&requireAvc=true&deInterlace=true&requireNonAnamorphic=true&transcodingMaxAudioChannels=0&cpuCoreLimit=0&liveStreamId=string&enableMpegtsM2TsMode=true&videoCodec=string&subtitleCodec=string&transcodeReasons=string&audioStreamIndex=0&videoStreamIndex=0&context=Streaming&streamOptions={"additionalProp1":"string"}&enableAdaptiveBitrateStreaming=true
  • GETGets a video stream using HTTP live streaming./Videos/:itemId/hls1/:playlistId/:segmentId.:container?static=true&params=string&tag=string&deviceProfileId=string&playSessionId=string&segmentContainer=string&segmentLength=0&minSegments=0&mediaSourceId=string&deviceId=string&audioCodec=string&enableAutoStreamCopy=true&allowVideoStreamCopy=true&allowAudioStreamCopy=true&breakOnNonKeyFrames=true&audioSampleRate=0&maxAudioBitDepth=0&audioBitRate=0&audioChannels=0&maxAudioChannels=0&profile=string&level=string&framerate=0.0&maxFramerate=0.0&copyTimestamps=true&startTimeTicks=0&width=0&height=0&videoBitRate=0&subtitleStreamIndex=0&subtitleMethod=Encode&maxRefFrames=0&maxVideoBitDepth=0&requireAvc=true&deInterlace=true&requireNonAnamorphic=true&transcodingMaxAudioChannels=0&cpuCoreLimit=0&liveStreamId=string&enableMpegtsM2TsMode=true&videoCodec=string&subtitleCodec=string&transcodeReasons=string&audioStreamIndex=0&videoStreamIndex=0&context=Streaming&streamOptions={"additionalProp1":"string"}
  • GETGets a video stream using HTTP live streaming./Videos/:itemId/main.m3u8?static=true&params=string&tag=string&deviceProfileId=string&playSessionId=string&segmentContainer=string&segmentLength=0&minSegments=0&mediaSourceId=string&deviceId=string&audioCodec=string&enableAutoStreamCopy=true&allowVideoStreamCopy=true&allowAudioStreamCopy=true&breakOnNonKeyFrames=true&audioSampleRate=0&maxAudioBitDepth=0&audioBitRate=0&audioChannels=0&maxAudioChannels=0&profile=string&level=string&framerate=0.0&maxFramerate=0.0&copyTimestamps=true&startTimeTicks=0&width=0&height=0&videoBitRate=0&subtitleStreamIndex=0&subtitleMethod=Encode&maxRefFrames=0&maxVideoBitDepth=0&requireAvc=true&deInterlace=true&requireNonAnamorphic=true&transcodingMaxAudioChannels=0&cpuCoreLimit=0&liveStreamId=string&enableMpegtsM2TsMode=true&videoCodec=string&subtitleCodec=string&transcodeReasons=string&audioStreamIndex=0&videoStreamIndex=0&context=Streaming&streamOptions={"additionalProp1":"string"}
  • GETGets a video hls playlist stream./Videos/:itemId/master.m3u8?static=true&params=string&tag=string&deviceProfileId=string&playSessionId=string&segmentContainer=string&segmentLength=0&minSegments=0&mediaSourceId=string&deviceId=string&audioCodec=string&enableAutoStreamCopy=true&allowVideoStreamCopy=true&allowAudioStreamCopy=true&breakOnNonKeyFrames=true&audioSampleRate=0&maxAudioBitDepth=0&audioBitRate=0&audioChannels=0&maxAudioChannels=0&profile=string&level=string&framerate=0.0&maxFramerate=0.0&copyTimestamps=true&startTimeTicks=0&width=0&height=0&videoBitRate=0&subtitleStreamIndex=0&subtitleMethod=Encode&maxRefFrames=0&maxVideoBitDepth=0&requireAvc=true&deInterlace=true&requireNonAnamorphic=true&transcodingMaxAudioChannels=0&cpuCoreLimit=0&liveStreamId=string&enableMpegtsM2TsMode=true&videoCodec=string&subtitleCodec=string&transcodeReasons=string&audioStreamIndex=0&videoStreamIndex=0&context=Streaming&streamOptions={"additionalProp1":"string"}&enableAdaptiveBitrateStreaming=true
  • HEADGets a video hls playlist stream./Videos/:itemId/master.m3u8?static=true&params=string&tag=string&deviceProfileId=string&playSessionId=string&segmentContainer=string&segmentLength=0&minSegments=0&mediaSourceId=string&deviceId=string&audioCodec=string&enableAutoStreamCopy=true&allowVideoStreamCopy=true&allowAudioStreamCopy=true&breakOnNonKeyFrames=true&audioSampleRate=0&maxAudioBitDepth=0&audioBitRate=0&audioChannels=0&maxAudioChannels=0&profile=string&level=string&framerate=0.0&maxFramerate=0.0&copyTimestamps=true&startTimeTicks=0&width=0&height=0&videoBitRate=0&subtitleStreamIndex=0&subtitleMethod=Encode&maxRefFrames=0&maxVideoBitDepth=0&requireAvc=true&deInterlace=true&requireNonAnamorphic=true&transcodingMaxAudioChannels=0&cpuCoreLimit=0&liveStreamId=string&enableMpegtsM2TsMode=true&videoCodec=string&subtitleCodec=string&transcodeReasons=string&audioStreamIndex=0&videoStreamIndex=0&context=Streaming&streamOptions={"additionalProp1":"string"}&enableAdaptiveBitrateStreaming=true

Audio

  • GETGets an audio stream./Audio/:itemId/stream?container=string&static=true&params=string&tag=string&deviceProfileId=string&playSessionId=string&segmentContainer=string&segmentLength=0&minSegments=0&mediaSourceId=string&deviceId=string&audioCodec=string&enableAutoStreamCopy=true&allowVideoStreamCopy=true&allowAudioStreamCopy=true&breakOnNonKeyFrames=true&audioSampleRate=0&maxAudioBitDepth=0&audioBitRate=0&audioChannels=0&maxAudioChannels=0&profile=string&level=string&framerate=0.0&maxFramerate=0.0&copyTimestamps=true&startTimeTicks=0&width=0&height=0&videoBitRate=0&subtitleStreamIndex=0&subtitleMethod=Encode&maxRefFrames=0&maxVideoBitDepth=0&requireAvc=true&deInterlace=true&requireNonAnamorphic=true&transcodingMaxAudioChannels=0&cpuCoreLimit=0&liveStreamId=string&enableMpegtsM2TsMode=true&videoCodec=string&subtitleCodec=string&transcodeReasons=string&audioStreamIndex=0&videoStreamIndex=0&context=Streaming&streamOptions={"additionalProp1":"string"}
  • HEADGets an audio stream./Audio/:itemId/stream?container=string&static=true&params=string&tag=string&deviceProfileId=string&playSessionId=string&segmentContainer=string&segmentLength=0&minSegments=0&mediaSourceId=string&deviceId=string&audioCodec=string&enableAutoStreamCopy=true&allowVideoStreamCopy=true&allowAudioStreamCopy=true&breakOnNonKeyFrames=true&audioSampleRate=0&maxAudioBitDepth=0&audioBitRate=0&audioChannels=0&maxAudioChannels=0&profile=string&level=string&framerate=0.0&maxFramerate=0.0&copyTimestamps=true&startTimeTicks=0&width=0&height=0&videoBitRate=0&subtitleStreamIndex=0&subtitleMethod=Encode&maxRefFrames=0&maxVideoBitDepth=0&requireAvc=true&deInterlace=true&requireNonAnamorphic=true&transcodingMaxAudioChannels=0&cpuCoreLimit=0&liveStreamId=string&enableMpegtsM2TsMode=true&videoCodec=string&subtitleCodec=string&transcodeReasons=string&audioStreamIndex=0&videoStreamIndex=0&context=Streaming&streamOptions={"additionalProp1":"string"}
  • GETGets an audio stream./Audio/:itemId/stream.:container?static=true&params=string&tag=string&deviceProfileId=string&playSessionId=string&segmentContainer=string&segmentLength=0&minSegments=0&mediaSourceId=string&deviceId=string&audioCodec=string&enableAutoStreamCopy=true&allowVideoStreamCopy=true&allowAudioStreamCopy=true&breakOnNonKeyFrames=true&audioSampleRate=0&maxAudioBitDepth=0&audioBitRate=0&audioChannels=0&maxAudioChannels=0&profile=string&level=string&framerate=0.0&maxFramerate=0.0&copyTimestamps=true&startTimeTicks=0&width=0&height=0&videoBitRate=0&subtitleStreamIndex=0&subtitleMethod=Encode&maxRefFrames=0&maxVideoBitDepth=0&requireAvc=true&deInterlace=true&requireNonAnamorphic=true&transcodingMaxAudioChannels=0&cpuCoreLimit=0&liveStreamId=string&enableMpegtsM2TsMode=true&videoCodec=string&subtitleCodec=string&transcodeReasons=string&audioStreamIndex=0&videoStreamIndex=0&context=Streaming&streamOptions={"additionalProp1":"string"}
  • HEADGets an audio stream./Audio/:itemId/stream.:container?static=true&params=string&tag=string&deviceProfileId=string&playSessionId=string&segmentContainer=string&segmentLength=0&minSegments=0&mediaSourceId=string&deviceId=string&audioCodec=string&enableAutoStreamCopy=true&allowVideoStreamCopy=true&allowAudioStreamCopy=true&breakOnNonKeyFrames=true&audioSampleRate=0&maxAudioBitDepth=0&audioBitRate=0&audioChannels=0&maxAudioChannels=0&profile=string&level=string&framerate=0.0&maxFramerate=0.0&copyTimestamps=true&startTimeTicks=0&width=0&height=0&videoBitRate=0&subtitleStreamIndex=0&subtitleMethod=Encode&maxRefFrames=0&maxVideoBitDepth=0&requireAvc=true&deInterlace=true&requireNonAnamorphic=true&transcodingMaxAudioChannels=0&cpuCoreLimit=0&liveStreamId=string&enableMpegtsM2TsMode=true&videoCodec=string&subtitleCodec=string&transcodeReasons=string&audioStreamIndex=0&videoStreamIndex=0&context=Streaming&streamOptions={"additionalProp1":"string"}

UniversalAudio

  • GETGets an audio stream./Audio/:itemId/universal?container=string&mediaSourceId=string&deviceId=string&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&audioCodec=string&maxAudioChannels=0&transcodingAudioChannels=0&maxStreamingBitrate=0&audioBitRate=0&startTimeTicks=0&transcodingContainer=string&transcodingProtocol=string&maxAudioSampleRate=0&maxAudioBitDepth=0&enableRemoteMedia=true&breakOnNonKeyFrames=true&enableRedirection=true
  • HEADGets an audio stream./Audio/:itemId/universal?container=string&mediaSourceId=string&deviceId=string&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&audioCodec=string&maxAudioChannels=0&transcodingAudioChannels=0&maxStreamingBitrate=0&audioBitRate=0&startTimeTicks=0&transcodingContainer=string&transcodingProtocol=string&maxAudioSampleRate=0&maxAudioBitDepth=0&enableRemoteMedia=true&breakOnNonKeyFrames=true&enableRedirection=true

ApiKey

  • GETGet all keys./Auth/Keys
  • POSTCreate a new api key./Auth/Keys?app=string
  • DELETERemove an api key./Auth/Keys/:key

Session

  • GETGet all password reset providers./Auth/PasswordResetProviders
  • GETGet all auth providers./Auth/Providers
  • GETGets a list of sessions./Sessions?controllableByUserId=3fa85f64-5717-4562-b3fc-2c963f66afa6&deviceId=string&activeWithinSeconds=0
  • POSTUpdates capabilities for a device./Sessions/Capabilities?id=string&playableMediaTypes=string&supportedCommands=MoveUp&supportsMediaControl=false&supportsSync=false&supportsPersistentIdentifier=true
  • POSTUpdates capabilities for a device./Sessions/Capabilities/Full?id=string
  • POSTReports that a session has ended./Sessions/Logout
  • POSTReports that a session is viewing an item./Sessions/Viewing?sessionId=string&itemId=string
  • POSTIssues a full general command to a client./Sessions/:sessionId/Command
  • POSTIssues a general command to a client./Sessions/:sessionId/Command/:command
  • POSTIssues a command to a client to display a message to the user./Sessions/:sessionId/Message?text=string&header=string&timeoutMs=0
  • POSTInstructs a session to play an item./Sessions/:sessionId/Playing?playCommand=PlayNow&itemIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&startPositionTicks=0
  • POSTIssues a playstate command to a client./Sessions/:sessionId/Playing/:command?seekPositionTicks=0&controllingUserId=string
  • POSTIssues a system command to a client./Sessions/:sessionId/System/:command
  • POSTAdds an additional user to a session./Sessions/:sessionId/User/:userId
  • DELETERemoves an additional user from a session./Sessions/:sessionId/User/:userId
  • POSTInstructs a session to browse to an item or view./Sessions/:sessionId/Viewing?itemType=string&itemId=string&itemName=string

Branding

  • GETGets branding configuration./Branding/Configuration
  • GETGets branding css./Branding/Css
  • GETGets branding css./Branding/Css.css

Channels

  • GETGets available channels./Channels?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&startIndex=0&limit=0&supportsLatestItems=true&supportsMediaDeletion=true&isFavorite=true
  • GETGet all channel features./Channels/Features
  • GETGets latest channel items./Channels/Items/Latest?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&startIndex=0&limit=0&filters=IsFolder&fields=AirTime&channelIds=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • GETGet channel features./Channels/:channelId/Features
  • GETGet channel items./Channels/:channelId/Items?folderId=3fa85f64-5717-4562-b3fc-2c963f66afa6&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&startIndex=0&limit=0&sortOrder=string&filters=IsFolder&sortBy=string&fields=AirTime

Collection

  • POSTCreates a new collection./Collections?name=string&ids=string&parentId=3fa85f64-5717-4562-b3fc-2c963f66afa6&isLocked=false
  • POSTAdds items to a collection./Collections/:collectionId/Items?ids=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • DELETERemoves items from a collection./Collections/:collectionId/Items?ids=3fa85f64-5717-4562-b3fc-2c963f66afa6

Devices

  • GETGet Devices./Devices?supportsSync=true&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • DELETEDeletes a device./Devices?id=string
  • GETGet info for a device./Devices/Info?id=string
  • GETGet options for a device./Devices/Options?id=string
  • POSTUpdate device options./Devices/Options?id=string

DisplayPreferences

  • GETGet Display Preferences./DisplayPreferences/:displayPreferencesId?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&client=string
  • POSTUpdate Display Preferences./DisplayPreferences/:displayPreferencesId?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&client=string

Dlna

  • GETGet profile infos./Dlna/ProfileInfos
  • POSTCreates a profile./Dlna/Profiles
  • GETGets the default profile./Dlna/Profiles/Default
  • GETGets a single profile./Dlna/Profiles/:profileId
  • POSTUpdates a profile./Dlna/Profiles/:profileId
  • DELETEDeletes a profile./Dlna/Profiles/:profileId

DlnaServer

  • GETGets a server icon./Dlna/icons/:fileName
  • GETGets Dlna media receiver registrar xml./Dlna/:serverId/ConnectionManager
  • GETGets Dlna media receiver registrar xml./Dlna/:serverId/ConnectionManager/ConnectionManager
  • GETGets Dlna media receiver registrar xml./Dlna/:serverId/ConnectionManager/ConnectionManager.xml
  • POSTProcess a connection manager control request./Dlna/:serverId/ConnectionManager/Control
  • GETGets Dlna content directory xml./Dlna/:serverId/ContentDirectory
  • GETGets Dlna content directory xml./Dlna/:serverId/ContentDirectory/ContentDirectory
  • GETGets Dlna content directory xml./Dlna/:serverId/ContentDirectory/ContentDirectory.xml
  • POSTProcess a content directory control request./Dlna/:serverId/ContentDirectory/Control
  • GETGets Dlna media receiver registrar xml./Dlna/:serverId/MediaReceiverRegistrar
  • POSTProcess a media receiver registrar control request./Dlna/:serverId/MediaReceiverRegistrar/Control
  • GETGets Dlna media receiver registrar xml./Dlna/:serverId/MediaReceiverRegistrar/MediaReceiverRegistrar
  • GETGets Dlna media receiver registrar xml./Dlna/:serverId/MediaReceiverRegistrar/MediaReceiverRegistrar.xml
  • GETGet Description Xml./Dlna/:serverId/description
  • GETGet Description Xml./Dlna/:serverId/description.xml
  • GETGets a server icon./Dlna/:serverId/icons/:fileName

Environment

  • GETGet Default directory browser./Environment/DefaultDirectoryBrowser
  • GETGets the contents of a given directory in the file system./Environment/DirectoryContents?path=string&includeFiles=false&includeDirectories=false
  • GETGets available drives from the server's file system./Environment/Drives
  • GETGets network paths./Environment/NetworkSharesDeprecated.
  • GETGets the parent path of a given path./Environment/ParentPath?path=string
  • POSTValidates path./Environment/ValidatePath

Subtitle

  • GETGets a list of available fallback font files./FallbackFont/Fonts
  • GETGets a fallback font file./FallbackFont/Fonts/:name
  • GETSearch remote subtitles./Items/:itemId/RemoteSearch/Subtitles/:language?isPerfectMatch=true
  • POSTDownloads a remote subtitle./Items/:itemId/RemoteSearch/Subtitles/:subtitleId
  • GETGets the remote subtitles./Providers/Subtitles/Subtitles/:id
  • POSTUpload an external subtitle file./Videos/:itemId/Subtitles
  • DELETEDeletes an external subtitle file./Videos/:itemId/Subtitles/:index
  • GETGets subtitles in a specified format./Videos/:itemId/:mediaSourceId/Subtitles/:index/Stream.:format?endPositionTicks=0&copyTimestamps=false&addVttTimeMap=false&startPositionTicks=0
  • GETGets an HLS subtitle playlist./Videos/:itemId/:mediaSourceId/Subtitles/:index/subtitles.m3u8?segmentLength=0
  • GETGets subtitles in a specified format./Videos/:itemId/:mediaSourceId/Subtitles/:index/:startPositionTicks/Stream.:format?endPositionTicks=0&copyTimestamps=false&addVttTimeMap=false

Genres

  • GETGets all genres from a given item, folder, or the entire library./Genres?startIndex=0&limit=0&searchTerm=string&parentId=3fa85f64-5717-4562-b3fc-2c963f66afa6&fields=AirTime&excludeItemTypes=string&includeItemTypes=string&isFavorite=true&imageTypeLimit=0&enableImageTypes=Primary&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&nameStartsWithOrGreater=string&nameStartsWith=string&nameLessThan=string&enableImages=true&enableTotalRecordCount=true
  • GETGets a genre, by name./Genres/:genreName?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6

TimeSync

  • GETGets the current UTC time./GetUtcTime

ImageByName

  • GETGet all general images./Images/General
  • GETGet General Image./Images/General/:name/:type
  • GETGet all media info images./Images/MediaInfo
  • GETGet media info image./Images/MediaInfo/:theme/:name
  • GETGet all general images./Images/Ratings
  • GETGet rating image./Images/Ratings/:theme/:name

RemoteImage

  • GETGets a remote image./Images/Remote?imageUrl=https://example.com
  • GETGets available remote images for an item./Items/:itemId/RemoteImages?type=Primary&startIndex=0&limit=0&providerName=string&includeAllLanguages=false
  • POSTDownloads a remote image for an item./Items/:itemId/RemoteImages/Download?type=Primary&imageUrl=string
  • GETGets available remote image providers for an item./Items/:itemId/RemoteImages/Providers

Items

  • GETGets items based on a query./Items?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&maxOfficialRating=string&hasThemeSong=true&hasThemeVideo=true&hasSubtitles=true&hasSpecialFeature=true&hasTrailer=true&adjacentTo=string&parentIndexNumber=0&hasParentalRating=true&isHd=true&is4K=true&locationTypes=FileSystem&excludeLocationTypes=FileSystem&isMissing=true&isUnaired=true&minCommunityRating=0.0&minCriticRating=0.0&minPremiereDate=2024-01-01T00:00:00Z&minDateLastSaved=2024-01-01T00:00:00Z&minDateLastSavedForUser=2024-01-01T00:00:00Z&maxPremiereDate=2024-01-01T00:00:00Z&hasOverview=true&hasImdbId=true&hasTmdbId=true&hasTvdbId=true&excludeItemIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&startIndex=0&limit=0&recursive=true&searchTerm=string&sortOrder=string&parentId=3fa85f64-5717-4562-b3fc-2c963f66afa6&fields=AirTime&excludeItemTypes=string&includeItemTypes=string&filters=IsFolder&isFavorite=true&mediaTypes=string&imageTypes=Primary&sortBy=string&isPlayed=true&genres=string&officialRatings=string&tags=string&years=0&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary&person=string&personIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&personTypes=string&studios=string&artists=string&excludeArtistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&artistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&albumArtistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&contributingArtistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&albums=string&albumIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&ids=3fa85f64-5717-4562-b3fc-2c963f66afa6&videoTypes=VideoFile&minOfficialRating=string&isLocked=true&isPlaceHolder=true&hasOfficialRating=true&collapseBoxSetItems=true&minWidth=0&minHeight=0&maxWidth=0&maxHeight=0&is3D=true&seriesStatus=Continuing&nameStartsWithOrGreater=string&nameStartsWith=string&nameLessThan=string&studioIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&genreIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&enableTotalRecordCount=true&enableImages=true
  • GETGets items based on a query./Users/:userId/Items?maxOfficialRating=string&hasThemeSong=true&hasThemeVideo=true&hasSubtitles=true&hasSpecialFeature=true&hasTrailer=true&adjacentTo=string&parentIndexNumber=0&hasParentalRating=true&isHd=true&is4K=true&locationTypes=FileSystem&excludeLocationTypes=FileSystem&isMissing=true&isUnaired=true&minCommunityRating=0.0&minCriticRating=0.0&minPremiereDate=2024-01-01T00:00:00Z&minDateLastSaved=2024-01-01T00:00:00Z&minDateLastSavedForUser=2024-01-01T00:00:00Z&maxPremiereDate=2024-01-01T00:00:00Z&hasOverview=true&hasImdbId=true&hasTmdbId=true&hasTvdbId=true&excludeItemIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&startIndex=0&limit=0&recursive=true&searchTerm=string&sortOrder=string&parentId=3fa85f64-5717-4562-b3fc-2c963f66afa6&fields=AirTime&excludeItemTypes=string&includeItemTypes=string&filters=IsFolder&isFavorite=true&mediaTypes=string&imageTypes=Primary&sortBy=string&isPlayed=true&genres=string&officialRatings=string&tags=string&years=0&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary&person=string&personIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&personTypes=string&studios=string&artists=string&excludeArtistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&artistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&albumArtistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&contributingArtistIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&albums=string&albumIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&ids=3fa85f64-5717-4562-b3fc-2c963f66afa6&videoTypes=VideoFile&minOfficialRating=string&isLocked=true&isPlaceHolder=true&hasOfficialRating=true&collapseBoxSetItems=true&minWidth=0&minHeight=0&maxWidth=0&maxHeight=0&is3D=true&seriesStatus=Continuing&nameStartsWithOrGreater=string&nameStartsWith=string&nameLessThan=string&studioIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&genreIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&enableTotalRecordCount=true&enableImages=true
  • GETGets items based on a query./Users/:userId/Items/Resume?startIndex=0&limit=0&searchTerm=string&parentId=3fa85f64-5717-4562-b3fc-2c963f66afa6&fields=AirTime&mediaTypes=string&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary&excludeItemTypes=string&includeItemTypes=string&enableTotalRecordCount=true&enableImages=true

Filter

  • GETGets legacy query filters./Items/Filters?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&parentId=3fa85f64-5717-4562-b3fc-2c963f66afa6&includeItemTypes=string&mediaTypes=string
  • GETGets query filters./Items/Filters2?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&parentId=3fa85f64-5717-4562-b3fc-2c963f66afa6&includeItemTypes=string&isAiring=true&isMovie=true&isSports=true&isKids=true&isNews=true&isSeries=true&recursive=true

ItemLookup

  • POSTApplies search criteria to an item and refreshes metadata./Items/RemoteSearch/Apply/:itemId?replaceAllImages=true
  • POSTGet book remote search./Items/RemoteSearch/Book
  • POSTGet box set remote search./Items/RemoteSearch/BoxSet
  • GETGets a remote image./Items/RemoteSearch/Image?imageUrl=string&providerName=string
  • POSTGet movie remote search./Items/RemoteSearch/Movie
  • POSTGet music album remote search./Items/RemoteSearch/MusicAlbum
  • POSTGet music artist remote search./Items/RemoteSearch/MusicArtist
  • POSTGet music video remote search./Items/RemoteSearch/MusicVideo
  • POSTGet person remote search./Items/RemoteSearch/Person
  • POSTGet series remote search./Items/RemoteSearch/Series
  • POSTGet trailer remote search./Items/RemoteSearch/Trailer
  • GETGet the item's external id info./Items/:itemId/ExternalIdInfos

ItemUpdate

  • POSTUpdates an item./Items/:itemId
  • POSTUpdates an item's content type./Items/:itemId/ContentType?contentType=string
  • GETGets metadata editor info for an item./Items/:itemId/MetadataEditor

MediaInfo

  • GETGets live playback media info for an item./Items/:itemId/PlaybackInfo?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • POSTGets live playback media info for an item./Items/:itemId/PlaybackInfo?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&maxStreamingBitrate=0&startTimeTicks=0&audioStreamIndex=0&subtitleStreamIndex=0&maxAudioChannels=0&mediaSourceId=string&liveStreamId=string&autoOpenLiveStream=true&enableDirectPlay=true&enableDirectStream=true&enableTranscoding=true&allowVideoStreamCopy=true&allowAudioStreamCopy=trueFor backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence.
  • POSTCloses a media source./LiveStreams/Close?liveStreamId=string
  • POSTOpens a media source./LiveStreams/Open?openToken=string&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&playSessionId=string&maxStreamingBitrate=0&startTimeTicks=0&audioStreamIndex=0&subtitleStreamIndex=0&maxAudioChannels=0&itemId=3fa85f64-5717-4562-b3fc-2c963f66afa6&enableDirectPlay=true&enableDirectStream=true
  • GETTests the network with a request with the size of the bitrate./Playback/BitrateTest?size=102400

ItemRefresh

  • POSTRefreshes metadata for an item./Items/:itemId/Refresh?metadataRefreshMode=None&imageRefreshMode=None&replaceAllMetadata=false&replaceAllImages=false

LibraryStructure

  • GETGets all virtual folders./Library/VirtualFolders
  • POSTAdds a virtual folder./Library/VirtualFolders?name=string&collectionType=string&paths=string&refreshLibrary=false
  • DELETERemoves a virtual folder./Library/VirtualFolders?name=string&refreshLibrary=false
  • POSTUpdate library options./Library/VirtualFolders/LibraryOptions
  • POSTRenames a virtual folder./Library/VirtualFolders/Name?name=string&newName=string&refreshLibrary=false
  • POSTAdd a media path to a library./Library/VirtualFolders/Paths?refreshLibrary=false
  • DELETERemove a media path./Library/VirtualFolders/Paths?name=string&path=string&refreshLibrary=false
  • POSTUpdates a media path./Library/VirtualFolders/Paths/Update?name=string

LiveTv

  • GETGet channel mapping options./LiveTv/ChannelMappingOptions?providerId=string
  • POSTSet channel mappings./LiveTv/ChannelMappings
  • GETGets available live tv channels./LiveTv/Channels?type=TV&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&startIndex=0&isMovie=true&isSeries=true&isNews=true&isKids=true&isSports=true&limit=0&isFavorite=true&isLiked=true&isDisliked=true&enableImages=true&imageTypeLimit=0&enableImageTypes=Primary&fields=AirTime&enableUserData=true&sortBy=string&sortOrder=Ascending&enableFavoriteSorting=false&addCurrentProgram=true
  • GETGets a live tv channel./LiveTv/Channels/:channelId?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • GETGet guid info./LiveTv/GuideInfo
  • GETGets available live tv services./LiveTv/Info
  • POSTAdds a listings provider./LiveTv/ListingProviders?pw=string&validateListings=false&validateLogin=false
  • DELETEDelete listing provider./LiveTv/ListingProviders?id=string
  • GETGets default listings provider info./LiveTv/ListingProviders/Default
  • GETGets available lineups./LiveTv/ListingProviders/Lineups?id=string&type=string&location=string&country=string
  • GETGets available countries./LiveTv/ListingProviders/SchedulesDirect/Countries
  • GETGets a live tv recording stream./LiveTv/LiveRecordings/:recordingId/stream
  • GETGets a live tv channel stream./LiveTv/LiveStreamFiles/:streamId/stream.:container
  • GETGets available live tv epgs./LiveTv/Programs?channelIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&minStartDate=2024-01-01T00:00:00Z&hasAired=true&isAiring=true&maxStartDate=2024-01-01T00:00:00Z&minEndDate=2024-01-01T00:00:00Z&maxEndDate=2024-01-01T00:00:00Z&isMovie=true&isSeries=true&isNews=true&isKids=true&isSports=true&startIndex=0&limit=0&sortBy=string&sortOrder=string&genres=string&genreIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&enableImages=true&imageTypeLimit=0&enableImageTypes=Primary&enableUserData=true&seriesTimerId=string&librarySeriesId=3fa85f64-5717-4562-b3fc-2c963f66afa6&fields=AirTime&enableTotalRecordCount=true
  • POSTGets available live tv epgs./LiveTv/Programs
  • GETGets recommended live tv epgs./LiveTv/Programs/Recommended?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&isAiring=true&hasAired=true&isSeries=true&isMovie=true&isNews=true&isKids=true&isSports=true&enableImages=true&imageTypeLimit=0&enableImageTypes=Primary&genreIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&fields=AirTime&enableUserData=true&enableTotalRecordCount=true
  • GETGets a live tv program./LiveTv/Programs/:programId?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • GETGets live tv recordings./LiveTv/Recordings?channelId=string&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&startIndex=0&limit=0&status=New&isInProgress=true&seriesTimerId=string&enableImages=true&imageTypeLimit=0&enableImageTypes=Primary&fields=AirTime&enableUserData=true&isMovie=true&isSeries=true&isKids=true&isSports=true&isNews=true&isLibraryItem=true&enableTotalRecordCount=true
  • GETGets recording folders./LiveTv/Recordings/Folders?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • GETGets live tv recording groups./LiveTv/Recordings/Groups?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6Deprecated.
  • GETGet recording group./LiveTv/Recordings/Groups/:groupIdDeprecated.
  • GETGets live tv recording series./LiveTv/Recordings/Series?channelId=string&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&groupId=string&startIndex=0&limit=0&status=New&isInProgress=true&seriesTimerId=string&enableImages=true&imageTypeLimit=0&enableImageTypes=Primary&fields=AirTime&enableUserData=true&enableTotalRecordCount=trueDeprecated.
  • GETGets a live tv recording./LiveTv/Recordings/:recordingId?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • DELETEDeletes a live tv recording./LiveTv/Recordings/:recordingId
  • GETGets live tv series timers./LiveTv/SeriesTimers?sortBy=string&sortOrder=Ascending
  • POSTCreates a live tv series timer./LiveTv/SeriesTimers
  • GETGets a live tv series timer./LiveTv/SeriesTimers/:timerId
  • POSTUpdates a live tv series timer./LiveTv/SeriesTimers/:timerId
  • DELETECancels a live tv series timer./LiveTv/SeriesTimers/:timerId
  • GETGets the live tv timers./LiveTv/Timers?channelId=string&seriesTimerId=string&isActive=true&isScheduled=true
  • POSTCreates a live tv timer./LiveTv/Timers
  • GETGets the default values for a new timer./LiveTv/Timers/Defaults?programId=string
  • GETGets a timer./LiveTv/Timers/:timerId
  • POSTUpdates a live tv timer./LiveTv/Timers/:timerId
  • DELETECancels a live tv timer./LiveTv/Timers/:timerId
  • POSTAdds a tuner host./LiveTv/TunerHosts
  • DELETEDeletes a tuner host./LiveTv/TunerHosts?id=string
  • GETGet tuner host types./LiveTv/TunerHosts/Types
  • GETDiscover tuners./LiveTv/Tuners/Discover?newDevicesOnly=false
  • GETDiscover tuners./LiveTv/Tuners/Discvover?newDevicesOnly=false
  • POSTResets a tv tuner./LiveTv/Tuners/:tunerId/Reset

Localization

  • GETGets known countries./Localization/Countries
  • GETGets known cultures./Localization/Cultures
  • GETGets localization options./Localization/Options
  • GETGets known parental ratings./Localization/ParentalRatings

Movies

  • GETGets movie recommendations./Movies/Recommendations?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&parentId=3fa85f64-5717-4562-b3fc-2c963f66afa6&fields=AirTime&categoryLimit=5&itemLimit=8

MusicGenres

  • GETGets all music genres from a given item, folder, or the entire library./MusicGenres?startIndex=0&limit=0&searchTerm=string&parentId=3fa85f64-5717-4562-b3fc-2c963f66afa6&fields=AirTime&excludeItemTypes=string&includeItemTypes=string&isFavorite=true&imageTypeLimit=0&enableImageTypes=Primary&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&nameStartsWithOrGreater=string&nameStartsWith=string&nameLessThan=string&enableImages=true&enableTotalRecordCount=trueDeprecated.
  • GETGets a music genre, by name./MusicGenres/:genreName?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6

Notifications

  • POSTSends a notification to all admins./Notifications/Admin?url=string&level=Normal&name=&description=
  • GETGets notification services./Notifications/Services
  • GETGets notification types./Notifications/Types
  • GETGets a user's notifications./Notifications/:userId
  • POSTSets notifications as read./Notifications/:userId/Read
  • GETGets a user's notification summary./Notifications/:userId/Summary
  • POSTSets notifications as unread./Notifications/:userId/Unread

Package

  • GETGets available packages./Packages
  • POSTInstalls a package./Packages/Installed/:name?assemblyGuid=3fa85f64-5717-4562-b3fc-2c963f66afa6&version=string&repositoryUrl=string
  • DELETECancels a package installation./Packages/Installing/:packageId
  • GETGets a package by name or assembly GUID./Packages/:name?assemblyGuid=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • GETGets all package repositories./Repositories
  • POSTSets the enabled and existing package repositories./Repositories

Persons

  • GETGets all persons./Persons?limit=0&searchTerm=string&fields=AirTime&filters=IsFolder&isFavorite=true&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary&excludePersonTypes=string&personTypes=string&appearsInItemId=3fa85f64-5717-4562-b3fc-2c963f66afa6&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&enableImages=true
  • GETGet person by name./Persons/:name?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6

Playlists

  • POSTCreates a new playlist./Playlists?name=string&ids=3fa85f64-5717-4562-b3fc-2c963f66afa6&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&mediaType=stringFor backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence.
  • GETGets the original items of a playlist./Playlists/:playlistId/Items?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&startIndex=0&limit=0&fields=AirTime&enableImages=true&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary
  • POSTAdds items to a playlist./Playlists/:playlistId/Items?ids=3fa85f64-5717-4562-b3fc-2c963f66afa6&userId=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • DELETERemoves items from a playlist./Playlists/:playlistId/Items?entryIds=string
  • POSTMoves a playlist item./Playlists/:playlistId/Items/:itemId/Move/:newIndex

Plugins

  • GETGets a list of currently installed plugins./Plugins
  • POSTUpdates plugin security info./Plugins/SecurityInfoDeprecated.
  • DELETEUninstalls a plugin./Plugins/:pluginIdDeprecated.
  • GETGets plugin configuration./Plugins/:pluginId/Configuration
  • POSTUpdates plugin configuration./Plugins/:pluginId/ConfigurationAccepts plugin configuration as JSON body.
  • POSTGets a plugin's manifest./Plugins/:pluginId/Manifest
  • DELETEUninstalls a plugin by version./Plugins/:pluginId/:version
  • POSTDisable a plugin./Plugins/:pluginId/:version/Disable
  • POSTEnables a disabled plugin./Plugins/:pluginId/:version/Enable
  • GETGets a plugin's image./Plugins/:pluginId/:version/Image

QuickConnect

  • POSTTemporarily activates quick connect for five minutes./QuickConnect/Activate
  • POSTAuthorizes a pending quick connect request./QuickConnect/Authorize?code=string
  • POSTEnables or disables quick connect./QuickConnect/Available?status=Unavailable
  • GETAttempts to retrieve authentication information./QuickConnect/Connect?secret=string
  • POSTDeauthorize all quick connect devices for the current user./QuickConnect/Deauthorize
  • GETInitiate a new quick connect request./QuickConnect/Initiate
  • GETGets the current quick connect state./QuickConnect/Status

ScheduledTasks

  • GETGet tasks./ScheduledTasks?isHidden=true&isEnabled=true

Showing 300 of 400 endpoints. Fork the collection to see all of them.

API details

Base URL
http://jellyfin.local
http://localhost
Authentication
An API key in the X-Emby-Authorization header
Operations
408 operations on 340 pathsGET 220POST 136DELETE 31HEAD 21
8 marked deprecated
Main resources
LiveTv 41Image 38Library 25SyncPlay 21DlnaServer 16Session 16User 16ItemLookup 12Plugins 10Subtitle 10
Response formats
application/json application/json; profile="camelcase" application/json; profile="pascalcase" image/*
Description format
OpenAPI 3.0.1, API version v1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Jellyfin API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Jellyfin API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-Emby-Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Creates an instant playlist based on a given song.” (GET /Albums/:id/InstantMix?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&limit=0&fields=AirTime&enableImages=true&enableUserData=true&imageTypeLimit=0&enableImageTypes=Primary), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Jellyfin API?

Jellyfin API endpoints from Jellyfin It is listed under Media & content and has 408 endpoints.

Who publishes the Jellyfin API?

It is listed from Jellyfin's public API description (an OpenAPI document), not published by Jellyfin on Swastik Codes. Anyone who controls jellyfin.org can claim the profile by adding a DNS TXT record.

What is the base URL of the Jellyfin API?

Its description lists 2 base URLs: http://jellyfin.local, http://localhost. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Jellyfin API?

With an API key in the X-Emby-Authorization header.

How many endpoints does the Jellyfin API have?

408 operations on 340 paths (220 GET, 136 POST, 31 DELETE, 21 HEAD). The largest groups are LiveTv, Image, Library, SyncPlay. This listing's collection holds the first 400.

Is forking the Jellyfin API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.