jellyfin-api

name	jellyfin-api
description	Jellyfin API skill. Use when working with Jellyfin for System, Auth, Artists. Covers 408 endpoints.
version	1.0.0
generator	lapsh

Jellyfin API

API version: v1

Auth

ApiKey X-Emby-Authorization in header

Base URL

http://localhost

Setup

1. Set your API key in the appropriate header
2. GET /System/ActivityLog/Entries -- verify access
3. POST /Auth/Keys -- create first Keys

Endpoints

408 endpoints across 46 groups. See references/api-spec.lap for full details.

System

Method	Path	Description
GET	/System/ActivityLog/Entries	Gets activity log entries.
GET	/System/Configuration	Gets application configuration.
POST	/System/Configuration	Updates application configuration.
GET	/System/Configuration/{key}	Gets a named configuration.
POST	/System/Configuration/{key}	Updates named configuration.
GET	/System/Configuration/MetadataOptions/Default	Gets a default MetadataOptions object.
POST	/System/MediaEncoder/Path	Updates the path to the media encoder.
GET	/System/Endpoint	Gets information about the request endpoint.
GET	/System/Info	Gets information about the server.
GET	/System/Info/Public	Gets public information about the server.
GET	/System/Logs	Gets a list of available server log files.
GET	/System/Logs/Log	Gets a log file.
GET	/System/Ping	Pings the system.
POST	/System/Ping	Pings the system.
POST	/System/Restart	Restarts the application.
POST	/System/Shutdown	Shuts down the application.
GET	/System/WakeOnLanInfo	Gets wake on lan information.

Auth

Method	Path	Description
GET	/Auth/Keys	Get all keys.
POST	/Auth/Keys	Create a new api key.
DELETE	/Auth/Keys/{key}	Remove an api key.
GET	/Auth/PasswordResetProviders	Get all password reset providers.
GET	/Auth/Providers	Get all auth providers.

Artists

Method	Path	Description
GET	/Artists	Gets all artists from a given item, folder, or the entire library.
GET	/Artists/{name}	Gets an artist by name.
GET	/Artists/AlbumArtists	Gets all album artists from a given item, folder, or the entire library.
GET	/Artists/{name}/Images/{imageType}/{imageIndex}	Get artist image by name.
HEAD	/Artists/{name}/Images/{imageType}/{imageIndex}	Get artist image by name.
GET	/Artists/{id}/InstantMix	Creates an instant playlist based on a given song.
GET	/Artists/{itemId}/Similar	Gets similar items.

Audio

Method	Path	Description
GET	/Audio/{itemId}/stream	Gets an audio stream.
HEAD	/Audio/{itemId}/stream	Gets an audio stream.
GET	/Audio/{itemId}/stream.{container}	Gets an audio stream.
HEAD	/Audio/{itemId}/stream.{container}	Gets an audio stream.
GET	/Audio/{itemId}/hls1/{playlistId}/{segmentId}.{container}	Gets a video stream using HTTP live streaming.
GET	/Audio/{itemId}/main.m3u8	Gets an audio stream using HTTP live streaming.
GET	/Audio/{itemId}/master.m3u8	Gets an audio hls playlist stream.
HEAD	/Audio/{itemId}/master.m3u8	Gets an audio hls playlist stream.
GET	/Audio/{itemId}/hls/{segmentId}/stream.aac	Gets the specified audio segment for an audio item.
GET	/Audio/{itemId}/hls/{segmentId}/stream.mp3	Gets the specified audio segment for an audio item.
GET	/Audio/{itemId}/universal	Gets an audio stream.
HEAD	/Audio/{itemId}/universal	Gets an audio stream.

Branding

Method	Path	Description
GET	/Branding/Configuration	Gets branding configuration.
GET	/Branding/Css	Gets branding css.
GET	/Branding/Css.css	Gets branding css.

Channels

Method	Path	Description
GET	/Channels	Gets available channels.
GET	/Channels/{channelId}/Features	Get channel features.
GET	/Channels/{channelId}/Items	Get channel items.
GET	/Channels/Features	Get all channel features.
GET	/Channels/Items/Latest	Gets latest channel items.

Collections

Method	Path	Description
POST	/Collections	Creates a new collection.
POST	/Collections/{collectionId}/Items	Adds items to a collection.
DELETE	/Collections/{collectionId}/Items	Removes items from a collection.

web

