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

handshake

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

Input	Type	Description	Optional
'auth'	string	$passphrase (Timestamp . Password SHA hash) OR (API Key)	NO
'user'	string	$username (Required if login/password authentication)	YES
'timestamp'	integer	UNIXTIME() 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.

Input	Type	Description	Optional
'auth'	string	(Session ID) destroys the session if it exists	NO

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

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

Input	Type	Description	Optional
'auth'	string	(Session ID) returns version information and extends the session if passed	YES
'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.)

Input	Type	Description	Optional
'username'	string	$username	NO
'password'	string	hash('sha256', $password)	NO
'email'	string	e.g.user@gmail.com	NO
'fullname'	string		YES

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Non-Data Methods

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

bookmarks

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

• return

<root>
    <bookmark>
</root>

• throws

<root><error></root>

Example

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

advanced_search

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

Input	Type	Description	Optional
operator	string	and, 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
type	string	song, album, artist, label, playlist, podcast, podcast_episode, genre, user, video	NO
random	boolean	0, 1 (random order of results; default to 0)	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• 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

Input	Type	Description	Optional
'filter'	string	Filter results to match this string	YES
'exact'	boolean	0, 1 (if true filter is exact = rather than fuzzy LIKE)	YES
'add'	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date	YES
'update'	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES
'include'	string	albums, 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

Input	Type	Description	Optional
'filter'	string	UID of Album, returns album XML	NO
'include'	string	songs (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

Input	Type	Description	Optional
'filter'	string	UID of Album, returns song XML	NO
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <song>
</root>

• throws

<root><error></root>

Example

artists

This takes a collection of inputs and returns artist objects.

Input	Type	Description	Optional
'filter'	string	Filter results to match this string	YES
'exact'	boolean	0, 1 (if true filter is exact = rather than fuzzy LIKE)	YES
'add'	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date	YES
'update'	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date	YES
'include'	string	albums, songs (include child objects in the response)	YES
'album_artist'	boolean	0, 1 (if true filter for album artists only)	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <artist>
</root>

• throws

<root><error></root>

Example

artist

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

Input	Type	Description	Optional
'filter'	string	UID of Artist, returns artist XML	NO
'include'	string	albums, 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

Input	Type	Description	Optional
'filter'	string	UID of Artist, returns Album XML	NO
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <album>
</root>

• throws

<root><error></root>

Example

artist_songs

This returns the songs of the specified artist

Input	Type	Description	Optional
'filter'	string	UID of Artist, returns Song XML	NO
'top50'	boolean	0, 1 (if true filter to the artist top 50)	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <song>
</root>

• throws

<root><error></root>

Example

bookmark_create

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

Input	Type	Description	Optional
'filter'	string	$object_id to find	NO
'type'	string	song, video, podcast_episode (object_type)	NO
'position'	integer	current track time in seconds	NO
'client'	string	Agent string. (Default: 'AmpacheAPI')	YES
'date'	integer	update time (Default: UNIXTIME())	YES

• return

<root>
    <bookmark>
</root>

• throws

<root><error></root>

Example

bookmark_delete

Delete an existing bookmark. (if it exists)

Input	Type	Description	Optional
'filter'	string	$object_id to delete	NO
'type'	string	song, video, podcast_episode (object_type)	NO
'client'	string	Agent string. (Default: 'AmpacheAPI')	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.

Input	Type	Description	Optional
'filter'	string	$object_id to find	NO
'type'	string	song, video, podcast_episode (object_type)	NO
'position'	integer	current track time in seconds	NO
'client'	string	Agent string. (Default: 'AmpacheAPI')	YES
'date'	integer	update time (Default: UNIXTIME())	YES

• 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

Input	Type	Description	Optional
'filter'	string	object_id	YES
'type'	string	'root', 'catalog', 'artist', 'album', 'podcast'	YES
'filter'	string	catalog ID you are browsing	YES
'add'	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date	YES
'update'	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• 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

Input	Type	Description	Optional
'filter'	string	music, 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

Input	Type	Description	Optional
'filter'	string	UID of Catalog	NO

• 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)

