Start Library Scan
Initiate a full library scan to refresh all media.Endpoint
POST
/Library/RefreshAuthorization
Requires elevation policy (administrator access).Response Codes
204- No Content: Library scan started successfully
Delete Items
Delete one or more items from the library and filesystem.Delete Single Item
Single Item
DELETE /Items/{itemId}
Delete Multiple Items
Multiple Items
DELETE /Items
Path Parameters
The item ID to delete (single item endpoint).
Query Parameters
Comma-delimited item IDs to delete (multiple items endpoint).
Response Codes
204- No Content: Item(s) deleted successfully401- Unauthorized: User does not have permission to delete404- Not Found: Item not found
Get Item Counts
Retrieve item counts for various media types.cURL
Endpoint
GET /Items/Counts
Query Parameters
Get counts from a specific user’s library.
Get counts of favorite items only.
Response
Number of movies in the library.
Number of TV series.
Number of episodes.
Number of music albums.
Number of audio tracks.
Number of music videos.
Number of box sets.
Number of books.
Response Codes
200- Success: Item counts returned
Get Media Folders
Retrieve all user media folders (libraries).cURL
Endpoint
GET /Library/MediaFolders
Query Parameters
Filter by folders that are marked hidden.
Response
Array of media folder objects.
Total number of media folders.
Authorization
Requires elevation policy (administrator access).Response Codes
200- Success: Media folders returned
Get Physical Paths
Get a list of physical paths from virtual folders.cURL
Endpoint
GET /Library/PhysicalPaths
Response
Array of physical path strings.Authorization
Requires elevation policy (administrator access).Response Codes
200- Success: Physical paths returned
Get Item Ancestors
Retrieve all parent items of a specific item.cURL
Endpoint
GET /Items/{itemId}/Ancestors
Path Parameters
The item ID.
Query Parameters
Filter by user ID and attach user data.
Response
Array of BaseItemDto objects representing the parent items, from immediate parent to root.Response Codes
200- Success: Item ancestors returned404- Not Found: Item not found
Get Similar Items
Find items similar to a specific item.cURL
Endpoint
GET /Items/{itemId}/Similar
Also available at:
/Movies/{itemId}/Similar/Shows/{itemId}/Similar/Albums/{itemId}/Similar/Artists/{itemId}/Similar
Path Parameters
The item ID.
Query Parameters
Filter by user ID and attach user data.
Maximum number of similar items to return.
Comma-delimited additional fields to return.
Comma-delimited artist IDs to exclude.
Response
Array of similar items.
Total number of similar items found.
Response Codes
200- Success: Similar items returned
Download Item
Download the original media file for an item.cURL
Endpoint
GET /Items/{itemId}/Download
Path Parameters
The item ID.
Authorization
Requires download policy permission.Response
The media file stream with appropriate content type and filename.Response Codes
200- Success: Media file stream returned404- Not Found: Item not found400- Bad Request: Item does not support downloading
Get Theme Media
Retrieve theme songs and videos for an item.Get Theme Songs
Theme Songs
GET /Items/{itemId}/ThemeSongs
Get Theme Videos
Theme Videos
GET /Items/{itemId}/ThemeVideos
Get All Theme Media
All Theme Media
GET /Items/{itemId}/ThemeMedia
Path Parameters
The item ID.
Query Parameters
Filter by user ID and attach user data.
Whether to search parent items for theme media.
Response
Array of theme media items.
Total number of theme items.
ID of the item that owns the theme media.
Response Codes
200- Success: Theme media returned404- Not Found: Item not found
Virtual Folders
Manage virtual folders (libraries).Get Virtual Folders
Get
GET /Library/VirtualFolders
Add Virtual Folder
Add
POST /Library/VirtualFolders
Remove Virtual Folder
Remove
DELETE /Library/VirtualFolders
Authorization
Requires first-time setup or elevation policy.Response Codes
200- Success: Virtual folders returned (GET)204- No Content: Operation completed successfully (POST/DELETE)404- Not Found: Virtual folder not found (DELETE)