Skip to main content

API6 XML Methods

Let's go through come calls and examples that you can do for each XML method.

With the exception of Binary methods, all responses will return a HTTP 200 response.

Also remember that Binary data methods will not return xml; just the file/data you have requested.

Binary methods will also return:

  • HTTP 400 responses for a bad or incomplete request
  • HTTP 404 responses where the requests data was not found

Auth Methods

Auth methods are used for authenticating or checking the status of your session in an Ampache server.

Remember that the auth parameter does not need to be sent as a parameter in the URL.

HTTP header authentication is supported for the auth parameter where present.

handshake

This is the function that handles verifying a new handshake Takes a timestamp, auth key, and username.

InputTypeDescriptionOptional
'auth'string$passphrase (Timestamp . Password SHA hash) OR (API Key)NO
'user'string$username (Required if login/password authentication)YES
'timestamp'integerUNIXTIME() The timestamp used in seed of password hash (Required if login/password authentication)YES
'version'string$version (API Version that the application understands)YES
  • return
<root>
    <auth>
    <api>
    <session_expire>
    <update>
    <add>
    <clean>
    <songs>
    <albums>
    <artists>
    <genres>
    <playlists>
    <users>
    <catalogs>
    <videos>
    <podcasts>
    <podcast_episodes>
    <shares>
    <licenses>
    <live_streams>
    <labels>
</root>
  • throws
<root><error></root>

Example

goodbye

Destroy a session using the auth parameter.

InputTypeDescriptionOptional
'auth'string(Session ID) destroys the session if it existsNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

lost_password

Email a new password to the user (if allowed) using a reset token.

   $username;
   $key = hash('sha256', 'email');
   auth = hash('sha256', $username . $key);
InputTypeDescriptionOptional
'auth'stringpassword reset tokenNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

ping

This can be called without being authenticated, it is useful for determining if what the status of the server is, and what version it is running/compatible with

InputTypeDescriptionOptional
'auth'string(Session ID) returns version information and extends the session if passedYES
'version'string$version (API Version that the application understands)YES
  • return
<root>
    <session_expire>
    <server>
    <version>
    <compatible>
    <auth>
    <api>
    <update>
    <add>
    <clean>
    <songs>
    <albums>
    <artists>
    <genres>
    <playlists>
    <users>
    <catalogs>
    <videos>
    <podcasts>
    <podcast_episodes>
    <shares>
    <licenses>
    <live_streams>
    <labels>
</root>
  • throws
<root>
    <server>
    <version>
    <compatible>
</root>

Example

register

Register as a new user if allowed. (Requires the username, password and email.)

InputTypeDescriptionOptional
'username'string$usernameNO
'password'stringhash('sha256', $password)NO
'email'stringe.g. (user@gmail.com)NO
'fullname'stringYES
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Non-Data Methods

These methods take no parameters beyond your auth key to return information

system_update

Check Ampache for updates and run the update if there is one.

ACCESS REQUIRED: 100 (Admin)

  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

system_preferences

Get your server preferences

ACCESS REQUIRED: 100 (Admin)

  • return
<root>
    <preferences>
</root>
  • throws
<root><error></root>

Example

users

Get ids and usernames for your site

  • return
<root>
    <user>
</root>
  • throws
<root><error></root>

Example

user_preferences

Get your user preferences

  • return
<root>
    <preference>
</root>

Example

Data Methods

Data methods require additional information and parameters to return information

Perform an advanced search given passed rules. This works in a similar way to the web/UI search pages. You can pass multiple rules as well as joins to create in depth search results.

Rules must be sent in groups of 3 using an int (starting from 1) to designate which rules are combined. Use operator ('and', 'or') to choose whether to join or separate each rule when searching.

Refer to the Advanced Search page for details about creating searches.

NOTE the rules part can be confusing but essentially you can include as many 'arrays' of rules as you want. Just add 1 to the rule value to create a new group of rules.

  • Mandatory Rule Values
    • rule_1
    • rule_1_operator
    • rule_1_input
  • Optional (Metadata searches only)
    • rule_1_subtype
InputTypeDescriptionOptional
operatorstringand, or (whether to match one rule or all)NO
rule_*array[rule_1, rule_1_operator, rule_1_input]NO
rule_*array[rule_2, rule_2_operator, rule_2_input], [etc]YES
typestringsong, album, artist, label, playlist, podcast, podcast_episode, genre, user, videoNO
randomboolean0, 1 (random order of results; default to 0)YES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <song>|<album>|<artist>|<playlist>|<label>|<user>|<video>
</root>
  • throws
<root><error></root>

SONG Example

ARTIST Example

ALBUM Example

albums

This returns albums based on the provided search filters

InputTypeDescriptionOptional
'filter'stringFilter results to match this stringYES
'exact'boolean0, 1 (if true filter is exact = rather than fuzzy LIKE)YES
'add'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified dateYES
'update'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified dateYES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
'include'stringalbums, songs (include child objects in the response)YES
  • return
<root>
    <total_count>
    <album>
</root>
  • throws
<root><error></root>

Example

album

This returns a single album based on the UID provided

InputTypeDescriptionOptional
'filter'stringUID of Album, returns album XMLNO
'include'stringsongs (include child objects in the response)YES
  • return
<root>
    <total_count>
    <album>
</root>
  • throws