Input	Type	Description	Optional
'task'	string	add_to_catalog, clean_catalog	NO
'catalog'	integer	$catalog_id	NO

• 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)

Input	Type	Description	Optional
'name'	string	Name for the catalog	NO
'path'	string	URL or folder path for your catalog	NO
'type'	string	'local', 'beets', 'remote', 'subsonic', 'seafile', 'beetsremote' Default: local	YES
'media_type'	string	'music', 'podcast', 'clip', 'tvshow', 'movie', 'personal_video' Default: 'music'	YES
'file_pattern'	string	Pattern used identify tags from the file name. Default: '%T - %t'	YES
'folder_pattern'	string	Pattern used identify tags from the folder name. Default: '%a/%A'	YES
'username'	string	login to remote catalog ('remote', 'subsonic', 'seafile', 'beetsremote')	YES
'password'	string	password 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)

Input	Type	Description	Optional
'filter'	string	UID of catalog to delete	NO

• 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)

Input	Type	Description	Optional
'file'	string	FULL path to local file	NO
'task'	string	add, clean, verify, remove (can include comma-separated values)	NO
'catalog'	integer	$catalog_id	NO

• 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)

Input	Type	Description	Optional
'folder'	string	FULL path to local folder	NO
'task'	string	add, clean, verify, remove (can include comma-separated values)	NO
'catalog'	integer	$catalog_id	NO

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

deleted_podcast_episodes

This returns the episodes for a podcast that have been deleted

Input	Type	Description	Optional
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <deleted_podcast_episode>
</root>

• throws

<root><error></root>

Example

deleted_songs

Returns songs that have been deleted from the server

Input	Type	Description	Optional
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <deleted_song>
</root>

• throws

<root><error></root>

Example

deleted_videos

This returns video objects that have been deleted

Input	Type	Description	Optional
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• 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

Input	Type	Description	Optional
'type'	string	song, album, artist, playlist, podcast, podcast_episode, video, tvshow, tvshow_season	NO
'id'	integer	$object_id	NO
'flag'	boolean	0, 1	NO

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

followers

This gets the followers for the requested username

Input	Type	Description	Optional
'username'	string	Username of the user for who to get followers list	NO

• return

<root>
    <user>
</root>

• throws

<root><error></root>

Example

following

Get a list of people that this user follows