Method	Path	Description
GET	/web/ConfigurationPage	Gets a dashboard configuration page.
GET	/web/ConfigurationPages	Gets the configuration pages.

Devices

Method	Path	Description
GET	/Devices	Get Devices.
DELETE	/Devices	Deletes a device.
GET	/Devices/Info	Get info for a device.
GET	/Devices/Options	Get options for a device.
POST	/Devices/Options	Update device options.

DisplayPreferences

Method	Path	Description
GET	/DisplayPreferences/{displayPreferencesId}	Get Display Preferences.
POST	/DisplayPreferences/{displayPreferencesId}	Update Display Preferences.

Dlna

Method	Path	Description
GET	/Dlna/ProfileInfos	Get profile infos.
POST	/Dlna/Profiles	Creates a profile.
GET	/Dlna/Profiles/{profileId}	Gets a single profile.
DELETE	/Dlna/Profiles/{profileId}	Deletes a profile.
POST	/Dlna/Profiles/{profileId}	Updates a profile.
GET	/Dlna/Profiles/Default	Gets the default profile.
GET	/Dlna/{serverId}/ConnectionManager	Gets Dlna media receiver registrar xml.
GET	/Dlna/{serverId}/ConnectionManager/ConnectionManager	Gets Dlna media receiver registrar xml.
GET	/Dlna/{serverId}/ConnectionManager/ConnectionManager.xml	Gets Dlna media receiver registrar xml.
POST	/Dlna/{serverId}/ConnectionManager/Control	Process a connection manager control request.
GET	/Dlna/{serverId}/ContentDirectory	Gets Dlna content directory xml.
GET	/Dlna/{serverId}/ContentDirectory/ContentDirectory	Gets Dlna content directory xml.
GET	/Dlna/{serverId}/ContentDirectory/ContentDirectory.xml	Gets Dlna content directory xml.
POST	/Dlna/{serverId}/ContentDirectory/Control	Process a content directory control request.
GET	/Dlna/{serverId}/description	Get Description Xml.
GET	/Dlna/{serverId}/description.xml	Get Description Xml.
GET	/Dlna/{serverId}/icons/{fileName}	Gets a server icon.
GET	/Dlna/{serverId}/MediaReceiverRegistrar	Gets Dlna media receiver registrar xml.
POST	/Dlna/{serverId}/MediaReceiverRegistrar/Control	Process a media receiver registrar control request.
GET	/Dlna/{serverId}/MediaReceiverRegistrar/MediaReceiverRegistrar	Gets Dlna media receiver registrar xml.
GET	/Dlna/{serverId}/MediaReceiverRegistrar/MediaReceiverRegistrar.xml

Videos

Method	Path	Description
GET	/Videos/{itemId}/hls1/{playlistId}/{segmentId}.{container}	Gets a video stream using HTTP live streaming.
GET	/Videos/{itemId}/main.m3u8	Gets a video stream using HTTP live streaming.
GET	/Videos/{itemId}/master.m3u8	Gets a video hls playlist stream.
HEAD	/Videos/{itemId}/master.m3u8	Gets a video hls playlist stream.
GET	/Videos/{itemId}/hls/{playlistId}/{segmentId}.{segmentContainer}	Gets a hls video segment.
GET	/Videos/{itemId}/hls/{playlistId}/stream.m3u8	Gets a hls video playlist.
DELETE	/Videos/ActiveEncodings	Stops an active encoding.
GET	/Videos/{itemId}/{mediaSourceId}/Subtitles/{index}/{startPositionTicks}/Stream.{format}	Gets subtitles in a specified format.
GET	/Videos/{itemId}/{mediaSourceId}/Subtitles/{index}/Stream.{format}	Gets subtitles in a specified format.
GET	/Videos/{itemId}/{mediaSourceId}/Subtitles/{index}/subtitles.m3u8	Gets an HLS subtitle playlist.
POST	/Videos/{itemId}/Subtitles	Upload an external subtitle file.
DELETE	/Videos/{itemId}/Subtitles/{index}	Deletes an external subtitle file.
GET	/Videos/{videoId}/{mediaSourceId}/Attachments/{index}	Get video attachment.
GET	/Videos/{itemId}/live.m3u8	Gets a hls live stream.
GET	/Videos/{itemId}/{stream}.{container}	Gets a video stream.
HEAD	/Videos/{itemId}/{stream}.{container}	Gets a video stream.
GET	/Videos/{itemId}/AdditionalParts	Gets additional parts for a video.
DELETE	/Videos/{itemId}/AlternateSources	Removes alternate video sources.
GET	/Videos/{itemId}/stream	Gets a video stream.
HEAD	/Videos/{itemId}/stream	Gets a video stream.