<root><error></root>

Example

album_songs

This returns the songs of a specified album

InputTypeDescriptionOptional
'filter'stringUID of Album, returns song XMLNO
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <song>
</root>
  • throws
<root><error></root>

Example

artists

This takes a collection of inputs and returns artist objects.

InputTypeDescriptionOptional
'filter'stringFilter results to match this stringYES
'exact'boolean0, 1 (if true filter is exact = rather than fuzzy LIKE)YES
'add'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified dateYES
'update'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified dateYES
'include'stringalbums, songs (include child objects in the response)YES
'album_artist'boolean0, 1 (if true filter for album artists only)YES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <artist>
</root>
  • throws
<root><error></root>

Example

artist

This returns a single artist based on the UID of said artist

InputTypeDescriptionOptional
'filter'stringUID of Artist, returns artist XMLNO
'include'stringalbums, songs (include child objects in the response)YES
  • return
<root>
    <total_count>
    <artist>
</root>
  • throws
<root><error></root>

Example

artist_albums

This returns the albums of an artist

InputTypeDescriptionOptional
'filter'stringUID of Artist, returns Album XMLNO
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <album>
</root>
  • throws
<root><error></root>

Example

artist_songs

This returns the songs of the specified artist

InputTypeDescriptionOptional
'filter'stringUID of Artist, returns Song XMLNO
'top50'boolean0, 1 (if true filter to the artist top 50)YES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <song>
</root>
  • throws
<root><error></root>

Example

bookmarks

Get information about bookmarked media this user is allowed to manage.

InputTypeDescriptionOptional
'client'stringfilter by the agent/client nameYES
'include'integer0,1, if true include the object in the bookmarkYES
  • return
<root>
    <bookmark>
</root>
  • throws
<root><error></root>

Example Example (with include)

bookmark

Get a single bookmark by bookmark_id

InputTypeDescriptionOptional
'filter'stringbookmark_idYES
'include'integer0,1, if true include the object in the bookmarkYES
  • return
<root>
    <bookmark>
</root>
  • throws
<root><error></root>

Example Example (with include)

bookmark_create

Create a placeholder for the current media that you can return to later.

InputTypeDescriptionOptional
'filter'string$object_id to findNO
'type'stringsong, video, podcast_episode (object_type)NO
'position'integercurrent track time in secondsNO
'client'stringAgent string.YES
'date'integerupdate time (Default: UNIXTIME())YES
'include'integer0,1, if true include the object in the bookmarkYES
  • return
<root>
    <bookmark>
</root>
  • throws
<root><error></root>

Example

bookmark_delete

Delete an existing bookmark. (if it exists)

InputTypeDescriptionOptional
'filter'string$object_id to deleteNO
'type'stringsong, video, podcast_episode (object_type)NO
'client'stringAgent string.YES
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

bookmark_edit

Edit a placeholder for the current media that you can return to later.

InputTypeDescriptionOptional
'filter'string$object_id to findNO
'type'stringsong, video, podcast_episode (object_type)NO
'position'integercurrent track time in secondsNO
'client'stringAgent string.YES
'date'integerupdate time (Default: UNIXTIME())YES
'include'integer0,1, if true include the object in the bookmarkYES
  • return
<root>
    <bookmark>
</root>
  • throws
<root><error></root>

Example

browse

Return children of a parent object in a folder traversal/browse style. If you don't send any parameters you'll get a catalog list (the 'root' path)

NOTE Catalog ID is required on 'artist', 'album', 'podcast' so you can filter the browse correctly

InputTypeDescriptionOptional
'filter'stringobject_idYES
'type'string'root', 'catalog', 'artist', 'album', 'podcast'YES
'filter'stringcatalog ID you are browsingYES
'add'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified dateYES
'update'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified dateYES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <browse>
</root>
  • throws
<root><error></root>

Example

Example: music catalog

Example: podcast catalog

Example: video catalog

Example: artist

Example: album

Example: podcast

catalogs

This searches the catalogs and returns... catalogs

InputTypeDescriptionOptional
'filter'stringmusic, clip, tvshow, movie, personal_video, podcast (Catalog type)YES
  • return
<root>
    <total_count>
    <catalog>
</root>
  • throws
<root><error></root>

Example

catalog

Return catalog by UID

InputTypeDescriptionOptional
'filter'stringUID of CatalogNO
  • return
<root>
    <total_count>
    <catalog>
</root>
  • throws
<root><error></root>

Example

catalog_action

Kick off a catalog update or clean for the selected catalog

ACCESS REQUIRED: 75 (Catalog Manager)

InputTypeDescriptionOptional
'task'stringadd_to_catalog, clean_catalogNO
'catalog'integer$catalog_idNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example: clean_catalog

Example: add_to_catalog

catalog_add

Create a public url that can be used by anyone to stream media. Takes the file id with optional description and expires parameters.

ACCESS REQUIRED: 75 (Catalog Manager)

InputTypeDescriptionOptional
'name'stringName for the catalogNO
'path'stringURL or folder path for your catalogNO
'type'string'local', 'beets', 'remote', 'subsonic', 'seafile', 'beetsremote' Default: localYES
'media_type'string'music', 'podcast', 'clip', 'tvshow', 'movie', 'personal_video' Default: 'music'YES
'file_pattern'stringPattern used identify tags from the file name. Default: '%T - %t'YES
'folder_pattern'stringPattern used identify tags from the folder name. Default: '%a/%A'YES
'username'stringlogin to remote catalog ('remote', 'subsonic', 'seafile', 'beetsremote')YES
'password'stringpassword to remote catalog ('remote', 'subsonic', 'seafile', 'beetsremote')YES
  • return