Input	Type	Description	Optional
'username'	string	(Username of the user for who to get following list	NO

• return

<root>
    <user>
</root>

• throws

<root><error></root>

Example

friends_timeline

This get current user friends timeline

Input	Type	Description	Optional
'limit'	integer	Maximum number of results to return	YES
'since'	integer	UNIXTIME()	NO

• return

<root>
    <activity>
</root>

• throws

<root><error></root>

Example

genres

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

Input	Type	Description	Optional
'filter'	string	Filter results to match this string	YES
'exact'	boolean	0, 1 (if true filter is exact = rather than fuzzy LIKE)	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• 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.

Input	Type	Description	Optional
'filter'	string	UID of genre, returns genre XML	NO

• return

<root>
    <total_count>
    <genre>
</root>

• throws

<root><error></root>

Example

genre_albums

This returns the albums associated with the genre in question

Input	Type	Description	Optional
'filter'	string	UID of genre, returns album XML	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• 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

Input	Type	Description	Optional
'filter'	string	UID of genre, returns artist XML	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <artist>
</root>

• throws

<root><error></root>

Example

genre_songs

returns the songs for this genre

Input	Type	Description	Optional
'filter'	string	UID of genre, returns song XML	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <song>
</root>

• throws

<root><error></root>

Example

get_bookmark

Get the bookmark from it's object_id and object_type.

Input	Type	Description	Optional
'filter'	string	$object_id to find	NO
'type'	string	song, video, podcast_episode (object_type)	NO

• return

<root>
    <bookmark>
</root>

• throws

<root><error></root>

Example

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 Ampache 7.0.0 (Use list)

Input	Type	Description	Optional
'type'	string	song, album, artist, album_artist, playlist, podcast, podcast_episode, live_stream	NO
'filter'	string	Value is Alpha Match for returned results, may be more than one letter/number	YES
'update'	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date	YES
'include'	boolean	0, 1 (include songs in a playlist or episodes in a podcast)	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES
'hide_search'	integer	0, 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

Input	Type	Description	Optional
'type'	string	song, artist	NO
'filter'	integer	artist id or song id	NO
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <song>|<artist>
</root>

• throws

<root><error></root>

Example

labels

This returns labels based on the specified filter

Input	Type	Description	Optional
'filter'	string	Filter results to match this string	YES
'exact'	boolean	0, 1 (if true filter is exact = rather than fuzzy LIKE)	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <label>
</root>

• throws

<root><error></root>

Example

label

This returns a single label

Input	Type	Description	Optional
'filter'	string	UID of label, returns label XML	NO

• return

<root>
    <total_count>
    <label>
</root>

• throws

<root><error></root>

Example

label_artists

This returns the artists for a label

Input	Type	Description	Optional
'filter'	string	UID of label, returns artist XML	NO
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <artist>
</root>

• throws

<root><error></root>

Example

last_shouts

This gets the latest posted shouts

Input	Type	Description	Optional
'username'	string	Get latest shouts for this username	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <shout>
</root>

• throws

<root><error></root>

Example

license

This returns a single license

Input	Type	Description	Optional
'filter'	string	UID of license, returns license XML	NO

• return

<root>
    <total_count>
    <license>
</root>

• throws

<root><error></root>

Example

license_songs

This returns the songs for a license

Input	Type	Description	Optional
'filter'	string	UID of license, returns song XML	NO
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <song>
</root>

• throws

<root><error></root>

Example

licenses

This returns licenses based on the specified filter

Input	Type	Description	Optional
'filter'	string	Filter results to match this string	YES
'exact'	boolean	0, 1 (if true filter is exact = rather than fuzzy LIKE)	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• 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.

Input	Type	Description	Optional
'type'	string	song, album, artist, album_artist, playlist, podcast, podcast_episode, live_stream	NO
'filter'	string	Value is Alpha Match for returned results, may be more than one letter/number	YES
'update'	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES
'hide_search'	integer	0, 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

Input	Type	Description	Optional
'filter'	string	Filter results to match this string	YES
'exact'	boolean	0, 1 (if true filter is exact = rather than fuzzy LIKE)	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <live_stream>
</root>

• throws

<root><error></root>

Example

live_stream

This returns a single live_stream

Input	Type	Description	Optional
'filter'	string	UID of live_stream, returns live_stream XML	NO

• 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

Input	Type	Description	Optional
'filter'	string	$object_id to find	NO
'type'	string	song, video, podcast_episode (object_type)	NO
'position'	integer	current track time in seconds	NO
'client'	string	Agent string. (Default: 'AmpacheAPI')	YES
'date'	integer	update 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

Input	Type	Description	Optional
'filter'	string	$object_id to delete	NO
'type'	string	song, video, podcast_episode (object_type)	NO
'client'	string	Agent 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

Input	Type	Description	Optional
'filter'	string	$object_id to find	NO
'type'	string	song, video, podcast_episode (object_type)	NO
'position'	integer	current track time in seconds	NO
'client'	string	Agent string. (Default: 'AmpacheAPI')	YES
'date'	integer	update time (Default: UNIXTIME())	YES

• return

<root>
    <live_stream>
</root>

• throws

<root><error></root>

Example

playlists

This returns playlists based on the specified filter

Input	Type	Description	Optional
'filter'	string	Filter results to match this string	YES
'exact'	boolean	0, 1 (if true filter is exact = rather than fuzzy LIKE)	YES
'add'	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date	YES
'update'	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES
'hide_search'	integer	0, 1 (if true do not include searches/smartlists in the result)	YES
'show_dupes'	integer	0, 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

Input	Type	Description	Optional
'filter'	string	UID of playlist, returns playlist XML	NO

• return

<root>
    <total_count>
    <playlist>
</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

Input	Type	Description	Optional
'filter'	string	UID of Playlist	NO
'song'	string	UID of song to add to playlist	NO
'check'	boolean	0, 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

Input	Type	Description	Optional
'name'	string	Playlist name	NO
'type'	string	public, private (Playlist type)	YES

• return

<root>
    <total_count>
    <playlist>
</root>

• throws

<root><error></root>

Example

playlist_delete

This deletes a playlist

Input	Type	Description	Optional
'filter'	string	UID of Playlist	NO

• 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

Input	Type	Description	Optional
'filter'	string	UID of Playlist	NO
'name'	string	Playlist name	YES
'type'	string	public, private (Playlist type)	YES
'owner'	string	Change playlist owner to the user id (-1 = System playlist)	YES
'items'	string	comma-separated song_id's (replaces existing items with a new id)	YES
'tracks'	string	comma-separated playlisttrack numbers matched to 'items' in order	YES

• 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.

Input	Type	Description	Optional
'mode'	string	recent, forgotten, unplayed, random (default = 'random')	YES
'filter'	string	string LIKE matched to song title	YES
'album'	integer	$album_id	YES
'artist'	integer	$artist_id	YES
'flag'	integer	0, 1 (get flagged songs only. default = 0)	YES
'format'	string	song, index, id (default = 'song')	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• 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'.

Input	Type	Description	Optional
'filter'	string	UID of Playlist	NO
'song'	string	UID of song to remove from playlist	YES
'track'	integer	Track number to remove from playlist	YES

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

playlist_songs

This returns the songs for a playlist

Input	Type	Description	Optional
'filter'	string	UID of Playlist, returns song XML	NO
'random'	integer	0, 1 (if true get random songs using limit)	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <song>
</root>

• throws

<root><error></root>

Example

podcast

Get the podcast from it's id.

Input	Type	Description	Optional
'filter'	string	UID of podcast, returns podcast XML	NO
'include'	string	episodes (include podcast_episodes in the response)	YES

• return

<root>
    <total_count>
    <podcast>
</root>

• throws

<root><error></root>

Example

podcasts

Get information about podcasts

Input	Type	Description	Optional
'filter'	string	Value is Alpha Match for returned results, may be more than one letter/number	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES
'include'	string	episodes (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)

Input	Type	Description	Optional
'url'	string	rss url for podcast	NO
'catalog'	string	podcast catalog	NO

• return

<root>
    <total_count>
    <podcast>
</root>

• throws

<root><error></root>

Example

podcast_delete

Delete an existing podcast.

ACCESS REQUIRED: 75 (Catalog Manager)

Input	Type	Description	Optional
'filter'	string	UID of podcast to delete	NO

• 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)