Environment

Method	Path	Description
GET	/Environment/DefaultDirectoryBrowser	Get Default directory browser.
GET	/Environment/DirectoryContents	Gets the contents of a given directory in the file system.
GET	/Environment/Drives	Gets available drives from the server's file system.
GET	/Environment/NetworkShares	Gets network paths.
GET	/Environment/ParentPath	Gets the parent path of a given path.
POST	/Environment/ValidatePath	Validates path.

Items

Method	Path	Description
GET	/Items/Filters	Gets legacy query filters.
GET	/Items/Filters2	Gets query filters.
GET	/Items/{itemId}/Images	Get item image infos.
DELETE	/Items/{itemId}/Images/{imageType}	Delete an item's image.
POST	/Items/{itemId}/Images/{imageType}	Set item image.
GET	/Items/{itemId}/Images/{imageType}	Gets the item's image.
HEAD	/Items/{itemId}/Images/{imageType}	Gets the item's image.
DELETE	/Items/{itemId}/Images/{imageType}/{imageIndex}	Delete an item's image.
POST	/Items/{itemId}/Images/{imageType}/{imageIndex}	Set item image.
GET	/Items/{itemId}/Images/{imageType}/{imageIndex}	Gets the item's image.
HEAD	/Items/{itemId}/Images/{imageType}/{imageIndex}	Gets the item's image.
GET	/Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}	Gets the item's image.
HEAD	/Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}	Gets the item's image.
POST	/Items/{itemId}/Images/{imageType}/{imageIndex}/Index	Updates the index for an item image.
GET	/Items/{id}/InstantMix	Creates an instant playlist based on a given song.
GET	/Items/{itemId}/ExternalIdInfos	Get the item's external id info.
POST	/Items/RemoteSearch/Apply/{itemId}	Applies search criteria to an item and refreshes metadata.
POST	/Items/RemoteSearch/Book	Get book remote search.
POST	/Items/RemoteSearch/BoxSet	Get box set remote search.
GET	/Items/RemoteSearch/Image	Gets a remote image.
POST	/Items/RemoteSearch/Movie

Genres

Method	Path	Description
GET	/Genres	Gets all genres from a given item, folder, or the entire library.
GET	/Genres/{genreName}	Gets a genre, by name.
GET	/Genres/{name}/Images/{imageType}	Get genre image by name.
HEAD	/Genres/{name}/Images/{imageType}	Get genre image by name.
GET	/Genres/{name}/Images/{imageType}/{imageIndex}	Get genre image by name.
HEAD	/Genres/{name}/Images/{imageType}/{imageIndex}	Get genre image by name.

MusicGenres

Method	Path	Description
GET	/MusicGenres/{name}/Images/{imageType}	Get music genre image by name.
HEAD	/MusicGenres/{name}/Images/{imageType}	Get music genre image by name.
GET	/MusicGenres/{name}/Images/{imageType}/{imageIndex}	Get music genre image by name.
HEAD	/MusicGenres/{name}/Images/{imageType}/{imageIndex}	Get music genre image by name.
GET	/MusicGenres/{id}/InstantMix	Creates an instant playlist based on a given song.
GET	/MusicGenres/{name}/InstantMix	Creates an instant playlist based on a given song.
GET	/MusicGenres	Gets all music genres from a given item, folder, or the entire library.
GET	/MusicGenres/{genreName}	Gets a music genre, by name.

Persons

Method	Path	Description
GET	/Persons/{name}/Images/{imageType}	Get person image by name.
HEAD	/Persons/{name}/Images/{imageType}	Get person image by name.
GET	/Persons/{name}/Images/{imageType}/{imageIndex}	Get person image by name.
HEAD	/Persons/{name}/Images/{imageType}/{imageIndex}	Get person image by name.
GET	/Persons	Gets all persons.
GET	/Persons/{name}	Get person by name.

Studios