<root>
    <total_count>
    <catalog>
</root>
  • throws
<root><error></root>

Example

catalog_delete

Delete an existing catalog.

ACCESS REQUIRED: 75 (Catalog Manager)

InputTypeDescriptionOptional
'filter'stringUID of catalog to deleteNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

catalog_file

Perform actions on local catalog files. Single file versions of catalog add, clean, verify and remove (delete) Make sure you remember to urlencode those file names!

ACCESS REQUIRED: 50 (Content Manager)

InputTypeDescriptionOptional
'file'stringFULL path to local fileNO
'task'stringadd, clean, verify, remove (can include comma-separated values)NO
'catalog'integer$catalog_idNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

catalog_folder

Perform actions on local catalog folders. Single folder versions of catalog add, clean, verify and remove (delete) Make sure you remember to urlencode those folder names!

ACCESS REQUIRED: 50 (Content Manager)

InputTypeDescriptionOptional
'folder'stringFULL path to local folderNO
'task'stringadd, clean, verify, remove (can include comma-separated values)NO
'catalog'integer$catalog_idNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

deleted_podcast_episodes

This returns the episodes for a podcast that have been deleted

InputTypeDescriptionOptional
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <deleted_podcast_episode>
</root>
  • throws
<root><error></root>

Example

deleted_songs

Returns songs that have been deleted from the server

InputTypeDescriptionOptional
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <deleted_song>
</root>
  • throws
<root><error></root>

Example

deleted_videos

This returns video objects that have been deleted

InputTypeDescriptionOptional
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <deleted_video>
</root>
  • throws
<root><error></root>

Example

flag

This flags a library item as a favorite

  • Setting flag to true (1) will set the flag
  • Setting flag to false (0) will remove the flag
InputTypeDescriptionOptional
'type'stringsong, album, artist, playlist, podcast, podcast_episode, video, tvshow, tvshow_seasonNO
'id'integer$object_idNO
'flag'boolean0, 1NO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

followers

This gets the followers for the requested username

InputTypeDescriptionOptional
'username'stringUsername of the user for who to get followers listNO
  • return
<root>
    <user>
</root>
  • throws
<root><error></root>

Example

following

Get a list of people that this user follows