Input	Type	Description	Optional
'filter'	string	Alpha-numeric search term	NO
'feed'	string	feed rss xml url	YES
'title'	string	title string	YES
'website'	string	source website url	YES
'description'	string		YES
'generator'	string		YES
'copyright'	string		YES

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

podcast_episodes

This returns the episodes for a podcast

Input	Type	Description	Optional
'filter'	string	UID of podcast	NO
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <podcast_episode>
</root>

• throws

<root><error></root>

Example

podcast_episode

Get the podcast_episode from it's id.

Input	Type	Description	Optional
'filter'	string	podcast_episode ID number	NO

• return

<root>
    <total_count>
    <podcast_episode>
</root>

• throws

<root><error></root>

Example

podcast_episode_delete

Delete an existing podcast_episode.

Input	Type	Description	Optional
'filter'	string	UID of podcast_episode to delete	NO

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

preference_create

Add a new preference to your server

ACCESS REQUIRED: 100 (Admin)

Input	Type	Description	Optional
'filter'	string	Preference name e.g ('notify_email', 'ajax_load')	NO
'type'	string	boolean, integer, string, special	NO
'default'	mixed	string or integer default value	NO
'category'	string	interface, internal, options, playlist, plugins, streaming	NO
'description'	string		YES
'subcategory'	string		YES
'level'	integer	access 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)

Input	Type	Description	Optional
'filter'	string	Preference 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)

Input	Type	Description	Optional
'filter'	string	Preference name e.g ('notify_email', 'ajax_load')	NO
'value'	mixed	(string/integer) Preference value	NO
'all'	boolean	0, 1 apply to all users	YES

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