Method	Path	Description
GET	/Studios/{name}/Images/{imageType}	Get studio image by name.
HEAD	/Studios/{name}/Images/{imageType}	Get studio image by name.
GET	/Studios/{name}/Images/{imageType}/{imageIndex}	Get studio image by name.
HEAD	/Studios/{name}/Images/{imageType}/{imageIndex}	Get studio image by name.
GET	/Studios	Gets all studios from a given item, folder, or the entire library.
GET	/Studios/{name}	Gets a studio by name.

Users

Method	Path	Description
POST	/Users/{userId}/Images/{imageType}	Sets the user image.
DELETE	/Users/{userId}/Images/{imageType}	Delete the user's image.
GET	/Users/{userId}/Images/{imageType}	Get user profile image.
HEAD	/Users/{userId}/Images/{imageType}	Get user profile image.
GET	/Users/{userId}/Images/{imageType}/{imageIndex}	Get user profile image.
HEAD	/Users/{userId}/Images/{imageType}/{imageIndex}	Get user profile image.
POST	/Users/{userId}/Images/{imageType}/{index}	Sets the user image.
DELETE	/Users/{userId}/Images/{imageType}/{index}	Delete the user's image.
GET	/Users/{userId}/Items	Gets items based on a query.
GET	/Users/{userId}/Items/Resume	Gets items based on a query.
POST	/Users/{userId}/PlayedItems/{itemId}	Marks an item as played for user.
DELETE	/Users/{userId}/PlayedItems/{itemId}	Marks an item as unplayed for user.
POST	/Users/{userId}/PlayingItems/{itemId}	Reports that a user has begun playing an item.
DELETE	/Users/{userId}/PlayingItems/{itemId}	Reports that a user has stopped playing an item.
POST	/Users/{userId}/PlayingItems/{itemId}/Progress	Reports a user's playback progress.
GET	/Users/{userId}/Suggestions	Gets suggestions.
GET	/Users	Gets a list of users.
GET	/Users/{userId}	Gets a user by Id.
DELETE	/Users/{userId}	Deletes a user.
POST	/Users/{userId}	Updates a user.
POST	/Users/{userId}/Authenticate	Authenticates a user.
POST	/Users/{userId}/Configuration	Updates a user configuration.

Images

Method	Path	Description
GET	/Images/General	Get all general images.
GET	/Images/General/{name}/{type}	Get General Image.
GET	/Images/MediaInfo	Get all media info images.
GET	/Images/MediaInfo/{theme}/{name}	Get media info image.
GET	/Images/Ratings	Get all general images.
GET	/Images/Ratings/{theme}/{name}	Get rating image.
GET	/Images/Remote	Gets a remote image.

Albums

Method	Path	Description
GET	/Albums/{id}/InstantMix	Creates an instant playlist based on a given song.
GET	/Albums/{itemId}/Similar	Gets similar items.

Playlists

Method	Path	Description
GET	/Playlists/{id}/InstantMix	Creates an instant playlist based on a given song.
POST	/Playlists	Creates a new playlist.
POST	/Playlists/{playlistId}/Items	Adds items to a playlist.
DELETE	/Playlists/{playlistId}/Items	Removes items from a playlist.
GET	/Playlists/{playlistId}/Items	Gets the original items of a playlist.
POST	/Playlists/{playlistId}/Items/{itemId}/Move/{newIndex}	Moves a playlist item.

Songs

Method	Path	Description
GET	/Songs/{id}/InstantMix	Creates an instant playlist based on a given song.

Libraries

Method	Path	Description
GET	/Libraries/AvailableOptions	Gets the library options info.

Library

Method	Path	Description
POST	/Library/Media/Updated	Reports that new movies have been added by an external source.
GET	/Library/MediaFolders	Gets all user media folders.
POST	/Library/Movies/Added	Reports that new movies have been added by an external source.
POST	/Library/Movies/Updated	Reports that new movies have been added by an external source.
GET	/Library/PhysicalPaths	Gets a list of physical paths from virtual folders.
GET	/Library/Refresh	Starts a library scan.
POST	/Library/Series/Added	Reports that new episodes of a series have been added by an external source.
POST	/Library/Series/Updated	Reports that new episodes of a series have been added by an external source.
GET	/Library/VirtualFolders	Gets all virtual folders.
POST	/Library/VirtualFolders	Adds a virtual folder.
DELETE	/Library/VirtualFolders	Removes a virtual folder.
POST	/Library/VirtualFolders/LibraryOptions	Update library options.
POST	/Library/VirtualFolders/Name	Renames a virtual folder.
POST	/Library/VirtualFolders/Paths	Add a media path to a library.
DELETE	/Library/VirtualFolders/Paths	Remove a media path.
POST	/Library/VirtualFolders/Paths/Update	Updates a media path.