InputTypeDescriptionOptional
'username'string(Username of the user for who to get following listNO
  • return
<root>
    <user>
</root>
  • throws
<root><error></root>

Example

friends_timeline

This get current user friends timeline

InputTypeDescriptionOptional
'limit'integerMaximum number of results to returnYES
'since'integerUNIXTIME()NO
  • return
<root>
    <activity>
</root>
  • throws
<root><error></root>

Example

genres

This returns the genres (Tags) based on the specified filter

InputTypeDescriptionOptional
'filter'stringFilter results to match this stringYES
'exact'boolean0, 1 (if true filter is exact = rather than fuzzy LIKE)YES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <genre>
</root>
  • throws
<root><error></root>

Example

genre

This returns a single genre based on UID. All XML Documents that have a <genre></genre> element may have 0 or more genre elements associated with them. Each genre element has an attribute "count" that indicates the number of people who have specified this genre.

InputTypeDescriptionOptional
'filter'stringUID of genre, returns genre XMLNO
  • return
<root>
    <total_count>
    <genre>
</root>
  • throws
<root><error></root>

Example

genre_albums

This returns the albums associated with the genre in question

InputTypeDescriptionOptional
'filter'stringUID of genre, returns album XMLYES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <album>
</root>
  • throws
<root><error></root>

Example

genre_artists

This returns the artists associated with the genre in question as defined by the UID

InputTypeDescriptionOptional
'filter'stringUID of genre, returns artist XMLYES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <artist>
</root>
  • throws
<root><error></root>

Example

genre_songs

returns the songs for this genre

InputTypeDescriptionOptional
'filter'stringUID of genre, returns song XMLYES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <song>
</root>
  • throws
<root><error></root>

Example

get_bookmark

Get the bookmark from it's object_id and object_type. By default; get only the most recent bookmark. Use all to retrieve all media bookmarks for the object.

InputTypeDescriptionOptional
'filter'string$object_id to findNO
'type'stringsong, video, podcast_episode (object_type)NO
'include'integer0,1, if true include the object in the bookmarkYES
'all'integer0,1, if true include every bookmark for the objectYES
  • return
<root>
    <bookmark>
</root>
  • throws
<root><error></root>

Example Example (with include)

get_indexes

This takes a collection of inputs and returns ID + name for the object type

NOTE This method is depreciated and will be removed in API7 (Use list)

InputTypeDescriptionOptional
'type'stringsong, album, artist, album_artist, playlist, podcast, podcast_episode, live_streamNO
'filter'stringValue is Alpha Match for returned results, may be more than one letter/numberYES
'update'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified dateYES
'include'boolean0, 1 (include songs in a playlist or episodes in a podcast)YES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
'hide_search'integer0, 1 (if true do not include searches/smartlists in the result)YES
  • return
<root>
    <total_count>
    <song>|<album>|<artist>|<playlist>|<podcast>
</root>
  • throws
<root><error></root>

SONGS Example

ARTIST Example

ALBUM Example

PLAYLIST Example

PODCAST Example

get_similar

Return similar artist id's or similar song ids compared to the input filter

InputTypeDescriptionOptional
'type'stringsong, artistNO
'filter'integerartist id or song idNO
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <song>|<artist>
</root>
  • throws
<root><error></root>

Example

index

This takes a collection of inputs and returns ID + name for the object type

InputTypeDescriptionOptional
'type'stringcatalog, song, album, artist, album_artist, song_artist, playlist, podcast, podcast_episode, share, video, live_streamNO
'filter'stringValue is Alpha Match for returned results, may be more than one letter/numberYES
'exact'boolean0, 1 (if true filter is exact = rather than fuzzy LIKE)YES
'add'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified dateYES
'update'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified dateYES
'include'boolean0, 1 (include songs in a playlist or episodes in a podcast)YES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
'hide_search'integer0, 1 (if true do not include searches/smartlists in the result)YES
  • return
<root>
    <total_count>
    <catalog>|<song>|<album>|<artist>|<album_artist>|<song_artist>|<playlist>|<podcast>|<podcast_episode>|<share>|<video>|<live_stream>
</root>
  • throws
<root><error></root>

SONGS Example

ARTIST Example

ALBUM Example

PLAYLIST Example

PODCAST Example

SONG Example (with include)

ARTIST Example (with include)

ALBUM Example (with include)

PLAYLIST Example (with include)

labels

This returns labels based on the specified filter

InputTypeDescriptionOptional
'filter'stringFilter results to match this stringYES
'exact'boolean0, 1 (if true filter is exact = rather than fuzzy LIKE)YES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <label>
</root>
  • throws
<root><error></root>

Example

label

This returns a single label

InputTypeDescriptionOptional
'filter'stringUID of label, returns label XMLNO
  • return
<root>
    <total_count>
    <label>
</root>
  • throws
<root><error></root>

Example

label_artists

This returns the artists for a label

InputTypeDescriptionOptional
'filter'stringUID of label, returns artist XMLNO
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <artist>
</root>
  • throws
<root><error></root>

Example

last_shouts

This gets the latest posted shouts

InputTypeDescriptionOptional
'username'stringGet latest shouts for this usernameYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <shout>
</root>
  • throws
<root><error></root>

Example

license

This returns a single license

InputTypeDescriptionOptional
'filter'stringUID of license, returns license XMLNO
  • return
<root>
    <total_count>
    <license>
</root>
  • throws
<root><error></root>

Example

license_songs

This returns the songs for a license

InputTypeDescriptionOptional
'filter'stringUID of license, returns song XMLNO
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <song>
</root>
  • throws
<root><error></root>

Example

licenses

This returns licenses based on the specified filter

InputTypeDescriptionOptional
'filter'stringFilter results to match this stringYES
'exact'boolean0, 1 (if true filter is exact = rather than fuzzy LIKE)YES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <license>
</root>
  • throws
<root><error></root>

Example

list

This takes a named array of objects and returning id, name, prefix and basename

NOTE This method replaces get_indexes and does not have the include parameter and does not include children in the response.

InputTypeDescriptionOptional
'type'stringsong, album, artist, album_artist, playlist, podcast, podcast_episode, live_streamNO
'filter'stringValue is Alpha Match for returned results, may be more than one letter/numberYES
'update'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified dateYES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
'hide_search'integer0, 1 (if true do not include searches/smartlists in the result)YES
  • return
<root>
    <total_count>
    <list>
</root>
  • throws
<root><error></root>

Example

live_streams

This returns live_streams based on the specified filter

InputTypeDescriptionOptional
'filter'stringFilter results to match this stringYES
'exact'boolean0, 1 (if true filter is exact = rather than fuzzy LIKE)YES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <live_stream>
</root>
  • throws
<root><error></root>

Example

live_stream

This returns a single live_stream

InputTypeDescriptionOptional
'filter'stringUID of live_stream, returns live_stream XMLNO
  • return
<root>
    <total_count>
    <live_stream>
</root>
  • throws
<root><error></root>

Example

live_stream_create

Create a live_stream (radio station) object.

ACCESS REQUIRED: 50 (Content Manager) permission to create and edit live_streams

InputTypeDescriptionOptional
'filter'string$object_id to findNO
'type'stringsong, video, podcast_episode (object_type)NO
'position'integercurrent track time in secondsNO
'client'stringAgent string. (Default: 'AmpacheAPI')YES
'date'integerupdate time (Default: UNIXTIME())YES
  • return
<root>
    <live_stream>
</root>
  • throws
<root><error></root>

Example

live_stream_delete

Delete an existing live_stream (radio station). (if it exists)

ACCESS REQUIRED: 50 (Content Manager) permission to create and edit live_streams

InputTypeDescriptionOptional
'filter'string$object_id to deleteNO
'type'stringsong, video, podcast_episode (object_type)NO
'client'stringAgent string. (Default: 'AmpacheAPI')YES
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

live_stream_edit

Edit a live_stream (radio station) object.

ACCESS REQUIRED: 50 (Content Manager) permission to create and edit live_streams

InputTypeDescriptionOptional
'filter'string$object_id to findNO
'type'stringsong, video, podcast_episode (object_type)NO
'position'integercurrent track time in secondsNO
'client'stringAgent string. (Default: 'AmpacheAPI')YES
'date'integerupdate time (Default: UNIXTIME())YES
  • return
<root>
    <live_stream>
</root>
  • throws
<root><error></root>

Example

playlists

This returns playlists based on the specified filter

InputTypeDescriptionOptional
'filter'stringFilter results to match this stringYES
'exact'boolean0, 1 (if true filter is exact = rather than fuzzy LIKE)YES
'add'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified dateYES
'update'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified dateYES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
'hide_search'integer0, 1 (if true do not include searches/smartlists in the result)YES
'show_dupes'integer0, 1 (if true if true ignore 'api_hide_dupe_searches' setting)YES
  • return
<root>
    <total_count>
    <playlist>
</root>
  • throws
<root><error></root>

Example

playlist

This returns a single playlist

InputTypeDescriptionOptional
'filter'stringUID of playlist, returns playlist XMLNO
  • return
<root>
    <total_count>
    <playlist>
</root>
  • throws
<root><error></root>

Example

playlist_add

This adds a song to a playlist. setting check=1 will not add duplicates to the playlist

InputTypeDescriptionOptional
'filter'stringUID of PlaylistNO
'id'stringUID of the object to add to playlistNO
'type'string'song', 'album', 'artist', 'playlist'NO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

playlist_add_song

This adds a song to a playlist. setting check=1 will not add duplicates to the playlist

NOTE This method is depreciated and will be removed in API7 (Use playlist_add)

InputTypeDescriptionOptional
'filter'stringUID of PlaylistNO
'song'stringUID of song to add to playlistNO
'check'boolean0, 1 Whether to check and ignore duplicates (default = 0)YES
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

playlist_create

This create a new playlist and return it

InputTypeDescriptionOptional
'name'stringPlaylist nameNO
'type'stringpublic, private (Playlist type)YES
  • return
<root>
    <total_count>
    <playlist>
</root>
  • throws
<root><error></root>

Example

playlist_delete

This deletes a playlist

InputTypeDescriptionOptional
'filter'stringUID of PlaylistNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

playlist_edit

This modifies name and type of a playlist Previously name and type were mandatory while filter wasn't. this has been reversed.

NOTE items and tracks must be sent together and be of equal length

InputTypeDescriptionOptional
'filter'stringUID of PlaylistNO
'name'stringPlaylist nameYES
'type'stringpublic, private (Playlist type)YES
'owner'stringChange playlist owner to the user id (-1 = System playlist)YES
'items'stringcomma-separated song_id's (replaces existing items with a new id)YES
'tracks'stringcomma-separated playlisttrack numbers matched to 'items' in orderYES
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

playlist_generate

Get a list of song XML, indexes or id's based on some simple search criteria 'recent' will search for tracks played after 'Popular Threshold' days 'forgotten' will search for tracks played before 'Popular Threshold' days 'unplayed' added in 400002 for searching unplayed tracks

Note when using the 'id' format total_count is not returned.

InputTypeDescriptionOptional
'mode'stringrecent, forgotten, unplayed, random (default = 'random')YES
'filter'stringstring LIKE matched to song titleYES
'album'integer$album_idYES
'artist'integer$artist_idYES
'flag'integer0, 1 (get flagged songs only. default = 0)YES
'format'stringsong, index, id (default = 'song')YES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <song>|<index>|<id>
</root>
  • throws
<root><error></root>

SONG Example

INDEX Example

ID Example

playlist_remove_song

This remove a song from a playlist. Previous versions required 'track' instead of 'song'.

InputTypeDescriptionOptional
'filter'stringUID of PlaylistNO
'song'stringUID of song to remove from playlistYES
'track'integerTrack number to remove from playlistYES
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

playlist_songs

This returns the songs for a playlist

InputTypeDescriptionOptional
'filter'stringUID of Playlist, returns song XMLNO
'random'integer0, 1 (if true get random songs using limit)YES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <song>
</root>
  • throws
<root><error></root>

Example

podcast

Get the podcast from it's id.

InputTypeDescriptionOptional
'filter'stringUID of podcast, returns podcast XMLNO
'include'stringepisodes (include podcast_episodes in the response)YES
  • return
<root>
    <total_count>
    <podcast>
</root>
  • throws
<root><error></root>

Example

podcasts

Get information about podcasts

InputTypeDescriptionOptional
'filter'stringValue is Alpha Match for returned results, may be more than one letter/numberYES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
'include'stringepisodes (include podcast_episodes in the response)YES
  • return
<root>
    <total_count>
    <podcast>
</root>
  • throws
<root><error></root>

Example

podcast_create

Create a podcast that can be used by anyone to stream media. Takes the url and catalog parameters.

ACCESS REQUIRED: 75 (Catalog Manager)

InputTypeDescriptionOptional
'url'stringrss url for podcastNO
'catalog'stringpodcast catalogNO
  • return
<root>
    <total_count>
    <podcast>
</root>
  • throws
<root><error></root>

Example

podcast_delete

Delete an existing podcast.

ACCESS REQUIRED: 75 (Catalog Manager)

InputTypeDescriptionOptional
'filter'stringUID of podcast to deleteNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

podcast_edit

Update the description and/or expiration date for an existing podcast. Takes the podcast id to update with optional description and expires parameters.

ACCESS REQUIRED: 50 (Content Manager)

InputTypeDescriptionOptional
'filter'stringAlpha-numeric search termNO
'feed'stringfeed rss xml urlYES
'title'stringtitle stringYES
'website'stringsource website urlYES
'description'stringYES
'generator'stringYES
'copyright'stringYES
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

podcast_episodes

This returns the episodes for a podcast

InputTypeDescriptionOptional
'filter'stringUID of podcastNO
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <podcast_episode>
</root>
  • throws
<root><error></root>

Example

podcast_episode

Get the podcast_episode from it's id.

InputTypeDescriptionOptional
'filter'stringpodcast_episode ID numberNO
  • return
<root>
    <total_count>
    <podcast_episode>
</root>
  • throws
<root><error></root>

Example

podcast_episode_delete

Delete an existing podcast_episode.

InputTypeDescriptionOptional
'filter'stringUID of podcast_episode to deleteNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

preference_create

Add a new preference to your server

ACCESS REQUIRED: 100 (Admin)

InputTypeDescriptionOptional
'filter'stringPreference name e.g ('notify_email', 'ajax_load')NO
'type'stringboolean, integer, string, specialNO
'default'mixedstring or integer default valueNO
'category'stringinterface, internal, options, playlist, plugins, streamingNO
'description'stringYES
'subcategory'stringYES
'level'integeraccess level required to change the value (default 100)YES
  • return
<root>
    <preference>
</root>
  • throws
<root><error></root>

Example

preference_delete

Delete a non-system preference by name

ACCESS REQUIRED: 100 (Admin)

InputTypeDescriptionOptional
'filter'stringPreference name e.g ('notify_email', 'ajax_load')NO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

preference_edit

Edit a preference value and apply to all users if allowed

ACCESS REQUIRED: 100 (Admin)

InputTypeDescriptionOptional
'filter'stringPreference name e.g ('notify_email', 'ajax_load')NO
'value'mixed(string/integer) Preference valueNO
'all'boolean0, 1 apply to all usersYES
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

rate

This rates a library item

InputTypeDescriptionOptional
'type'stringsong, album, artist, playlist, podcast, podcast_episode, video, tvshow, tvshow_seasonNO
'id'stringlibrary item idNO
'rating'integerrating between 0-5NO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

record_play

Take a song_id and update the object_count and user_activity table with a play. This allows other sources to record play history to Ampache.

If you don't supply a user id (optional) then just fall back to you.

ACCESS REQUIRED: 100 (Admin) permission to change another user's play history

InputTypeDescriptionOptional
'id'integer$object_idNO
'user'integer$user_idYES
'client'string$agentYES
'date'integerUNIXTIME()YES
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

scrobble

Search for a song using text info and then record a play if found. This allows other sources to record play history to ampache

InputTypeDescriptionOptional
'song'stringHTML encoded stringNO
'artist'stringHTML encoded stringNO
'album'stringHTML encoded stringNO
'songmbid'stringsong_mbid also supportedYES
'artistmbid'stringartist_mbid also supportedYES
'albummbid'stringalbum_mbid also supportedYES
'date'integerUNIXTIME()YES
'client'string$agentYES
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

search_group

Perform a group search given passed rules. This function will return multiple object types if the rule names match the object type. You can pass multiple rules as well as joins to create in depth search results.

Limit and offset are applied per object type. Meaning with a limit of 10 you will return 10 objects of each type not 10 results total.

Rules must be sent in groups of 3 using an int (starting from 1) to designate which rules are combined. Use operator ('and', 'or') to choose whether to join or separate each rule when searching.

Refer to the Advanced Search page for details about creating searches.

NOTE the rules part can be confusing but essentially you can include as many 'arrays' of rules as you want. Just add 1 to the rule value to create a new group of rules.

  • Mandatory Rule Values
    • rule_1
    • rule_1_operator
    • rule_1_input
  • Optional (Metadata searches only)
    • rule_1_subtype

NOTE the type parameter is different from the regular advanced_search method. Each type is a grouping of object types so allow single search calls to be made

  • all

    • song
    • album
    • song_artist
    • album_artist
    • artist
    • label
    • playlist
    • podcast
    • podcast_episode
    • genre
    • user
  • music

    • song
    • album
    • artist
  • song_artist

    • song
    • album
    • song_artist
  • album_artist

    • song
    • album
    • album_artist
  • podcast

    • podcast
    • podcast_episode
  • video

    • video
InputTypeDescriptionOptional
operatorstringand, or (whether to match one rule or all)NO
rule_*array[rule_1, rule_1_operator, rule_1_input]NO
rule_*array[rule_2, rule_2_operator, rule_2_input], [etc]YES
typestringall, music, song_artist, album_artist, podcast, video (all by default)YES
randomboolean0, 1 (random order of results; default to 0)YES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <search>
        <song>|<album>|<song_artist>|<album_artist>|<artist>|<label>|<playlist>|<podcast>|<podcast_episode>|<genre>|<user>
    </search>
</root>
  • throws
<root><error></root>

ALL Example

MUSIC Example

PODCAST Example

search_songs

This searches the songs and returns... songs

InputTypeDescriptionOptional
'filter'stringFilter results to match this stringNO
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <song>
</root>
  • throws
<root><error></root>

Example

shares

This searches the shares and returns... shares

InputTypeDescriptionOptional
'filter'stringFilter results to match this stringYES
'exact'boolean0, 1 boolean to match the exact filter stringYES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <share>
</root>
  • throws
<root><error></root>

Example

share

Return shares by UID

InputTypeDescriptionOptional
'filter'stringUID of Share, returns song XMLNO
  • return
<root>
    <total_count>
    <share>
</root>
  • throws
<root><error></root>

Example

share_create

Create a public url that can be used by anyone to stream media. Takes the file id with optional description and expires parameters.

InputTypeDescriptionOptional
'filter'stringUID of object you are sharingNO
'type'stringobject_typeNO
'description'stringdescription (will be filled for you if empty)YES
'expires'integerdays to keep activeYES
  • return
<root>
    <total_count>
    <share>
</root>
  • throws
<root><error></root>

Example

share_delete

Delete an existing share.

InputTypeDescriptionOptional
'filter'stringUID of Share to deleteNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

share_edit

Update the description and/or expiration date for an existing share. Takes the share id to update with optional description and expires parameters.

InputTypeDescriptionOptional
'filter'stringAlpha-numeric search termNO
'stream'boolean0, 1 Allow streamingYES
'download'boolean0, 1 Allow DownloadingYES
'expires'integernumber of whole days before expiryYES
'description'stringupdate descriptionYES
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

songs

Returns songs based on the specified filter

InputTypeDescriptionOptional
'filter'stringFilter results to match this stringYES
'exact'boolean0, 1 (if true filter is exact = rather than fuzzy LIKE)YES
'add'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified dateYES
'update'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified dateYES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <song>
</root>
  • throws
<root><error></root>

Example

song

returns a single song

InputTypeDescriptionOptional
'filter'stringUID of Song, returns song XMLNO
  • return
<root>
    <total_count>
    <song>
</root>
  • throws
<root><error></root>

Example

song_delete

Delete an existing song. (if you are allowed to)

InputTypeDescriptionOptional
'filter'stringUID of song to deleteNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

stats

Get some items based on some simple search types and filters. (Random by default) This method HAD partial backwards compatibility with older api versions but it has now been removed

InputTypeDescriptionOptional
'type'stringsong, album, artist, video, playlist, podcast, podcast_episodeNO
'filter'stringnewest, highest, frequent, recent, forgotten, flagged, randomYES
'user_id'integerYES
'username'stringYES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <song>|<album>|<artist>
</root>
  • throws
<root><error></root>

SONG Example

ARTIST Example

ALBUM Example

system_preference

Get your server preference by name

ACCESS REQUIRED: 100 (Admin)

InputTypeDescriptionOptional
'filter'stringPreference name e.g ('notify_email', 'ajax_load')NO
  • return
<root>
    <preference>
</root>
  • throws
<root><error></root>

Example

timeline

This gets a user's timeline

InputTypeDescriptionOptional
'username'stringUsername of the user for whom to get the timelineNO
'limit'integerMaximum number of results to returnYES
'since'integerUNIXTIME()YES
  • return
<root>
    <activity>
</root>
  • throws
<root><error></root>

Example

toggle_follow

This follow/unfollow a user

InputTypeDescriptionOptional
'username'stringUsername of the user to follow/unfollowNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

update_art

Updates a single album, artist, song running the gather_art process Doesn't overwrite existing art by default.

ACCESS REQUIRED: 75 (Catalog Manager)

InputTypeDescriptionOptional
'id'integer$object_idNO
'type'stringsong, podcastNO
'overwrite'boolean0, 1YES
  • return
<root>
    <success>
    <art>
</root>
  • throws
<root><error></root>

Example

update_artist_info

Update artist information and fetch similar artists from last.fm Make sure lastfm_API_key is set in your configuration file

ACCESS REQUIRED: 75 (Catalog Manager)

InputTypeDescriptionOptional
'id'integer$artist_idNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

update_from_tags

Update a single album, artist, song from the tag data

InputTypeDescriptionOptional
'type'stringsong, artist, albumNO
'id'integer$artist_id, $album_id, $song_idNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

update_podcast

Sync and download new podcast episodes

ACCESS REQUIRED: 50 (Content Manager)

InputTypeDescriptionOptional
'id'integer$object_idNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

url_to_song

This takes a url and returns the song object in question

InputTypeDescriptionOptional
'url'stringFull Ampache URL from server, translates back into a song XMLNO
  • return
<root>
    <total_count>
    <song>
</root>
  • throws
<root><error></root>

Example

user

This gets a user's public information.

If the username is omitted, this will return the current api user's public information.

InputTypeDescriptionOptional
'username'stringUsername of the user to get details forYES
  • return
<root>
    <user>
</root>
  • throws
<root><error></root>

Example

user_create

Create a new user. (Requires the username, password and email.)

ACCESS REQUIRED: 100 (Admin)

InputTypeDescriptionOptional
'username'string$usernameNO
'password'stringhash('sha256', $password)NO
'email'stringe.g. (user@gmail.com)NO
'fullname'stringYES
'disable'boolean0, 1YES
'group'integerCatalog filter group, default = 0YES
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

user_delete

Delete an existing user.

ACCESS REQUIRED: 100 (Admin)

InputTypeDescriptionOptional
'username'stringNO
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

user_edit

Update an existing user.

ACCESS REQUIRED: 100 (Admin)

NOTE This function has been renamed from user_update to match other edit functions

InputTypeDescriptionOptional
'username'string$usernameNO
'password'stringhash('sha256', $password)YES
'email'stringe.g. (user@gmail.com)YES
'fullname'stringYES
'website'stringYES
'state'stringYES
'city'stringYES
'disable'boolean0, 1YES
'group'integerCatalog filter group, default = 0YES
'maxbitrate'stringYES
'fullname_public'integer0, 1 show fullname in public displayYES
'reset_apikey'integer0, 1 reset user Api KeyYES
'reset_streamtoken'integer0, 1 reset user Stream TokenYES
'clear_stats'integer0, 1 reset all stats for this userYES
  • return
<root>
    <success>
</root>
  • throws
<root><error></root>

Example

user_playlists

This returns playlists based on the specified filter for your user

NOTE This method does not include smartlists

InputTypeDescriptionOptional
'filter'stringFilter results to match this stringYES
'exact'boolean0, 1 (if true filter is exact = rather than fuzzy LIKE)YES
'add'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified dateYES
'update'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified dateYES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <playlist>
</root>
  • throws
<root><error></root>

Example

user_preference

Get your user preference by name

InputTypeDescriptionOptional
'filter'stringPreference name e.g ('notify_email', 'ajax_load')NO
  • return
<root>
    <preference>
</root>
  • throws
<root><error></root>

Example

user_smartlists

This returns smartlists based on the specified filter for your user

NOTE This method does not include playlists

InputTypeDescriptionOptional
'filter'stringFilter results to match this stringYES
'exact'boolean0, 1 (if true filter is exact = rather than fuzzy LIKE)YES
'add'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified dateYES
'update'set_filterISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified dateYES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <playlist>
</root>
  • throws
<root><error></root>

Example

videos

This returns video objects!

InputTypeDescriptionOptional
'filter'stringFilter results to match this stringYES
'exact'boolean0, 1 (if true filter is exact = rather than fuzzy LIKE)YES
'offset'integerReturn results starting from this index positionYES
'limit'integerMaximum number of results to returnYES
  • return
<root>
    <total_count>
    <video>
</root>
  • throws
<root><error></root>

Example

video

This returns a single video

InputTypeDescriptionOptional
'filter'stringUID of video, returns video XMLNO
  • return
<root>
    <total_count>
    <video>
</root>
  • throws
<root><error></root>

Example

Binary Data Methods

Binary data methods are used for returning raw data to the user such as a image or stream.

stream

Streams a given media file. Takes the file id in parameter with optional max bit rate, file format, time offset, size and estimate content length option.

NOTE search and playlist will only stream a random object from the list

InputTypeDescriptionOptional
'id'integer$object_idNO
'type'stringsong, podcast_episode, search, playlistNO
'bitrate'integermax bitrate for transcodingYES
'format'stringmp3, ogg, raw, etc (raw returns the original format)YES
'offset'integerReturn results starting from this index positionYES
'length'boolean0, 1YES
  • return file (HTTP 200 OK)
  • throws (HTTP 400 Bad Request)
  • throws (HTTP 404 Not Found)

download

Downloads a given media file. set format=raw to download the full file

NOTE search and playlist will only download a random object from the list

InputTypeDescriptionOptional
'id'integer$object_idNO
'type'stringsong, podcast_episode, search, playlistNO
'format'stringmp3, ogg, raw, etc (raw returns the original format)YES
  • return file (HTTP 200 OK)
  • throws (HTTP 400 Bad Request)
  • throws (HTTP 404 Not Found)

get_art

Get an art image.

InputTypeDescriptionOptional
'id'integer$object_idNO
'type'stringsong, artist, album, playlist, search, podcastNO
  • return image (HTTP 200 OK)
  • throws (HTTP 400 Bad Request)
  • throws (HTTP 404 Not Found)

Control Methods

localplay

This is for controlling localplay

InputTypeDescriptionOptional
'command'stringnext, prev, stop, play, pause, add, volume_up, volume_down, volume_mute, delete_all, skip, statusNO
'oid'integer$object_idYES
'type'stringsong, video, podcast_episode, channel, broadcast, democratic, live_streamYES
'clear'boolean0, 1 (Clear the current playlist before adding)YES
  • return
<root>
    <localplay>
        <command>
            <next>|<prev>|<stop>|<play>|<pause>|<add>|<volume_up>|<volume_down>|<volume_mute>|<delete_all>|<skip>|<status>
        </command>
    </localplay>
</root>
  • throws
<root><error></root>

Example

Example (status)

democratic

This is for controlling democratic play (Songs only)

  • Method Descriptions
    • vote: +1 vote for the oid
    • devote: -1 vote for the oid
    • playlist: Return an array of song items with an additional <vote>[VOTE COUNT]</vote> element
    • play: Returns the URL for playing democratic play
InputTypeDescriptionOptional
'oid'integerUID of Song objectNO
'method'stringvote, devote, playlist, playNO
  • return
<root>
    <url>|<method><result>|<song>
</root>
  • throws
<root><error></root>

Example

Example

Example