rate

This rates a library item

Input	Type	Description	Optional
'type'	string	song, album, artist, playlist, podcast, podcast_episode, video, tvshow, tvshow_season	NO
'id'	string	library item id	NO
'rating'	integer	rating between 0-5	NO

• 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

Input	Type	Description	Optional
'id'	integer	$object_id	NO
'user'	integer	$user_id	YES
'client'	string	$agent	YES
'date'	integer	UNIXTIME()	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

Input	Type	Description	Optional
'song'	string	HTML encoded string	NO
'artist'	string	HTML encoded string	NO
'album'	string	HTML encoded string	NO
'songmbid'	string	song_mbid also supported	YES
'artistmbid'	string	artist_mbid also supported	YES
'albummbid'	string	album_mbid also supported	YES
'date'	integer	UNIXTIME()	YES
'client'	string	$agent	YES

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

search_songs

This searches the songs and returns... songs

Input	Type	Description	Optional
'filter'	string	Filter results to match this string	NO
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <song>
</root>

• throws

<root><error></root>

Example

shares

This searches the shares and returns... shares

Input	Type	Description	Optional
'filter'	string	Filter results to match this string	YES
'exact'	boolean	0, 1 boolean to match the exact filter string	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <share>
</root>

• throws

<root><error></root>

Example

share

Return shares by UID

Input	Type	Description	Optional
'filter'	string	UID of Share, returns song XML	NO

• 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.

Input	Type	Description	Optional
'filter'	string	UID of object you are sharing	NO
'type'	string	object_type	NO
'description'	string	description (will be filled for you if empty)	YES
'expires'	integer	days to keep active	YES

• return

<root>
    <total_count>
    <share>
</root>

• throws

<root><error></root>

Example

share_delete

Delete an existing share.

Input	Type	Description	Optional
'filter'	string	UID of Share to delete	NO

• 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.

Input	Type	Description	Optional
'filter'	string	Alpha-numeric search term	NO
'stream'	boolean	0, 1 Allow streaming	YES
'download'	boolean	0, 1 Allow Downloading	YES
'expires'	integer	number of whole days before expiry	YES
'description'	string	update description	YES

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

songs

Returns songs based on the specified filter

Input	Type	Description	Optional
'filter'	string	Filter results to match this string	YES
'exact'	boolean	0, 1 (if true filter is exact = rather than fuzzy LIKE)	YES
'add'	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'add' date newer than the specified date	YES
'update'	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'update' time newer than the specified date	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <song>
</root>

• throws

<root><error></root>

Example

song

returns a single song

Input	Type	Description	Optional
'filter'	string	UID of Song, returns song XML	NO

• return

<root>
    <total_count>
    <song>
</root>

• throws

<root><error></root>

Example

song_delete

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

Input	Type	Description	Optional
'filter'	string	UID of song to delete	NO

• 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

Input	Type	Description	Optional
'type'	string	song, album, artist, video, playlist, podcast, podcast_episode	NO
'filter'	string	newest, highest, frequent, recent, forgotten, flagged, random	YES
'user_id'	integer		YES
'username'	string		YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• 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)

Input	Type	Description	Optional
'filter'	string	Preference name e.g ('notify_email', 'ajax_load')	NO

• return

<root>
    <preference>
</root>

• throws

<root><error></root>

Example

timeline

This gets a user's timeline

Input	Type	Description	Optional
'username'	string	Username of the user for whom to get the timeline	NO
'limit'	integer	Maximum number of results to return	YES
'since'	integer	UNIXTIME()	YES

• return

<root>
    <activity>
</root>

• throws

<root><error></root>

Example

toggle_follow

This follow/unfollow a user

Input	Type	Description	Optional
'username'	string	Username of the user to follow/unfollow	NO

• 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)

Input	Type	Description	Optional
'id'	integer	$object_id	NO
'type'	string	song, podcast	NO
'overwrite'	boolean	0, 1	YES

• 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)

Input	Type	Description	Optional
'id'	integer	$artist_id	NO

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

update_from_tags

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