Movies

Method	Path	Description
GET	/Movies/{itemId}/Similar	Gets similar items.
GET	/Movies/Recommendations	Gets movie recommendations.

Shows

Method	Path	Description
GET	/Shows/{itemId}/Similar	Gets similar items.
GET	/Shows/{seriesId}/Episodes	Gets episodes for a tv season.
GET	/Shows/{seriesId}/Seasons	Gets seasons for a tv series.
GET	/Shows/NextUp	Gets a list of next up episodes.
GET	/Shows/Upcoming	Gets a list of upcoming episodes.

Trailers

Method	Path	Description
GET	/Trailers/{itemId}/Similar	Gets similar items.
GET	/Trailers	Finds movies and trailers similar to a given trailer.

LiveTv

Method	Path	Description
GET	/LiveTv/ChannelMappingOptions	Get channel mapping options.
POST	/LiveTv/ChannelMappings	Set channel mappings.
GET	/LiveTv/Channels	Gets available live tv channels.
GET	/LiveTv/Channels/{channelId}	Gets a live tv channel.
GET	/LiveTv/GuideInfo	Get guid info.
GET	/LiveTv/Info	Gets available live tv services.
POST	/LiveTv/ListingProviders	Adds a listings provider.
DELETE	/LiveTv/ListingProviders	Delete listing provider.
GET	/LiveTv/ListingProviders/Default	Gets default listings provider info.
GET	/LiveTv/ListingProviders/Lineups	Gets available lineups.
GET	/LiveTv/ListingProviders/SchedulesDirect/Countries	Gets available countries.
GET	/LiveTv/LiveRecordings/{recordingId}/stream	Gets a live tv recording stream.
GET	/LiveTv/LiveStreamFiles/{streamId}/stream.{container}	Gets a live tv channel stream.
GET	/LiveTv/Programs	Gets available live tv epgs.
POST	/LiveTv/Programs	Gets available live tv epgs.
GET	/LiveTv/Programs/{programId}	Gets a live tv program.
GET	/LiveTv/Programs/Recommended	Gets recommended live tv epgs.
GET	/LiveTv/Recordings	Gets live tv recordings.
GET	/LiveTv/Recordings/{recordingId}	Gets a live tv recording.
DELETE	/LiveTv/Recordings/{recordingId}	Deletes a live tv recording.
GET	/LiveTv/Recordings/Folders	Gets recording folders.
GET	/LiveTv/Recordings/Groups	Gets live tv recording groups.
GET	/LiveTv/Recordings/Groups/{groupId}

Localization

Method	Path	Description
GET	/Localization/Countries	Gets known countries.
GET	/Localization/Cultures	Gets known cultures.
GET	/Localization/Options	Gets localization options.
GET	/Localization/ParentalRatings	Gets known parental ratings.

LiveStreams

Method	Path	Description
POST	/LiveStreams/Close	Closes a media source.
POST	/LiveStreams/Open	Opens a media source.

Playback

Method	Path	Description
GET	/Playback/BitrateTest	Tests the network with a request with the size of the bitrate.

Notifications

Method	Path	Description
GET	/Notifications/{userId}	Gets a user's notifications.
POST	/Notifications/{userId}/Read	Sets notifications as read.
GET	/Notifications/{userId}/Summary	Gets a user's notification summary.
POST	/Notifications/{userId}/Unread	Sets notifications as unread.
POST	/Notifications/Admin	Sends a notification to all admins.
GET	/Notifications/Services	Gets notification services.
GET	/Notifications/Types	Gets notification types.

Packages

Method	Path	Description
GET	/Packages	Gets available packages.
GET	/Packages/{name}	Gets a package by name or assembly GUID.
POST	/Packages/Installed/{name}	Installs a package.
DELETE	/Packages/Installing/{packageId}	Cancels a package installation.

Repositories

Method	Path	Description
GET	/Repositories	Gets all package repositories.
POST	/Repositories	Sets the enabled and existing package repositories.

Sessions

