Endpoints

addChatMessage

Adds a message to the chat log.

changePassword

Changes the password of an existing user on the server.

createBookmark

Creates or updates a bookmark.

createInternetRadioStation

Adds a new internet radio station.

createPlaylist

Creates (or updates) a playlist.

createPodcastChannel

Adds a new Podcast channel.

createShare

Creates a public URL that can be used by anyone to stream music or video from the server.

createUser

Creates a new user on the server.

deleteBookmark

Creates or updates a bookmark.

deleteInternetRadioStation

Deletes an existing internet radio station.

deletePlaylist

Deletes a saved playlist.

deletePodcastChannel

Deletes a Podcast channel.

deletePodcastEpisode

Deletes a Podcast episode.

deleteShare

Deletes an existing share.

deleteUser

Deletes an existing user on the server.

download

Downloads a given media file.

downloadPodcastEpisode

Request the server to start downloading a given Podcast episode.

getAlbum

Returns details for an album.

getAlbumInfo

Returns album info.

getAlbumInfo2

Returns album info.

getAlbumList

Returns a list of random, newest, highest rated etc. albums.

getAlbumList2

Returns a list of random, newest, highest rated etc. albums.

getArtist

Returns details for an artist.

getArtistInfo

Returns artist info.

getArtistInfo2

Returns artist info.

getArtists

Returns all artists.

getAvatar

Returns the avatar (personal image) for a user.

getBookmarks

Returns all bookmarks for this user.

getCaptions

Returns captions (subtitles) for a video.

getChatMessages

Returns the current visible (non-expired) chat messages.

getCoverArt

Returns a cover art image.

getGenres

Returns all genres.

getIndexes

Returns an indexed structure of all artists.

getInternetRadioStations

Returns all internet radio stations.

getLicense

Get details about the software license.

getLyrics

Searches for and returns lyrics for a given song.

getLyricsBySongId

Add support for synchronized lyrics, multiple languages, and retrieval by song ID

getMusicDirectory

Returns a listing of all files in a music directory.

getMusicFolders

Returns all configured top-level music folders.

getNewestPodcasts

Returns the most recently published Podcast episodes.

getNowPlaying

Returns what is currently being played by all users.

getOpenSubsonicExtensions

List the OpenSubsonic extensions supported by this server.

getPlaylist

Returns a listing of files in a saved playlist.

getPlaylists

Returns all playlists a user is allowed to play.

getPlayQueue

Returns the state of the play queue for this user.

getPodcasts

Returns all Podcast channels the server subscribes to, and (optionally) their episodes.

getRandomSongs

Returns random songs matching the given criteria.

getScanStatus

Returns the current status for media library scanning.

getShares

Returns information about shared media this user is allowed to manage.

getSimilarSongs

Returns a random collection of songs from the given artist and similar artists.

getSimilarSongs2

Returns a random collection of songs from the given artist and similar artists.

getSong

Returns details for a song.

getSongsByGenre

Returns songs in a given genre.

getStarred

Returns starred songs, albums and artists.

getStarred2

Returns starred songs, albums and artists.

getTopSongs

Returns top songs for the given artist.

getUser

Get details about a given user, including which authorization roles and folder access it has.

getUsers

Get details about all users, including which authorization roles and folder access they have

getVideoInfo

Returns details for a video.

getVideos

Returns all video files.

hls

Downloads a given media file.

jukeboxControl

Controls the jukebox, i.e., playback directly on the server’s audio hardware.

ping

Used to test connectivity with the server.

refreshPodcasts

Requests the server to check for new Podcast episodes.

savePlayQueue

Saves the state of the play queue for this user.

scrobble

Registers the local playback of one or more media files.

search

Returns a listing of files matching the given search criteria. Supports paging through the result.

search2

Returns a listing of files matching the given search criteria. Supports paging through the result.

search3

Returns albums, artists and songs matching the given search criteria. Supports paging through the result.

setRating

Sets the rating for a music file.

star

Attaches a star to a song, album or artist.

startScan

Initiates a rescan of the media libraries.

stream

Streams a given media file.

tokenInfo

Returns information about an API key

unstar

Attaches a star to a song, album or artist.

updateInternetRadioStation

Updates an existing internet radio station.

updatePlaylist

Updates a playlist. Only the owner of a playlist is allowed to update it.

updateShare

Updates the description and/or expiration date for an existing share.

updateUser

Modifies an existing user on the server.