Input	Type	Description	Optional
'type'	string	song, artist, album	NO
'id'	integer	$artist_id, $album_id, $song_id	NO

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

update_podcast

Sync and download new podcast episodes

ACCESS REQUIRED: 50 (Content Manager)

Input	Type	Description	Optional
'id'	integer	$object_id	NO

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

url_to_song

This takes a url and returns the song object in question

Input	Type	Description	Optional
'url'	string	Full Ampache URL from server, translates back into a song XML	NO

• return

<root>
    <total_count>
    <song>
</root>

• throws

<root><error></root>

Example

user

This gets a user's public information

Input	Type	Description	Optional
'username'	string	Username of the user to get details for	NO

• 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)

Input	Type	Description	Optional
'username'	string	$username	NO
'password'	string	hash('sha256', $password)	NO
'email'	string	e.g.user@gmail.com	NO
'fullname'	string		YES
'disable'	boolean	0, 1	YES
'group'	integer	Catalog filter group, default = 0	YES

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

user_delete

Delete an existing user.

ACCESS REQUIRED: 100 (Admin)

Input	Type	Description	Optional
'username'	string		NO

• 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

Input	Type	Description	Optional
'username'	string	$username	NO
'password'	string	hash('sha256', $password)	YES
'email'	string	e.g.user@gmail.com	YES
'fullname'	string		YES
'website'	string		YES
'state'	string		YES
'city'	string		YES
'disable'	boolean	0, 1	YES
'group'	integer	Catalog filter group, default = 0	YES
'maxbitrate'	string		YES
'fullname_public'	integer	0, 1 show fullname in public display	YES
'reset_apikey'	integer	0, 1 reset user Api Key	YES
'reset_streamtoken'	integer	0, 1 reset user Stream Token	YES
'clear_stats'	integer	0, 1 reset all stats for this user	YES

• return

<root>
    <success>
</root>

• throws

<root><error></root>

Example

user_preference

Get your user preference by name

Input	Type	Description	Optional
'filter'	string	Preference name e.g ('notify_email', 'ajax_load')	NO

• return

<root>
    <preference>
</root>

• throws

<root><error></root>

Example

videos

This returns video objects!

Input	Type	Description	Optional
'filter'	string	Filter results to match this string	YES
'exact'	boolean	0, 1 (if true filter is exact = rather than fuzzy LIKE)	YES
'offset'	integer	Return results starting from this index position	YES
'limit'	integer	Maximum number of results to return	YES

• return

<root>
    <total_count>
    <video>
</root>

• throws

<root><error></root>

Example

video

This returns a single video

Input	Type	Description	Optional
'filter'	string	UID of video, returns video XML	NO

• 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

Input	Type	Description	Optional
'id'	integer	$object_id	NO
'type'	string	song, podcast_episode, search, playlist	NO
'bitrate'	integer	max bitrate for transcoding in bytes (e.g 192000=192Kb)	YES
'format'	string	mp3, ogg, raw, etc (raw returns the original format)	YES
'offset'	integer	Return results starting from this index position	YES
'length'	boolean	0, 1	YES

• 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

Input	Type	Description	Optional
'id'	integer	$object_id	NO
'type'	string	song, podcast_episode, search, playlist	NO
'format'	string	mp3, 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.

Input	Type	Description	Optional
'id'	integer	$object_id	NO
'type'	string	song, artist, album, playlist, search, podcast	NO

• return image (HTTP 200 OK)
• throws (HTTP 400 Bad Request)
• throws (HTTP 404 Not Found)

Control Methods

localplay

This is for controlling localplay

Input	Type	Description	Optional
'command'	string	next, prev, stop, play, pause, add, volume_up, volume_down, volume_mute, delete_all, skip, status	NO
'oid'	integer	$object_id	YES
'type'	string	song, video, podcast_episode, channel, broadcast, democratic, live_stream	YES
'clear'	boolean	0, 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

Input	Type	Description	Optional
'oid'	integer	UID of Song object	NO
'method'	string	vote, devote, playlist, play	NO

• return

<root>
    <url>|<method><result>|<song>
</root>

• throws

<root><error></root>

Example

Example

Example