Method	Path	Description
POST	/Sessions/Playing	Reports playback has started within a session.
POST	/Sessions/Playing/Ping	Pings a playback session.
POST	/Sessions/Playing/Progress	Reports playback progress within a session.
POST	/Sessions/Playing/Stopped	Reports playback has stopped within a session.
GET	/Sessions	Gets a list of sessions.
POST	/Sessions/{sessionId}/Command	Issues a full general command to a client.
POST	/Sessions/{sessionId}/Command/{command}	Issues a general command to a client.
POST	/Sessions/{sessionId}/Message	Issues a command to a client to display a message to the user.
POST	/Sessions/{sessionId}/Playing	Instructs a session to play an item.
POST	/Sessions/{sessionId}/Playing/{command}	Issues a playstate command to a client.
POST	/Sessions/{sessionId}/System/{command}	Issues a system command to a client.
POST	/Sessions/{sessionId}/User/{userId}	Adds an additional user to a session.
DELETE	/Sessions/{sessionId}/User/{userId}	Removes an additional user from a session.
POST	/Sessions/{sessionId}/Viewing	Instructs a session to browse to an item or view.
POST	/Sessions/Capabilities	Updates capabilities for a device.
POST	/Sessions/Capabilities/Full	Updates capabilities for a device.
POST	/Sessions/Logout	Reports that a session has ended.
POST	/Sessions/Viewing	Reports that a session is viewing an item.

Plugins

Method	Path	Description
GET	/Plugins	Gets a list of currently installed plugins.
DELETE	/Plugins/{pluginId}	Uninstalls a plugin.
DELETE	/Plugins/{pluginId}/{version}	Uninstalls a plugin by version.
POST	/Plugins/{pluginId}/{version}/Disable	Disable a plugin.
POST	/Plugins/{pluginId}/{version}/Enable	Enables a disabled plugin.
GET	/Plugins/{pluginId}/{version}/Image	Gets a plugin's image.
GET	/Plugins/{pluginId}/Configuration	Gets plugin configuration.
POST	/Plugins/{pluginId}/Configuration	Updates plugin configuration.
POST	/Plugins/{pluginId}/Manifest	Gets a plugin's manifest.
POST	/Plugins/SecurityInfo	Updates plugin security info.

QuickConnect

Method	Path	Description
POST	/QuickConnect/Activate	Temporarily activates quick connect for five minutes.
POST	/QuickConnect/Authorize	Authorizes a pending quick connect request.
POST	/QuickConnect/Available	Enables or disables quick connect.
GET	/QuickConnect/Connect	Attempts to retrieve authentication information.
POST	/QuickConnect/Deauthorize	Deauthorize all quick connect devices for the current user.
GET	/QuickConnect/Initiate	Initiate a new quick connect request.
GET	/QuickConnect/Status	Gets the current quick connect state.

ScheduledTasks

Method	Path	Description
GET	/ScheduledTasks	Get tasks.
GET	/ScheduledTasks/{taskId}	Get task by id.
POST	/ScheduledTasks/{taskId}/Triggers	Update specified task triggers.
POST	/ScheduledTasks/Running/{taskId}	Start specified task.
DELETE	/ScheduledTasks/Running/{taskId}	Stop specified task.

Search

Method	Path	Description
GET	/Search/Hints	Gets the search hint result.

Startup

Method	Path	Description
POST	/Startup/Complete	Completes the startup wizard.
GET	/Startup/Configuration	Gets the initial startup wizard configuration.
POST	/Startup/Configuration	Sets the initial startup wizard configuration.
GET	/Startup/FirstUser	Gets the first user.
POST	/Startup/RemoteAccess	Sets remote access and UPnP.
GET	/Startup/User	Gets the first user.
POST	/Startup/User	Sets the user name and password.

FallbackFont

Method	Path	Description
GET	/FallbackFont/Fonts	Gets a list of available fallback font files.
GET	/FallbackFont/Fonts/{name}	Gets a fallback font file.

Providers

Method	Path	Description
GET	/Providers/Subtitles/Subtitles/{id}	Gets the remote subtitles.

SyncPlay

Method	Path	Description
POST	/SyncPlay/Buffering	Notify SyncPlay group that member is buffering.
POST	/SyncPlay/Join	Join an existing SyncPlay group.
POST	/SyncPlay/Leave	Leave the joined SyncPlay group.
GET	/SyncPlay/List	Gets all SyncPlay groups.
POST	/SyncPlay/MovePlaylistItem	Request to move an item in the playlist in SyncPlay group.
POST	/SyncPlay/New	Create a new SyncPlay group.
POST	/SyncPlay/NextItem	Request next item in SyncPlay group.
POST	/SyncPlay/Pause	Request pause in SyncPlay group.
POST	/SyncPlay/Ping	Update session ping.
POST	/SyncPlay/PreviousItem	Request previous item in SyncPlay group.
POST	/SyncPlay/Queue	Request to queue items to the playlist of a SyncPlay group.
POST	/SyncPlay/Ready	Notify SyncPlay group that member is ready for playback.
POST	/SyncPlay/RemoveFromPlaylist	Request to remove items from the playlist in SyncPlay group.
POST	/SyncPlay/Seek	Request seek in SyncPlay group.
POST	/SyncPlay/SetIgnoreWait	Request SyncPlay group to ignore member during group-wait.
POST	/SyncPlay/SetNewQueue	Request to set new playlist in SyncPlay group.
POST	/SyncPlay/SetPlaylistItem	Request to change playlist item in SyncPlay group.
POST	/SyncPlay/SetRepeatMode	Request to set repeat mode in SyncPlay group.
POST	/SyncPlay/SetShuffleMode	Request to set shuffle mode in SyncPlay group.
POST	/SyncPlay/Stop	Request stop in SyncPlay group.
POST	/SyncPlay/Unpause	Request unpause in SyncPlay group.

GetUtcTime

Method	Path	Description
GET	/GetUtcTime	Gets the current UTC time.

Years

Method	Path	Description
GET	/Years	Get years.
GET	/Years/{year}	Gets a year.

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all Entries?" -> GET /System/ActivityLog/Entries
• "List all Keys?" -> GET /Auth/Keys
• "Create a Key?" -> POST /Auth/Keys
• "Delete a Key?" -> DELETE /Auth/Keys/{key}
• "List all Artists?" -> GET /Artists
• "Get Artist details?" -> GET /Artists/{name}
• "List all AlbumArtists?" -> GET /Artists/AlbumArtists
• "List all stream?" -> GET /Audio/{itemId}/stream
• "Get stream.{container} details?" -> GET /Audio/{itemId}/stream.{container}
• "List all Configuration?" -> GET /Branding/Configuration
• "List all Css?" -> GET /Branding/Css
• "List all Css.css?" -> GET /Branding/Css.css
• "List all Channels?" -> GET /Channels
• "List all Features?" -> GET /Channels/{channelId}/Features
• "List all Items?" -> GET /Channels/{channelId}/Items
• "List all Features?" -> GET /Channels/Features
• "List all Latest?" -> GET /Channels/Items/Latest
• "Create a Collection?" -> POST /Collections
• "Create a Item?" -> POST /Collections/{collectionId}/Items
• "List all Configuration?" -> GET /System/Configuration
• "Create a Configuration?" -> POST /System/Configuration
• "Get Configuration details?" -> GET /System/Configuration/{key}
• "List all Default?" -> GET /System/Configuration/MetadataOptions/Default
• "Create a Path?" -> POST /System/MediaEncoder/Path
• "List all ConfigurationPage?" -> GET /web/ConfigurationPage
• "List all ConfigurationPages?" -> GET /web/ConfigurationPages
• "List all Devices?" -> GET /Devices
• "List all Info?" -> GET /Devices/Info
• "List all Options?" -> GET /Devices/Options
• "Create a Option?" -> POST /Devices/Options
• "Get DisplayPreference details?" -> GET /DisplayPreferences/{displayPreferencesId}
• "List all ProfileInfos?" -> GET /Dlna/ProfileInfos
• "Create a Profile?" -> POST /Dlna/Profiles
• "Get Profile details?" -> GET /Dlna/Profiles/{profileId}
• "Delete a Profile?" -> DELETE /Dlna/Profiles/{profileId}
• "List all Default?" -> GET /Dlna/Profiles/Default
• "List all ConnectionManager?" -> GET /Dlna/{serverId}/ConnectionManager
• "List all ConnectionManager?" -> GET /Dlna/{serverId}/ConnectionManager/ConnectionManager
• "List all ConnectionManager.xml?" -> GET /Dlna/{serverId}/ConnectionManager/ConnectionManager.xml
• "Create a Control?" -> POST /Dlna/{serverId}/ConnectionManager/Control
• "List all ContentDirectory?" -> GET /Dlna/{serverId}/ContentDirectory
• "List all ContentDirectory?" -> GET /Dlna/{serverId}/ContentDirectory/ContentDirectory

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP