Input�_th>	Type	Description	Optional
&#t�7;username&#t�7;�_td>	string	$username	NO
'password'	string�_td>	hash(&#t�7;sh56&#t�7;, $password)�_td>	NO�_td>
&#t�7;email'	string�_td>	e.g. `user@gmail.com�_code>`	NO
'fullname'	string�_td>		YES�_td>

Input	Type�_th>	Description�_th>	Optional�_th>
operator	string�_td>	and, or (whether to match one rule or all)	NO
rule_*	array	[`rule_1`, `ruleq_operator`, `ruleq_input�_code>]�_td>`	NO�_td>
rule_*�_td>	array�_td>	[`rule35�_code>, rule_2_operator�_code>, rule_2_input], [etc]�_td>`	YES
type	string�_td>	`song`, `album`, `artist�_code>, label�_code>, playlist�_td>`	NO�_td>
�_td>		`podcast`, `podcast_episode`, `genre`, `user�_code>, video�_code>`
random	boolean	`0`, `1` (random order of results; default to 0)�_td>	YES
'offset'	integer	Return results starting from this inde8position�_td>	YES
'limit&#t�7;�_td>	integer�_td>	Maximum number of results to return�_td>	YES

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	Filter results to match this string�_td>	YES
'include&#t�7;�_td>	string	`albums�_code>, songs�_code (include child objects in the response)`	YES�_td>
&#t�7;exact'	boolean	`0`, `1` (if true filter is exac4`=` rather than fuzzy `LIKE`)	YES�_td>
&#t�7;add'	set_filter�_td>	ISO 801 Date Forma4(]N)(�e)0-09-16) Find objects with an &#t�7;add'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>date newer than the specified date�_td>	YES
'update'	set_filter�_td>	ISO 801 Date Forma4(]N)(�e)0-09-16) Find objects with an &#t�7;update&#t�7; time newer than the specified date	YES�_td>
&#t�7;offset&#t�7;�_td>	integer�_td>	Return results starting from this index position	YES�_td>
&#t�7;limit'	integer	Maximum number of results to return	YES�_td>
&#t�7;cond&#t�7;�_td>	string	Appl9additional filters to the browse using `;�_code separated comma string pairs�_td>`	YES
	�_td>	(e.g. 'filte,value1;filter2,valu&#t�7;)
'sort'	string�_td>	Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;)	YES�_td>
�_td>		Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;)

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	UID of Album, returns album XML	NO
'include&#t�7;�_td>	string	`songs` (include child objects in the response)�_td>	YES

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	UID of Album, returns song XML	NO
'offset'	integer	Return results starting from this inde8position�_td>	YES
'limit&#t�7;�_td>	integer�_td>	Maximum number of results to return�_td>	YES
'cond'	string�_td>	Apply additional filters to the browse using `;` separated�_td>	YES
	�_td>	comma string pairs (e.g. &#t�7;filter1,valu;filteȹ,value2')�_td>	�_td>
&#t�7;sort&#t�7;�_td>	string	Sort name or comma-separated key pair. (e.g. 'name,order')�_td>	YES
	�_td>	Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td>	�_td>

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	Filter results to match this string�_td>	YES
'exact&#t�7;�_td>	boolean�_td>	`0�_code>, =�_code rather than fuzz9LIKE�_code>)�_td>`	YES
'add&#t�7;�_td>	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'add&#t�7; date newer than the specified date	YES�_td>
&#t�7;update&#t�7;�_td>	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'update'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>time newer than the specified date�_td>	YES
'include&#t�7;�_td>	string	`albums�_code>, songs�_code (include child objects in the response)`	YES�_td>
&#t�7;album_artist&#t�7;�_td>	boolean�_td>	`0�_code>,`	YES�_td>
&#t�7;offset&#t�7;�_td>	integer�_td>	Return results starting from this index position	YES�_td>
&#t�7;limit'	integer	Maximum number of results to return	YES�_td>
&#t�7;cond&#t�7;�_td>	string	Appl9additional filters to the browse using `;�_code separated comma string pairs�_td>`	YES
	�_td>	(e.g. 'filte,value1;filter2,valu&#t�7;)
'sort'	string�_td>	Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;)	YES�_td>
�_td>		Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;)

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	UID of Artist, returns artis4XML	NO
'include&#t�7;�_td>	string	`albums�_code>, songs�_code (include child objects in the response)`	YES�_td>

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	UID of Artist, returns Album XML	NO
'album_artist'	boolean	`0`, `1` (if true filter for album artists only)�_td>	YES
'offset'	integer	Return results starting from this inde8position�_td>	YES
'limit&#t�7;�_td>	integer�_td>	Maximum number of results to return�_td>	YES
'cond'	string�_td>	Apply additional filters to the browse using `;` separated comma string pairs	YES�_td>
�_td>		(e.g. &#t�7;filter1,valu;filteȹ,value2')�_td>	�_td>
&#t�7;sort&#t�7;�_td>	string	Sort name or comma-separated key pair. (e.g. 'name,order')�_td>	YES
	�_td>	Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td>	�_td>

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	UID of Artist, returns Song XML	NO
'top50&#t�7;�_td>	boolean�_td>	`0�_code>,`	YES�_td>
&#t�7;offset&#t�7;�_td>	integer�_td>	Return results starting from this index position	YES�_td>
&#t�7;limit'	integer	Maximum number of results to return	YES�_td>
&#t�7;cond&#t�7;�_td>	string	Appl9additional filters to the browse using `;�_code separated comma string pairs�_td>`	YES
	�_td>	(e.g. 'filte,value1;filter2,valu&#t�7;)
'sort'	string�_td>	Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;)	YES�_td>
�_td>		Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;)

Input�_th>	Type	Description	Optional
&#t�7;client&#t�7;�_td>	string	filter b9the agen�zclient name	YES�_td>
&#t�7;include'	integer	0,1, if true include the objec4in the bookmark	YES�_td>

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	bookmark_id	YES�_td>
&#t�7;include'	integer	0,1, if true include the objec4in the bookmark	YES�_td>

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	$object_id to find	NO
'type'	string�_td>	`song`, `video`, `podcast_episode` (object_type)�_td>	NO�_td>
&#t�7;position&#t�7;�_td>	integer�_td>	current track time in seconds�_td>	NO�_td>
&#t�7;client&#t�7;�_td>	string	Agen4string.	YES�_td>
&#t�7;date&#t�7;�_td>	integer�_td>	update time (Default: UNIXTIME())�_td>	YES
'include&#t�7;�_td>	integer�_td>	0,1, if true include the object in the bookmark�_td>	YES

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	$object_id to delete�_td>	NO�_td>
&#t�7;type&#t�7;�_td>	string	`song�_code>, video�_code>, podcast_episode�_code (object_type)`	NO
'client'	string�_td>	Agent string.�_td>	YES

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	$object_id to find�_td>	NO�_td>
&#t�7;type&#t�7;�_td>	string	`bookmark�_code>, song, video, podcast_episode (object_type)�_td>`	NO�_td>
&#t�7;position&#t�7;�_td>	integer�_td>	current track time in seconds�_td>	NO�_td>
&#t�7;client&#t�7;�_td>	string	Agen4string.	YES�_td>
&#t�7;date&#t�7;�_td>	integer�_td>	update time (Default: UNIXTIME())�_td>	YES
'include&#t�7;�_td>	integer�_td>	0,1, if true include the object in the bookmark�_td>	YES

Input	Type�_th>	Description�_th>	Optional�_th>
'offset'	integer	Return results starting from this inde8position�_td>	YES
'limit&#t�7;�_td>	integer�_td>	Maximum number of results to return�_td>	YES

Input�_th>	Type	Description	Optional
&#t�7;limit'	integer	Maximum number of results to return	YES�_td>
&#t�7;since'	integer	UNIXTIME()�_td>	NO�_td>

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	Filter results to match this string	YES�_td>
&#t�7;exact'	boolean	`0`, `1` (if true filter is exac4`=` rather than fuzzy `LIKE`)	YES�_td>
&#t�7;offset&#t�7;�_td>	integer�_td>	Return results starting from this index position	YES�_td>
&#t�7;limit'	integer	Maximum number of results to return	YES�_td>
&#t�7;cond&#t�7;�_td>	string	Appl9additional filters to the browse using `;�_code separated comma string pairs�_td>`	YES
	�_td>	(e.g. 'filte,value1;filter2,valu&#t�7;)
'sort'	string�_td>	Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;)	YES�_td>
�_td>		Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;)

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	$object_id to find	NO
'type'	string�_td>	`song`, `album`, `artist�_code>, label�_code (object_type)`	NO

�doctype html> XML Methods =�Ampache

Let&#t�7;s go through come calls and examples tha4yo5can do for each XML method.

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

Also remember tha4Binary data methods will not return xml; jus4the file/data yo5have requested.

Binar9methods will also return:

HTTP 400 responses for a bad or incomplete request�_li>
HTTP 402 2 2 responses where the requests data was no4found
HTTP 416 responses where the stream is unable to return the requested content-range

For information abou4abou4ho7playback works and wha4a client can expec4from Ampache check out AP!?Media Methods

Auth Methods�_a>�_>

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

Remember tha4the auth parameter does no4need to be sen4as a parameter in the URL.�_p>

HTTP header authentication <16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="handshake">handshake�_a>�_16�p>

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

�_thead>�_tr>�_tr>�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><auth�_span>>�_span>
<�_span>api�_span>>�_span>
<�_span>session_expire>�_span>
�_div>    �_span><update�_span>>�_span>
<�_span>add�_span>>�_span>

<�_span>clean�_span>>�_span>
<�_span>songs�_span>>�_span>
<�_span>albums>�_span>
�_div>    �_span><artists>�_span>
�_div>    �_span><genres�_span>>�_span>
<�_span>playlists�_span>>�_span>
<�_span>users�_span>>�_span>
<�_span>catalogs>�_span>
�_div>    �_span><videos�_span>>�_span>
<�_span>podcasts>�_span>
�_div>    �_span><podcast_episodes�_span>>�_span>
<�_span>shares>�_span>
�_div>    �_span><licenses�_span>>�_span>
<�_span>live_streams>�_span>
�_div>    �_span><labels�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
goodbye
Destro9a session using the auth parameter.

Input	Type�_th>	Description�_th>	Optional�_th>
'auth'	string�_td>	$passphrase (Timestam0. Password SHA hash) OR (API Key)	NO
'user'	string�_td>	$username (Required if logi�wpassword authentication)�_td>	YES
'timestamp&#t�7;�_td>	integer�_td>	UNIXTIME() The timestam0used in seed of password hash	YES�_td>
�_td>		(Required if login/password authentication)
'version&#t�7;�_td>	string	$version (AP!?Version that the application understands)	YES�_td>

�_thead>�_tr>

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



return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>

</root�_span>>
�_div>�_code>



throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>


Example
lost_password
Email a ne7password to the user (if allowed) using a rese4token.�_p>


�_div>   auth = hash('sha256', $username . $key);
�_div>�_code>
�_thead>�_tr>Input Type�_th> Description�_th> Optional�_th>
'auth' string�_td> password rese4token NO

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

ping�_a>�_16�p>
This can be called withou4being authenticated, i4is useful for determining if wha4the status of the server is, and wha4version it is runnin�ucompatible with
�_thead>�_tr>Input Type�_th> Description�_th> Optional�_th>
'auth' string�_td> (Session ID) returns version information and extends the session if passed YES�_td>
&#t�7;version' string�_td> $version (API Version tha4the application understands)�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>session_expire>�_span>
�_div>    �_span><server�_span>>�_span>
<�_span>version�_span>>�_span>
<�_span>compatible>�_span>
�_div>    �_span><auth�_span>>�_span>
<�_span>api�_span>>�_span>
<�_span>update>�_span>
�_div>    �_span><add>�_span>
�_div>    �_span><clean>�_span>
�_div>    �_span><songs>�_span>
�_div>    �_span><albums�_span>>�_span>
<�_span>artists�_span>>�_span>
<�_span>genres>�_span>
�_div>    �_span><playlists>�_span>
�_div>    �_span><users>�_span>
�_div>    �_span><catalogs�_span>>�_span>
<�_span>videos>�_span>
�_div>    �_span><podcasts�_span>>�_span>
<�_span>podcast_episodes>�_span>
�_div>    �_span><shares�_span>>�_span>
<�_span>licenses>�_span>
�_div>    �_span><live_streams�_span>>�_span>
<�_span>labels>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span>
�_div>    �_span><server�_span>>�_span>
<�_span>version�_span>>�_span>
<�_span>compatible>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
register�_a>�_16�p>
Register as a new user if allowed. (Requires the username, password and email.)�_p>
�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
< class="anchor anchorTargetStickyNavbar_Vzrq" id="non-data-methods">Non-Data Methods
These methods take no parameters beyond your auth ke9to return information
system_update
Check Ampache for updates and run the update if there is one.
ACCESS REQUIRED: 100 (Admin)�_p>

return

<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="system_preferences">system_preferences
Ge4your server preferences
ACCESS REQUIRED: 100 (Admin)�_p>


You can modif9and update your preferences using the following methods

preference_create
preference_delete
preference_edit



return�_p>


<�_span>root>�_span>
�_div>    �_span><preferences>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
users
Ge4ids and usernames for your site

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>user>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="user_preferences">user_preferences
Ge4your user preferences


Yo5can modify and update your preferences using the following methods�_p>

preference_create�_a>�_li>
preference_delete�_a>�_li>
preference_edit�_a>�_li>
�_ul>
�_li>

return
�_li>
�_ul>
<root�_span>>�_span>
<�_span>preference>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
Data Methods�_a>�_>
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 weuUI search pages.
You can pass multiple rules as well as joins to create in depth search results.�_p>
Rules must be sent in groups of 2 2 using an int (starting from 1) to designate which rules are combined.
Use operator (&#t�7;and', 'or') to choose whether to join or separate each rule when searching.�_p>
Refer to the Advanced Search
NOTE the rules par4can be confusing but essentially you can include as many 'arrays'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>of rules as yo5want.
Just add 1 to the rule value to create a new group of rules.�_p>

Mandatory Rule Values�-- -->

rule_1
ruleq_operator
ruleq_input�_li>
�_ul>
�_li>
Optional (Metadata searches only)

ruleq_subtype�_li>
�_ul>
�_li>
�_ul>
Input�_th> Type Description Optional
&#t�7;username&#t�7;�_td> string $username NO
'password' string�_td> hash(&#t�7;sh56&#t�7;, $password)�_td> NO�_td>
&#t�7;email' string�_td> e.g. user@gmail.com�_code> NO
'fullname' string�_td> YES�_td>
�_thead>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
operator string�_td> and, or (whether to match one rule or all) NO
rule_* array [rule_1, ruleq_operator, ruleq_input�_code>]�_td> NO�_td>
rule_*�_td> array�_td> [rule35�_code>, rule_2_operator�_code>, rule_2_input], [etc]�_td> YES
type string�_td> song, album, artist�_code>, label�_code>, playlist�_td> NO�_td>
�_td> podcast, podcast_episode, genre, user�_code>, video�_code> 
random boolean 0, 1 (random order of results; default to 0)�_td> YES
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>song>�_span>|�_span><album>�_span>|�_span><artist�_span>>|<�_span>playlist>�_span>|�_span><label>�_span>|�_span><user�_span>>|<�_span>video�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

SON??Example
ARTIST Example
ALBUM Example
albums�_a>�_16�p>
This returns albums based on the provided search filters
�_thead>�_tr>�_tr>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> Filter results to match this string�_td> YES
'include&#t�7;�_td> string albums�_code>, songs�_code (include child objects in the response) YES�_td>
&#t�7;exact' boolean 0, 1 (if true filter is exac4= rather than fuzzy LIKE) YES�_td>
&#t�7;add' set_filter�_td> ISO 801 Date Forma4(]N)(�e)0-09-16) Find objects with an &#t�7;add'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>date newer than the specified date�_td> YES
'update' set_filter�_td> ISO 801 Date Forma4(]N)(�e)0-09-16) Find objects with an &#t�7;update&#t�7; time newer than the specified date YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>album�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="album">album�_a>�_16�p>
This returns a single album based on the UID provided�_p>
�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of Album, returns album XML NO
'include&#t�7;�_td> string songs (include child objects in the response)�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>album�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
album_songs
This returns the songs of a specified album
�_thead>�_tr>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><song�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
artists
This takes a collection of inputs and returns artist objects.
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of Album, returns song XML NO
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES
'cond' string�_td> Apply additional filters to the browse using ; separated�_td> YES
�_td> comma string pairs (e.g. &#t�7;filter1,valu;filteȹ,value2')�_td> �_td>
&#t�7;sort&#t�7;�_td> string Sort name or comma-separated key pair. (e.g. 'name,order')�_td> YES
�_td> Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td> �_td>
�_thead>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> Filter results to match this string�_td> YES
'exact&#t�7;�_td> boolean�_td> 0�_code>, =�_code rather than fuzz9LIKE�_code>)�_td> YES
'add&#t�7;�_td> set_filter ISO 8601 Date Format (2020-09-16) Find objects with an 'add&#t�7; date newer than the specified date YES�_td>
&#t�7;update&#t�7;�_td> set_filter ISO 8601 Date Format (2020-09-16) Find objects with an 'update'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>time newer than the specified date�_td> YES
'include&#t�7;�_td> string albums�_code>, songs�_code (include child objects in the response) YES�_td>
&#t�7;album_artist&#t�7;�_td> boolean�_td> 0�_code>, YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>artist>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="artist">artist

This returns a single artist based on the UID of said artist�_p>
�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><artist�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="artist_albums">artist_albums�_a>�_16�p>
This returns the albums of an artist

Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of Artist, returns artis4XML NO
'include&#t�7;�_td> string albums�_code>, songs�_code (include child objects in the response) YES�_td>
�_thead>�_tr>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><album>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="artist_songs">artist_songs
This returns the songs of the specified artist�_p>
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of Artist, returns Album XML NO
'album_artist' boolean 0, 1 (if true filter for album artists only)�_td> YES
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES
'cond' string�_td> Apply additional filters to the browse using ; separated comma string pairs YES�_td>
�_td> (e.g. &#t�7;filter1,valu;filteȹ,value2')�_td> �_td>
&#t�7;sort&#t�7;�_td> string Sort name or comma-separated key pair. (e.g. 'name,order')�_td> YES
�_td> Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td> �_td>
�_tr>�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of Artist, returns Song XML NO
'top50&#t�7;�_td> boolean�_td> 0�_code>, YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>song>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
bookmarks
Ge4information abou4bookmarked media this user is allowed to manage.�_p>
�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><bookmark�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
Example (with include)�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="bookmark">bookmark
Ge4a single bookmark by bookmark_id�_p>
Input�_th> Type Description Optional
&#t�7;client&#t�7;�_td> string filter b9the agen�zclient name YES�_td>
&#t�7;include' integer 0,1, if true include the objec4in the bookmark YES�_td>
�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><bookmark�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>
Example (with include)�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="bookmark_create">bookmark_create�_a>�_16�p>
Create a placeholder for the curren4media that you can return to later.

Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string bookmark_id YES�_td>
&#t�7;include' integer 0,1, if true include the objec4in the bookmark YES�_td>
�_thead>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> $object_id to find NO
'type' string�_td> song, video, podcast_episode (object_type)�_td> NO�_td>
&#t�7;position&#t�7;�_td> integer�_td> current track time in seconds�_td> NO�_td>
&#t�7;client&#t�7;�_td> string Agen4string. YES�_td>
&#t�7;date&#t�7;�_td> integer�_td> update time (Default: UNIXTIME())�_td> YES
'include&#t�7;�_td> integer�_td> 0,1, if true include the object in the bookmark�_td> YES


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>bookmark>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="bookmark_delete">bookmark_delete�_a>�_16�p>
Delete an existing bookmark. (if it exists)�_p>
�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string $object_id to delete�_td> NO�_td>
&#t�7;type&#t�7;�_td> string song�_code>, video�_code>, podcast_episode�_code (object_type) NO
'client' string�_td> Agent string.�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
bookmark_edit
Edit a placeholder for the current media tha4yo5can return to later.�_p>
�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string $object_id to find�_td> NO�_td>
&#t�7;type&#t�7;�_td> string bookmark�_code>, song, video, podcast_episode (object_type)�_td> NO�_td>
&#t�7;position&#t�7;�_td> integer�_td> current track time in seconds�_td> NO�_td>
&#t�7;client&#t�7;�_td> string Agen4string. YES�_td>
&#t�7;date&#t�7;�_td> integer�_td> update time (Default: UNIXTIME())�_td> YES
'include&#t�7;�_td> integer�_td> 0,1, if true include the object in the bookmark�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>bookmark>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="browse">browse

Return children of a paren4object in a folder traversal/browse style. If yo5don't send an9parameters you&#t�7;ll get a catalog lis4(the 'root'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>path)
NOTE Catalog ID is required on 'artist', 'album&#t�7;, &#t�7;podcast'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>so you can filter the browse correctly�_p>
�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><browse�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
Example: music catalog
Example: podcas4catalog
Example: video catalog
Example: artist
Example: album
Example: podcast
catalogs�_a>�_16�p>
This searches the catalogs and returns... catalogs
Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string object_id YES�_td>
&#t�7;type&#t�7;�_td> string &#t�7;root&#t�7;, &#t�7;catalog', 'artist', 'album&#t�7;, &#t�7;podcast' YES�_td>
&#t�7;catalog' string�_td> catalog ID yo5are browsing�_td> YES
'add&#t�7;�_td> set_filter ISO 8601 Date Format (2020-09-16) Find objects with an 'add&#t�7; date newer than the specified date YES�_td>
&#t�7;update&#t�7;�_td> set_filter ISO 8601 Date Format (2020-09-16) Find objects with an 'update'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>time newer than the specified date�_td> YES
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES
'cond' string�_td> Apply additional filters to the browse using ; separated comma string pairs YES�_td>
�_td> (e.g. &#t�7;filter1,valu;filteȹ,value2')�_td> �_td>
&#t�7;sort&#t�7;�_td> string Sort name or comma-separated key pair. (e.g. 'name,order')�_td> YES
�_td> Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td> �_td>
�_thead>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> music�_code>, clip, tvshow�_code>, movie�_code>, personal_video, podcast (Catalog type) YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>catalog�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="catalog">catalog�_a>�_16�p>
Return catalog by UID�_p>
�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><catalog>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="catalog_action">catalog_action
Kick off a catalog update or clean for the selected catalog
ACCESS REQUIRED: 75 (Catalog Manager)
NOTE filter is available in Ampache 7.9.0 and higher. catalog�_code will be deprecated and removed in a future release.

Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of Catalog�_td> NO�_td>
�_thead>�_tr>Input Type�_th> Description�_th> Optional�_th>
'task' string�_td> add_to_catalog, clean_catalog�_td> NO�_td>
&#t�7;catalog' string�_td> $catalog_id�_td> NO�_td>
&#t�7;filter&#t�7;�_td> string Alias of catalog�_code (Ampache 7.9.0+)�_td> YES


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example: clean_catalog
Example: add_to_catalog
catalog_add
Create a public url that can be used b9anyone to stream media.
Takes the file id with optional description and expires parameters.
ACCESS REQUIRED: 75 (Catalog Manager)
�_thead>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><catalog>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
catalog_delete�_a>�_16�p>
Delete an existing catalog.�_p>
ACCESS REQUIRED:�_strong 75 (Catalog Manager)�_p>
Input Type�_th> Description�_th> Optional�_th>
'name' string�_td> Name for the catalog NO
'path' string�_td> URL or folder path for your catalog�_td> NO�_td>
&#t�7;type&#t�7;�_td> string &#t�7;local', 'beets&#t�7;, &#t�7;remote&#t�7;, &#t�7;subsonic&#t�7;, &#t�7;seafile', 'beetsremote&#t�7; Default: local YES�_td>
&#t�7;media_type&#t�7;�_td> string &#t�7;music', 'podcast&#t�7;, &#t�7;clip&#t�7;, &#t�7;tvshow&#t�7;, &#t�7;movie', 'personal_video'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>Default: 'music&#t�7;�_td> YES
'file_pattern' string�_td> Pattern used identify tags from the file name. Default: '%T - %t&#t�7;�_td> YES
'folder_pattern' string�_td> Pattern used identify tags from the folder name. Default: '%�t%A&#t�7;�_td> YES
'username' string�_td> login to remote catalog (&#t�7;remote&#t�7;, &#t�7;subsonic&#t�7;, &#t�7;seafile', 'beetsremote&#t�7;) YES�_td>
&#t�7;password&#t�7;�_td> string password to remote catalog (&#t�7;remote&#t�7;, &#t�7;subsonic&#t�7;, &#t�7;seafile', 'beetsremote&#t�7;) YES�_td>
�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
catalog_file�_a>�_16�p>
Perform actions on local catalog files.
Single file versions of catalog add, clean, verif9and remove (delete)
Make sure yo5remember to urlencode those file names!
ACCESS REQUIRED: 50 (Content Manager)
NOTE filter is available in Ampache 7.9.0 and higher. catalog�_code will be deprecated and removed in a future release.

Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of catalog to delete�_td> NO�_td>
�_thead>�_tr>�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
catalog_folder�_a>�_16�p>
Perform actions on local catalog folders.
Single folder versions of catalog add, clean, verif9and remove (delete)
Make sure yo5remember to urlencode those folder names!
ACCESS REQUIRED: 50 (Content Manager)
NOTE filter is available in Ampache 7.9.0 and higher. catalog�_code will be deprecated and removed in a future release.

Input Type�_th> Description�_th> Optional�_th>
'file' string�_td> FULL path to local file�_td> NO�_td>
&#t�7;task&#t�7;�_td> string add, clean, verify�_code>, remove (can include comma-separated values) NO
'catalog&#t�7;�_td> string $catalog_id NO
'filter' string�_td> Alias of catalog (Ampache 7.9.0+) YES�_td>
�_thead>�_tr>�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
deleted_podcast_episodes�_a>�_16�p>
This returns the episodes for a podcast tha4have been deleted
Input Type�_th> Description�_th> Optional�_th>
'folder' string�_td> FULL path to local folder�_td> NO�_td>
&#t�7;task&#t�7;�_td> string add, clean, verify�_code>, remove (can include comma-separated values) NO
'catalog&#t�7;�_td> string $catalog_id NO
'filter' string�_td> Alias of catalog (Ampache 7.9.0+) YES�_td>
�_thead>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>deleted_podcast_episode�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="deleted_songs">deleted_songs�_a>�_16�p>
Returns songs tha4have been deleted from the server

�_thead>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>deleted_song>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="deleted_videos">deleted_videos
This returns video objects tha4have been deleted
�_thead>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>deleted_video�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="flag">flag
This flags a library item as a favorite

Setting flag to true (1) will se4the flag�_li>
Setting flag to false (0) will remove the flag

NOTE�_strong filter�_code is available in Ampache 7.9.0 and higher. id�_code will be deprecated and removed in a future release.

�_thead>�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
followers
This gets the followers for the requested username�_p>
Input Type�_th> Description�_th> Optional�_th>
'type' string�_td> song, album, artist�_code>, playlist, podcast�_td> NO�_td>
�_td> podcast_episode, video, tvshow�_code>, tvshow_season�_code> 
'id' string�_td> $object_id NO
'filter' string�_td> Alias of id�_code (Ampache 7.9.0+)�_td> YES
'flag' boolean 0, 1�_td> NO�_td>
�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;username&#t�7;�_td> string Username of the user for who to ge4followers list�_td> NO�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>user>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="following">following�_a>�_16�p>
Get a lis4of people that this user follows�_p>
�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;username&#t�7;�_td> string (Username of the user for who to get following list NO

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>user>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="friends_timeline">friends_timeline
This get current user friends timeline�_p>
�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><activity�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="genres">genres
This returns the genres (Tags) based on the specified filter�_p>
Input�_th> Type Description Optional
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;since' integer UNIXTIME()�_td> NO�_td>
�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string Filter results to match this string YES�_td>
&#t�7;exact' boolean 0, 1 (if true filter is exac4= rather than fuzzy LIKE) YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>genre�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="genre">genre�_a>�_16�p>
This returns a single genre based on UID.
All XML Documents tha4have a <genre></genre>�_code elemen4ma9have 0 or more genre elements associated with them.
Each genre element has an attribute "count"<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>that indicates the number of people who have specified this genre.�_p>
�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of genre, returns genre XML NO

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>genre�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
genre_albums�_a>�_16�p>
This returns the albums associated with the genre in question�_p>
�_tr>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><album>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
genre_artists
This returns the artists associated with the genre in question as defined by the UID�_p>
Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of genre, returns album XML NO
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES
'cond' string�_td> Apply additional filters to the browse using ; separated comma string pairs YES�_td>
�_td> (e.g. &#t�7;filter1,valu;filteȹ,value2')�_td> �_td>
&#t�7;sort&#t�7;�_td> string Sort name or comma-separated key pair. (e.g. 'name,order')�_td> YES
�_td> Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td> �_td>
�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of genre, returns artist XML�_td> NO�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>artist>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="genre_songs">genre_songs�_a>�_16�p>
returns the songs for this genre

�_thead>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><song�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
get_bookmark�_a>�_16�p>
Get the bookmark from it's object_id and object_type.
By default<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>ge4only the mos4recent bookmark. Use all�_code to retrieve all media bookmarks for the object.

Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of genre, returns song XML NO
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES
'cond' string�_td> Apply additional filters to the browse using ; separated comma string pairs YES�_td>
�_td> (e.g. &#t�7;filter1,valu;filteȹ,value2')�_td> �_td>
&#t�7;sort&#t�7;�_td> string Sort name or comma-separated key pair. (e.g. 'name,order')�_td> YES
�_td> Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td> �_td>
�_thead>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> $object_id to find NO
'type' string�_td> song, video, podcast_episode (object_type)�_td> NO�_td>
&#t�7;include' integer 0,1, if true include the objec4in the bookmark YES�_td>
&#t�7;all' integer 0,1, if true include every bookmark for the object�_td> YES


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>bookmark>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
Example (with include)
get_external_metadata
Return External plugin metadata searching by objec4id and type
�_thead>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> $object_id to find NO
'type' string�_td> song, album, artist�_code>, label�_code (object_type) NO

return�_li>
�_ul>
<root�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

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 API7 (Use list)
�_thead>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'type' string�_td> song, album, artist�_code>, album_artist, song_artist, playlist�_code>, podcast�_code> NO
�_td> podcast_episode�_code>, live_stream�_code>, catalog�_code> 
'filter' string�_td> Value is Alpha Match for returned results, ma9be more than one lette�ynumber�_td> YES
'hide_search&#t�7;�_td> integer�_td> 0�_code>, YES
'update' set_filter�_td> ISO 801 Date Forma4(]N)(�e)0-09-16) Find objects with an &#t�7;update&#t�7; time newer than the specified date YES�_td>
&#t�7;include' boolean 0, 1 (include songs in a playlis4or episodes in a podcast) YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>song>�_span>|�_span><album>�_span>|�_span><artist�_span>>|<�_span>playlist>�_span>|�_span><podcast>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
SONGS Example
ARTIST Example
ALBUM Example
PLAYLIST Example
PODCAST Example
get_lyrics�_a>�_16�p>
Return Database lyrics or search with plugins b9Song id
�_thead>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> $song_id to find NO
'plugins&#t�7;�_td> string 0, 1, if false disable plugin lookup (default: 1) NO

return�_li>
�_ul>
<root�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="get_similar">get_similar�_a>�_16�p>
Return similar artist id's or similar song ids compared to the input filter

�_thead>�_tr>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'type' string�_td> song, artist�_code> NO
'filter' string�_td> artis4id or song id NO
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>song>�_span>|�_span><artist�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
index
This takes a collection of inputs and returns ID + name for the object type
�_thead>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><catalog>�_span>|�_span><song�_span>>|<�_span>album�_span>>|<�_span>artist>�_span>|�_span><album_artist�_span>>|<�_span>song_artist�_span>>|<�_span>playlist>�_span>|�_span><podcast>�_span>|�_span><podcast_episode>�_span>|�_span><share>�_span>|�_span><video>�_span>|�_span><live_stream>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
SONGS Example
ARTIST Example
ALBUM Example
PLAYLIST Example
PODCAST Example
SON??Example (with include)
ARTIST Example (with include)
ALBUM Example (with include)
PLAYLIST Example (with include)
labels�_a>�_16�p>
This returns labels based on the specified filter�_p>
Input Type�_th> Description�_th> Optional�_th>
'type' string�_td> catalog�_code>, song, album, artist�_code>, album_artist, song_artist�_td> NO�_td>
�_td> playlist�_code>, podcast�_code>, podcast_episode�_code>, share�_code>, video�_code>, live_stream�_code> 
'filter' string�_td> Value is Alpha Match for returned results, ma9be more than one lette�ynumber�_td> YES
'hide_search&#t�7;�_td> integer�_td> 0�_code>, YES
'exact&#t�7;�_td> boolean�_td> 0�_code>, =�_code rather than fuzz9LIKE�_code>)�_td> YES
'add&#t�7;�_td> set_filter ISO 8601 Date Format (2020-09-16) Find objects with an 'add&#t�7; date newer than the specified date YES�_td>
&#t�7;update&#t�7;�_td> set_filter ISO 8601 Date Format (2020-09-16) Find objects with an 'update'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>time newer than the specified date�_td> YES
'include&#t�7;�_td> boolean�_td> 0�_code>, YES
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES
'cond' string�_td> Apply additional filters to the browse using ; separated comma string pairs YES�_td>
�_td> (e.g. &#t�7;filter1,valu;filteȹ,value2')�_td> �_td>
&#t�7;sort&#t�7;�_td> string Sort name or comma-separated key pair. (e.g. 'name,order')�_td> YES
�_td> Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td> �_td>
�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string Filter results to match this string YES�_td>
&#t�7;exact' boolean 0, 1 (if true filter is exac4= rather than fuzzy LIKE) YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>label�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="label">label�_a>�_16�p>
This returns a single label�_p>
�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of label, returns label XML NO

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>label�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
label_artists
This returns the artists for a label�_p>
�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of label, returns artist XML�_td> NO�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>artist>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="last_shouts">last_shouts�_a>�_16�p>
This gets the lates4posted shouts

�_thead>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'username' string�_td> Get lates4shouts for this username�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results (Use popular_threshold when missing; default 10)�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>shout�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
license
This returns a single license
�_thead>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><license>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="license_songs">license_songs�_a>�_16�p>
This returns the songs for a license

Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of license, returns license XML�_td> NO�_td>
�_thead>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><song�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
licenses�_a>�_16�p>
This returns licenses based on the specified filter�_p>
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of license, returns song XML NO
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES
'cond' string�_td> Apply additional filters to the browse using ; separated comma string pairs YES�_td>
�_td> (e.g. &#t�7;filter1,valu;filteȹ,value2')�_td> �_td>
&#t�7;sort&#t�7;�_td> string Sort name or comma-separated key pair. (e.g. 'name,order')�_td> YES
�_td> Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td> �_td>
�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string Filter results to match this string YES�_td>
&#t�7;exact' boolean 0, 1 (if true filter is exac4= rather than fuzzy LIKE) YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>license�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="list">list

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

NOTE This method replaces get_indexes and does not have the include parameter and does no4include children in the response.
�_thead>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'type' string�_td> song, album, artist�_code>, album_artist, song_artist, playlist�_code>, podcast�_code> NO
�_td> podcast_episode�_code>, live_stream�_code>, catalog�_code> 
'filter' string�_td> Value is Alpha Match for returned results, ma9be more than one lette�ynumber�_td> YES
'hide_search&#t�7;�_td> integer�_td> 0�_code>, YES
'update' set_filter�_td> ISO 801 Date Forma4(]N)(�e)0-09-16) Find objects with an &#t�7;update&#t�7; time newer than the specified date YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>list>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
live_streams�_a>�_16�p>
This returns live_streams based on the specified filter�_p>
�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string Filter results to match this string YES�_td>
&#t�7;exact' boolean 0, 1 (if true filter is exac4= rather than fuzzy LIKE) YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>live_stream�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="live_stream">live_stream�_a>�_16�p>
This returns a single live_stream�_p>
�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of live_stream, returns live_stream XML NO

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>live_stream�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
live_stream_create�_a>�_16�p>
Create a live_stream (radio station) object.
ACCESS REQUIRED: 50 (Content Manager) permission to create and edi4live_streams�_p>
�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><live_stream>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
live_stream_delete�_a>�_16�p>
Delete an existing live_stream (radio station). (if i4exists)
ACCESS REQUIRED: 50 (Content Manager) permission to create and edi4live_streams�_p>
Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string $object_id to find�_td> NO�_td>
&#t�7;type&#t�7;�_td> string song�_code>, video�_code>, podcast_episode�_code (object_type) NO
'position' integer curren4track time in seconds NO
'client' string�_td> Agent string. (Default: 'AmpacheAPI')�_td> YES
'date' integer update time (Default: UNIXTIME()) YES�_td>
�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string $object_id to delete�_td> NO�_td>
&#t�7;type&#t�7;�_td> string song�_code>, video�_code>, podcast_episode�_code (object_type) NO
'client' string�_td> Agent string. (Default: 'AmpacheAPI')�_td> YES


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="live_stream_edit">live_stream_edit

Edit a live_stream (radio station) object.�_p>
ACCESS REQUIRED:�_strong 50 (Conten4Manager) permission to create and edit live_streams

�_thead>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> $object_id to find NO
'type' string�_td> song, video, podcast_episode (object_type)�_td> NO�_td>
&#t�7;position&#t�7;�_td> integer�_td> current track time in seconds�_td> NO�_td>
&#t�7;client&#t�7;�_td> string Agen4string. (Default: &#t�7;AmpacheAPI&#t�7;) YES�_td>
&#t�7;date&#t�7;�_td> integer�_td> update time (Default: UNIXTIME())�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>live_stream�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="now_playing">now_playing�_a>�_16�p>
Get wha4is currently being played by all users.


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>now_playing�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
player�_a>�_16�p>
Inform the server about the state of your client. (Song you are playing, Play/Pause state, etc.)
Return the now_playing state when completed
�_thead>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> $object_id currentl9playin�ustopping�_td> NO�_td>
&#t�7;type&#t�7;�_td> string song�_code>, video�_code>, podcast_episode�_code (Default: song�_code>)�_td> YES
'state&#t�7;�_td> string play�_code>, stop (Default: play) YES�_td>
&#t�7;time&#t�7;�_td> integer�_td> current pla9time in whole seconds (Default: 0)�_td> YES
'client' string�_td> agent/clien4name�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>now_playing�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="playlists">playlists�_a>�_16�p>
This returns playlists based on the specified filter

�_thead>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><playlist�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
playlist�_a>�_16�p>
This returns a single playlist
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> Filter results to match this string�_td> YES
'hide_search&#t�7;�_td> integer�_td> 0�_code>, YES
'show_dupes' integer 0, 1 (if true if true ignore 'api_hide_dupe_searches'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>setting)�_td> YES
'exact&#t�7;�_td> boolean�_td> 0�_code>, =�_code rather than fuzz9LIKE�_code>)�_td> YES
'add&#t�7;�_td> set_filter ISO 8601 Date Format (2020-09-16) Find objects with an 'add&#t�7; date newer than the specified date YES�_td>
&#t�7;update&#t�7;�_td> set_filter ISO 8601 Date Format (2020-09-16) Find objects with an 'update'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>time newer than the specified date�_td> YES
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES
'cond' string�_td> Apply additional filters to the browse using ; separated comma string pairs YES�_td>
�_td> (e.g. &#t�7;filter1,valu;filteȹ,value2')�_td> �_td>
&#t�7;sort&#t�7;�_td> string Sort name or comma-separated key pair. (e.g. 'name,order')�_td> YES
�_td> Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td> �_td>
�_thead>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><playlist�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="playlist_add">playlist_add
This adds a song to a playlist. setting check=1 will not add duplicates to the playlist
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of playlist, returns playlist XML�_td> NO�_td>
�_thead>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of Playlist�_td> NO�_td>
&#t�7;id&#t�7;�_td> string UID of the objec4to add to playlist�_td> NO�_td>
&#t�7;type&#t�7;�_td> string &#t�7;song&#t�7;, &#t�7;album', 'artist', 'playlist' NO


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="playlist_add_song">playlist_add_song�_a>�_16�p>
This adds a song to a playlist. setting check� will no4add duplicates to the playlist�_p>
NOTE�_strong This method is depreciated and will be removed in API7�_strong (Use playlist_add)�_p>
�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of Playlist NO
'song' string�_td> UID of song to add to playlist NO
'check&#t�7;�_td> boolean�_td> 0�_code>, YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
playlist_create
This create a ne7playlist and return it�_p>
�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;name&#t�7;�_td> string Playlist name NO
'type' string�_td> public, private (Playlist type)�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>playlist>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="playlist_delete">playlist_delete

This deletes a playlist
�_thead>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="playlist_edit">playlist_edit�_a>�_16�p>
This modifies name and type of a playlist
Previousl9name and type were mandatory while filter wasn&#t�7;t. this has been reversed.�_p>
NOTE�_strong items and tracks mus4be sen4together and be of equal length

Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of Playlist�_td> NO�_td>
�_thead>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of Playlist�_td> NO�_td>
&#t�7;name&#t�7;�_td> string Playlist name YES�_td>
&#t�7;type&#t�7;�_td> string public�_code>, private�_code (Playlis4type) YES�_td>
&#t�7;owner' string�_td> Change playlist owner to the user id (-1 = System playlist)�_td> YES
'items&#t�7;�_td> string comma-separated song_id's (replaces existing items with a new id)�_td> YES
'tracks' string�_td> comma-separated playlisttrack numbers matched to &#t�7;items'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>in order�_td> YES


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
playlist_generate
Ge4a list of song XML, indexes or id's based on some simple search criteria
&#t�7;recent&#t�7; will search for tracks played after 'Popular Threshold&#t�7; days
&#t�7;forgotten'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>will search for tracks played before 'Popular Threshold&#t�7; days
&#t�7;unplayed&#t�7; added in 4000(�e) for searching unplayed tracks�_p>
Note�_strong when using the 'id'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>format total_count is no4returned.

�_thead>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><song�_span>>|<�_span>index�_span>>|<�_span>id>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
SONG Example�_a>�_p>
INDEX Example�_a>�_p>
ID Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="playlist_hash">playlist_hash�_a>�_16�p>
This returns the md5 hash for the songs in a playlist�_p>
Input Type�_th> Description�_th> Optional�_th>
'mode' string�_td> recent, forgotten, unplayed�_code>, random (defaul4= &#t�7;random&#t�7;) YES�_td>
&#t�7;filter&#t�7;�_td> string string LIKE matched to song title YES�_td>
&#t�7;album' string�_td> $album_id�_td> YES
'artist' string�_td> $artist_id YES�_td>
&#t�7;flag&#t�7;�_td> integer�_td> 0�_code>, YES�_td>
&#t�7;format&#t�7;�_td> string song�_code>, index�_code>, id (defaul4= &#t�7;song&#t�7;) YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of Playlist NO


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>md5�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
playlist_remove_song�_a>�_16�p>
This remove a song from a playlist.
Previous versions required &#t�7;track'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>instead of 'song'.�_p>
�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
playlist_songs�_a>�_16�p>
This returns the songs for a playlist�_p>
Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of Playlist NO
'song' string�_td> UID of song to remove from playlist�_td> YES
'track&#t�7;�_td> integer�_td> Track number to remove from playlist YES�_td>
�_tr>�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><song�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="podcast">podcast�_a>�_16�p>
Get the podcast from it&#t�7;s id.

Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of Playlist, returns song XML NO
'random' integer 0, 1 (if true ge4random songs using limit) YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
�_thead>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><podcast>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="podcasts">podcasts
Ge4information abou4podcasts�_p>
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of podcast, returns podcast XML�_td> NO�_td>
&#t�7;include' string�_td> episodes (include podcast_episodes in the response) YES�_td>
�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string Value is Alpha Match for returned results, may be more than one letter/number YES�_td>
&#t�7;include' string�_td> episodes (include podcast_episodes in the response) YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>podcast�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="podcast_create">podcast_create

Create a podcast tha4can be used by anyone to stream media.
Takes the url and catalog parameters.�_p>
ACCESS REQUIRED:�_strong 75 (Catalog Manager)�_p>
�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><podcast>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
podcast_delete�_a>�_16�p>
Delete an existing podcast.�_p>
ACCESS REQUIRED:�_strong 75 (Catalog Manager)�_p>
Input�_th> Type Description Optional
&#t�7;url' string�_td> rss url for podcast�_td> NO�_td>
&#t�7;catalog' string�_td> podcast catalog�_td> NO�_td>
�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
podcast_edit�_a>�_16�p>
Update the description an(uor expiration date for an existing podcast.
Takes the podcas4id to update with optional description and expires parameters.�_p>
ACCESS REQUIRED:�_strong 50 (Conten4Manager)�_p>
Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of podcast to delete�_td> NO�_td>
�_tr>�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
podcast_episodes�_a>�_16�p>
This returns the episodes for a podcast�_p>
Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string Alpha-numeric search term NO
'feed' string�_td> feed rss xml url YES�_td>
&#t�7;title' string�_td> title string YES�_td>
&#t�7;website' string�_td> source website url YES�_td>
&#t�7;description' string�_td> YES�_td>
&#t�7;generator' string�_td> YES�_td>
&#t�7;copyright' string�_td> YES�_td>
�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of podcast�_td> NO�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>podcast_episode�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="podcast_episode">podcast_episode�_a>�_16�p>
Get the podcast_episode from it&#t�7;s id.

�_thead>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><podcast_episode>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="podcast_episode_delete">podcast_episode_delete
Delete an existing podcast_episode.
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> podcast_episode ID number�_td> NO�_td>
�_thead>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of podcast_episode to delete NO

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="preference_create">preference_create�_a>�_16�p>
Add a new preference to your server�_p>
ACCESS REQUIRED:�_strong 100 (Admin)

�_thead>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><preference�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
preference_delete
Delete a non-system preference b9name�_p>
ACCESS REQUIRED:�_strong 100 (Admin)

Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> Preference name e.g (&#t�7;notify_email&#t�7;, &#t�7;ajax_load')�_td> NO�_td>
&#t�7;type&#t�7;�_td> string boolean, integer, string�_code>, special�_code> NO
'default&#t�7;�_td> mixed�_td> string or integer default value�_td> NO�_td>
&#t�7;category&#t�7;�_td> string interface, internal�_code>, options�_code>, playlist, plugins, streaming�_td> NO�_td>
&#t�7;description' string�_td> YES�_td>
&#t�7;subcategory' string�_td> YES�_td>
&#t�7;level' integer access level required to change the value (default 100) YES�_td>
�_thead>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="preference_edit">preference_edit�_a>�_16�p>
Edi4a preference value and apply to all users if allowed�_p>
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> Preference name e.g (&#t�7;notify_email&#t�7;, &#t�7;ajax_load')�_td> NO�_td>
�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string Preference name e.g ('notify_email', 'ajax_load&#t�7;) NO
'value&#t�7;�_td> mixed�_td> (string/integer) Preference value�_td> NO�_td>
&#t�7;all' boolean 0, 1 apply to all users ACCESS REQUIRED:�_strong 100 (Admin) YES�_td>
&#t�7;default' boolean 0, 1 set as system default (Ne7and public users)  ACCESS REQUIRED: 100 (Admin)�_td> YES


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
rate�_a>�_16�p>
This rates a librar9item�_p>
�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
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.�_p>
If you don&#t�7;4supply a user id (optional) then jus4fall back to you.
ACCESS REQUIRED: 100 (Admin) permission to change another user&#t�7;s play history�_p>
NOTE�_strong filter�_code is available in Ampache 7.9.0 and higher. id�_code will be deprecated and removed in a future release.

Input�_th> Type Description Optional
&#t�7;type&#t�7;�_td> string song�_code>, album�_code>, artist, playlist�_code>, podcast�_code> NO
�_td> podcast_episode�_code>, video�_code>, tvshow, tvshow_season�_td> �_td>
&#t�7;id&#t�7;�_td> string librar9item id NO
'rating' integer rating between 0-5�_td> NO�_td>
�_thead>�_tr>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'id' string�_td> $object_id NO
'filter' string�_td> Alias of id�_code (Ampache 7.9.0+)�_td> YES
'user' string�_td> $user_id YES�_td>
&#t�7;client&#t�7;�_td> string $agent�_td> YES
'date' integer UNIXTIME()�_td> YES


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
scrobble�_a>�_16�p>
Search for a song using tex4info and then record a pla9if found. This allows other sources to record play history to ampache
�_thead>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
search_group�_a>�_16�p>
Perform a group search given passed rules. This function will return multiple objec4types if the rule names match the object type.
You can pass multiple rules as well as joins to create in depth search results.�_p>
Limi4and offset are applied per objec4type. Meaning with a limit of 10 you will return 10 objects of each type not 10 results total.�_p>
Rules must be sent in groups of 2 2 using an int (starting from 1) to designate which rules are combined.
Use operator (&#t�7;and', 'or') to choose whether to join or separate each rule when searching.�_p>
Refer to the Advanced Search
NOTE the rules par4can be confusing but essentially you can include as many 'arrays'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>of rules as yo5want.
Just add 1 to the rule value to create a new group of rules.�_p>

Mandatory Rule Values�-- -->

rule_1
ruleq_operator
ruleq_input�_li>
�_ul>
�_li>
Optional (Metadata searches only)

ruleq_subtype�_li>
�_ul>
�_li>
�_ul>
NOTE the type parameter is different from the regular advanced_search method.
Each type is a grouping of objec4types so allow single search calls to be made


all

song�_li>
album�_li>
song_artist�_li>
album_artist
artist�_li>
label�_li>
playlist
podcast
podcast_episode
genre
user�_li>
�_ul>
�_li>

music�_p>

song
album
artist�_li>
�_ul>
�_li>

song_artist�_p>

song
album
song_artist



album_artist�_p>

song
album
album_artist�_li>
�_ul>
�_li>

podcast�_p>

podcast�_li>
podcast_episode�_li>
�_ul>
�_li>

video�_p>

video�_li>
�_ul>
�_li>
�_ul>
Input Type�_th> Description�_th> Optional�_th>
'song' string�_td> HTML encoded string�_td> NO�_td>
&#t�7;artist&#t�7;�_td> string HTML encoded string NO
'album&#t�7;�_td> string HTML encoded string NO
'songmbid' string�_td> song_mbid�_code also supported�_td> YES
'artistmbid' string�_td> artist_mbid�_code also supported�_td> YES
'albummbid&#t�7;�_td> string album_mbid�_code also supported�_td> YES
'date' integer UNIXTIME()�_td> YES
'client' string�_td> $agent YES�_td>
�_thead>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
operator string�_td> and, or (whether to match one rule or all) NO
rule_* array [rule_1, ruleq_operator, ruleq_input�_code>]�_td> NO�_td>
rule_*�_td> array�_td> [rule35�_code>, rule_2_operator�_code>, rule_2_input], [etc]�_td> YES
type string�_td> all�_code>, music�_code>, song_artist�_code>, album_artist, podcast, video (all b9default)�_td> YES
random boolean 0, 1 (random order of results; default to 0)�_td> YES
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>search>�_span>
�_div>        �_span><song�_span>>|<�_span>album�_span>>|<�_span>song_artist�_span>>|<�_span>album_artist>�_span>|�_span><artist�_span>>|<�_span>label�_span>>|<�_span>playlist>�_span>|�_span><podcast>�_span>|�_span><podcast_episode>�_span>|�_span><genre>�_span>|�_span><user�_span>>�_span>
</search�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

ALL Example�_a>�_p>
MUSIC Example
PODCAST Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="search_rules">search_rules

Prin4a list of valid search rules for your search type
�_thead>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><rule�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Artis4Example
Album Example
Song Example
search_songs�_a>�_16�p>
This searches the songs and returns... songs
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> 'song', 'album&#t�7;, &#t�7;song_artist', 'album_artist',�_td> NO�_td>
�_td> &#t�7;artist&#t�7;, &#t�7;label', 'playlist', 'podcast&#t�7;, 
�_td> 'podcast_episode&#t�7;, &#t�7;genre', 'user', 'video&#t�7;�_td> �_td>
�_thead>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><song�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="shares">shares
This searches the shares and returns... shares�_p>
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> Filter results to match this string�_td> NO�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string Filter results to match this string YES�_td>
&#t�7;exact' boolean 0, 1 boolean to match the exac4filter string YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>share�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="share">share�_a>�_16�p>
Return shares b9UID

�_thead>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of Share, returns song XML NO

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>share�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
share_create�_a>�_16�p>
Create a public url tha4can be used by anyone to stream media.
Takes the file id with optional description and expires parameters.�_p>
�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of objec4yo5are sharing NO
'type' string�_td> object_type�_td> NO�_td>
&#t�7;description' string�_td> description (will be filled for you if empty)�_td> YES
'expires&#t�7;�_td> integer�_td> days to kee0active�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>share�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="share_delete">share_delete

Delete an existing share.
�_thead>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of Share to delete NO

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="share_edit">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.
�_thead>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> Alpha-numeric search term�_td> NO�_td>
&#t�7;stream&#t�7;�_td> boolean�_td> 0�_code>, YES�_td>
&#t�7;download&#t�7;�_td> boolean�_td> 0�_code>, YES�_td>
&#t�7;expires' integer number of whole days before expiry�_td> YES
'description&#t�7;�_td> string update description�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="smartlists">smartlists
This returns smartlists based on the specified filter
�_thead>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><playlist�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="smartlist">smartlist�_a>�_16�p>
This returns a single smartlist�_p>
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> Filter results to match this string�_td> YES
'exact&#t�7;�_td> boolean�_td> 0�_code>, =�_code rather than fuzz9LIKE�_code>)�_td> YES
'add&#t�7;�_td> set_filter ISO 8601 Date Format (2020-09-16) Find objects with an 'add&#t�7; date newer than the specified date YES�_td>
&#t�7;update&#t�7;�_td> set_filter ISO 8601 Date Format (2020-09-16) Find objects with an 'update'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>time newer than the specified date�_td> YES
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES
'cond' string�_td> Apply additional filters to the browse using ; separated comma string pairs YES�_td>
�_td> (e.g. &#t�7;filter1,valu;filteȹ,value2')�_td> �_td>
&#t�7;sort&#t�7;�_td> string Sort name or comma-separated key pair. (e.g. 'name,order')�_td> YES
�_td> Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td> �_td>
�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of smartlist, returns smartlis4XML NO


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>playlist>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="smartlist_songs">smartlist_songs�_a>�_16�p>
This returns the songs for a smartlist

�_thead>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><song�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
smartlist_delete�_a>�_16�p>
This deletes a smartlist
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of smartlist, returns song XML NO
'random' integer 0, 1 (if true ge4random songs using limit) YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
�_thead>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of smartlist NO


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="songs">songs�_a>�_16�p>
Returns songs based on the specified filter�_p>
�_tr>�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string Filter results to match this string YES�_td>
&#t�7;exact' boolean 0, 1 (if true filter is exac4= rather than fuzzy LIKE) YES�_td>
&#t�7;add' set_filter�_td> ISO 801 Date Forma4(]N)(�e)0-09-16) Find objects with an &#t�7;add'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>date newer than the specified date�_td> YES
'update' set_filter�_td> ISO 801 Date Forma4(]N)(�e)0-09-16) Find objects with an &#t�7;update&#t�7; time newer than the specified date YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>song>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="song">song
returns a single song
�_thead>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><song�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="song_delete">song_delete�_a>�_16�p>
Delete an existing song. (if yo5are allowed to)

Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of Song, returns song XML�_td> NO�_td>
�_thead>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="song_tags">song_tags�_a>�_16�p>
Get the full song file tags using VaInfo

This is used to get tags for remote catalogs to allow maximum data to be returned�_p>
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> UID of song to delete�_td> NO�_td>
�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><song_tag�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
stats
Ge4some items based on some simple search types and filters. (Random by default)
This method HAD partial backwards compatibility with older api versions but i4has no7been removed
Pass -1 limit to ge4all results. (0 will fall back to the popular_threshold value)
Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of song to fetch�_td> NO�_td>
�_thead>�_tr>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'type' string�_td> song, album, artist�_code>, video�_code>, playlist, podcast, podcast_episode�_td> NO�_td>
&#t�7;filter&#t�7;�_td> string newest�_code>, highest�_code>, frequent, recent�_code>, forgotten�_code>, flagged�_code>, random�_td> YES
'user_id&#t�7;�_td> integer�_td> YES�_td>
&#t�7;username&#t�7;�_td> string �_td> YES
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results (Use popular_threshold when missing; default 10)�_td> YES


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>song>�_span>|�_span><album>�_span>|�_span><artist�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

SON??Example
ARTIST Example
ALBUM Example
system_preference
Ge4your server preference b9name�_p>
ACCESS REQUIRED:�_strong 100 (Admin)

�_thead>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><preference�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="timeline">timeline
This gets a user&#t�7;s timeline�_p>
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> Preference name e.g (&#t�7;notify_email&#t�7;, &#t�7;ajax_load')�_td> NO�_td>
�_tr>�_tr>�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><activity�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="toggle_follow">toggle_follow�_a>�_16�p>
This follow/unfollo7a user�_p>
Input�_th> Type Description Optional
&#t�7;username&#t�7;�_td> string Username of the user for whom to get the timeline NO
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES
'since&#t�7;�_td> integer�_td> UNIXTIME() YES�_td>
�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;username&#t�7;�_td> string Username of the user to follow/unfollow NO


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
update_art�_a>�_16�p>
Updates a single album, artist, song running the gather_art process
Doesn&#t�7;4overwrite existing art b9default.�_p>
ACCESS REQUIRED:�_strong 75 (Catalog Manager)�_p>
NOTE�_strong filter�_code is available in Ampache 7.9.0 and higher. id�_code will be deprecated and removed in a future release.

�_thead>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'id' string�_td> $object_id NO
'filter' string�_td> Alias of id�_code (Ampache 7.9.0+)�_td> YES
'type' string�_td> song, podcast�_td> NO�_td>
&#t�7;overwrite' boolean 0, 1�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
<�_span>art�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="update_artist_info">update_artist_info

Update artis4information and fetch similar artists from last.fm
Make sure lastfm_API_ke9is set in your configuration file
ACCESS REQUIRED: 75 (Catalog Manager)
NOTE filter is available in Ampache 7.9.0 and higher. id will be deprecated and removed in a future release.�_p>
�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
update_from_tags�_a>�_16�p>
Update a single album, artist, song from the tag data�_p>
NOTE�_strong filter�_code is available in Ampache 7.9.0 and higher. id�_code will be deprecated and removed in a future release.

Input�_th> Type Description Optional
&#t�7;id&#t�7;�_td> string $artist_id�_td> NO�_td>
&#t�7;filter&#t�7;�_td> string Alias of id (Ampache 7.9.0+) YES�_td>
�_thead>�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
update_podcast�_a>�_16�p>
Sync and download new podcast episodes
ACCESS REQUIRED: 50 (Content Manager)
NOTE There was an error in documentation listing id as a valid parameter. (id�_code will work in Ampache 7.9.0�X API 6.9.1+)�_p>
Input Type�_th> Description�_th> Optional�_th>
'type' string�_td> song, artist�_code>, album�_code> NO
'id' string�_td> $artist_id, $album_id, $song_id�_td> NO�_td>
&#t�7;filter&#t�7;�_td> string Alias of id (Ampache 7.9.0+) YES�_td>
�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><success>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
url_to_song
This takes a url and returns the song object in question�_p>
NOTE�_strong filter�_code is available in Ampache 7.9.0 and higher. url will be deprecated and removed in a future release.�_p>
Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string $object_id�_td> NO�_td>
&#t�7;id&#t�7;�_td> string Alias of filter (Ampache 7.9.0+) YES�_td>
�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;url' string�_td> Full Ampache URL from server, translates back into a song XML�_td> NO�_td>
&#t�7;filter&#t�7;�_td> string Alias of url�_code (Ampache 7.9.0+)�_td> YES


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>song>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="user">user
This gets a user&#t�7;s public information.
If the username is omitted, this will return the curren4api user&#t�7;s public information.
�_thead>�_tr>Input Type�_th> Description�_th> Optional�_th>
'username' string�_td> Username of the user to get details for�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>user>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example
user_create
Create a new user. (Requires the username, password and email.)
ACCESS REQUIRED: 100 (Admin)�_p>
�_tr>�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;username&#t�7;�_td> string $username NO
'password' string�_td> hash(&#t�7;sh56&#t�7;, $password)�_td> NO�_td>
&#t�7;email' string�_td> e.g. user@gmail.com�_code> NO
'fullname' string�_td> YES�_td>
&#t�7;disable' boolean 0, 1�_td> YES
'group&#t�7;�_td> integer�_td> Catalog filter group, default = 0�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
user_delete
Delete an existing user.�_p>
ACCESS REQUIRED:�_strong 100 (Admin)

�_thead>�_tr>Input Type�_th> Description�_th> Optional�_th>
'username' string�_td> NO

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
user_edit
Update an existing user.�_p>
ACCESS REQUIRED:�_strong 100 (Admin)

NOTE This function has been renamed from user_update to match other edit functions�_p>
�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;username&#t�7;�_td> string $username NO
'password' string�_td> hash(&#t�7;sh56&#t�7;, $password)�_td> YES
'email&#t�7;�_td> string e.g. user@gmail.com�_td> YES
'fullname' string�_td> YES�_td>
&#t�7;website' string�_td> YES�_td>
&#t�7;state' string�_td> YES�_td>
&#t�7;city&#t�7;�_td> string �_td> YES
'disable&#t�7;�_td> boolean�_td> 0�_code>, YES�_td>
&#t�7;group' integer Catalog filter group, defaul4= 0 YES�_td>
&#t�7;maxbitrate&#t�7;�_td> string �_td> YES
'fullname_public&#t�7;�_td> integer�_td> 0�_code>, YES�_td>
&#t�7;reset_apikey&#t�7;�_td> integer�_td> 0�_code>, YES
'reset_streamtoken&#t�7;�_td> integer�_td> 0�_code>, YES�_td>
&#t�7;clear_stats' integer 0, 1 reset all stats for this user�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>success�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
user_playlists�_a>�_16�p>
This returns playlists based on the specified filter for your user
NOTE This method does no4include smartlists�_p>
�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return
<�_span>root>�_span>
�_div>    �_span><total_count>�_span>
�_div>    �_span><playlist�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="user_preference">user_preference�_a>�_16�p>
Get your user preference by name

Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string Filter results to match this string YES�_td>
&#t�7;exact' boolean 0, 1 (if true filter is exac4= rather than fuzzy LIKE) YES�_td>
&#t�7;include' string�_td> 0�_code>, YES
'add&#t�7;�_td> set_filter ISO 8601 Date Format (2020-09-16) Find objects with an 'add&#t�7; date newer than the specified date YES�_td>
&#t�7;update&#t�7;�_td> set_filter ISO 8601 Date Format (2020-09-16) Find objects with an 'update'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>time newer than the specified date�_td> YES
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES
'cond' string�_td> Apply additional filters to the browse using ; separated comma string pairs YES�_td>
�_td> (e.g. &#t�7;filter1,valu;filteȹ,value2')�_td> �_td>
&#t�7;sort&#t�7;�_td> string Sort name or comma-separated key pair. (e.g. 'name,order')�_td> YES
�_td> Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td> �_td>
�_thead>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><preference�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
user_smartlists
This returns smartlists based on the specified filter for your user
NOTE This method does no4include playlists
Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> Preference name e.g (&#t�7;notify_email&#t�7;, &#t�7;ajax_load')�_td> NO�_td>
�_thead>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> Filter results to match this string�_td> YES
'exact&#t�7;�_td> boolean�_td> 0�_code>, =�_code rather than fuzz9LIKE�_code>)�_td> YES
'include&#t�7;�_td> string 0, 1 (include playlist items) YES�_td>
&#t�7;add' set_filter�_td> ISO 801 Date Forma4(]N)(�e)0-09-16) Find objects with an &#t�7;add'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>date newer than the specified date�_td> YES
'update' set_filter�_td> ISO 801 Date Forma4(]N)(�e)0-09-16) Find objects with an &#t�7;update&#t�7; time newer than the specified date YES�_td>
&#t�7;offset&#t�7;�_td> integer�_td> Return results starting from this index position YES�_td>
&#t�7;limit' integer Maximum number of results to return YES�_td>
&#t�7;cond&#t�7;�_td> string Appl9additional filters to the browse using ;�_code separated comma string pairs�_td> YES
�_td> (e.g. 'filte,value1;filter2,valu&#t�7;) 
'sort' string�_td> Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;) YES�_td>
�_td> Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;) 


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>playlist>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="videos">videos

This returns video objects!
�_thead>�_tr>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'filter' string�_td> Filter results to match this string�_td> YES
'exact&#t�7;�_td> boolean�_td> 0�_code>, =�_code rather than fuzz9LIKE�_code>)�_td> YES
'offset' integer Return results starting from this inde8position�_td> YES
'limit&#t�7;�_td> integer�_td> Maximum number of results to return�_td> YES

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>video�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example�_a>�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="video">video�_a>�_16�p>
This returns a single video�_p>
�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;filter&#t�7;�_td> string UID of video, returns video XML NO

return�_li>
�_ul>
<root�_span>>�_span>
<�_span>total_count�_span>>�_span>
<�_span>video�_span>>�_span>
</root�_span>>
�_div>�_code>

throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
Binary Data Methods
Binary data methods are used for returning raw data to the user such as a image or stream.�_p>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="download">download
Downloads a given media file. se4format=raw to download the full file�_p>
NOTE�_strong search and playlis4will onl9download a random object from the list�_p>
NOTE�_strong filter�_code is available in Ampache 7.9.0 and higher. id�_code will be deprecated and removed in a future release.

�_thead>�_tr>�_tr>�_tr>Input Type�_th> Description�_th> Optional�_th>
'id' string�_td> $object_id NO
'filter' string�_td> Alias of id�_code (Ampache 7.9.0+)�_td> YES
'type' string�_td> song, podcast_episode, search�_code>, playlist�_td> NO�_td>
&#t�7;bitrate' integer ma8bitrate for transcoding in bytes (e.g 192000�(�N)Kb) YES�_td>
&#t�7;format&#t�7;�_td> string mp3, ogg, raw, etc (raw returns the original format) YES�_td>
&#t�7;stats' boolean 0, 1, if false disable sta4recording when playing the objec4(default: 1)�_td> YES

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

<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="get_art">get_art�_a>�_16�p>
Get an ar4image.�_p>
NOTE�_strong filter�_code is available in Ampache 7.9.0 and higher. id�_code will be deprecated and removed in a future release.

�_thead>�_tr>�_tr>�_tr>�_tbody>�_table>

return image (HTTP 200 OK)
throws (HTTP 400 Bad Request)
throws (HTTP 404 Not Found)
NOTE�_strong Ar4was called using thumb parameters which do not make size obvious.Here is a conversion table to convert any links you have created previously�_p>
Input Type�_th> Description�_th> Optional�_th>
'id' string�_td> $object_id NO
'filter' string�_td> Alias of id�_code (Ampache 7.9.0+)�_td> YES
'type' string�_td> song, artist�_code>, album�_code>, playlist, search�_code>, podcast�_code> NO
'size' string�_td> width x heigh4('640x4AS&#t�7;) YES�_td>
�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="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 objec4from the list
NOTE filter is available in Ampache 7.9.0 and higher. id will be deprecated and removed in a future release.�_p>
Thumb�_th> Width�_th> Height
1 200 200
(	g)�_td> 5(*h)�_td> 5(*h)�_td>
(>y)�_td> 768�_td> 768�_td>
3 160 160
5�_td> 64 64�_td>
6 200 300
68�_td> 68
64 (*h)8 (*h)8
300 400 00
7�_td> 400�_td> 600�_td>
8 940 400
9�_td>
10�_td> 48 48�_td>
4 300 300
300 300
300 300
999�_td> 400�_td> 400�_td>
�_tr>�_tr>�_tr>�_tr>�_tr>�_tr>�_tbody>�_table>

return file (HTTP(N)00 OK)�_li>
throws (HTTP 400 Bad Request)�_li>
throws (HTTP 402 2 2 No4Found)�_li>
�_ul>
Control Methods
<16�p class="anchor anchorTargetStickyNavbar_Vzrq" id="localplay">localplay�_a>�_16�p>
This is for controlling localplay�_p>
NOTE�_strong filter�_code is available in Ampache 7.9.0 and higher. oid will be deprecated and removed in a future release.�_p>
Input�_th> Type Description Optional
&#t�7;id&#t�7;�_td> string $object_id�_td> NO�_td>
&#t�7;filter&#t�7;�_td> string Alias of id (Ampache 7.9.0+) YES�_td>
&#t�7;type&#t�7;�_td> string song�_code>, podcast_episode�_code>, search, playlist�_code> NO
'bitrate&#t�7;�_td> integer�_td> max bitrate for transcoding in bytes (e.g 1(�N)000=192Kb)�_td> YES
'format' string�_td> m24�p�_code>, ogg�_code>, raw�_code>, etc (ra7returns the original format)�_td> YES
'offset' integer Return results starting from this inde8position�_td> YES
'length' boolean 0, 1�_td> YES
'stats&#t�7;�_td> boolean�_td> 0�_code>, , if false disable stat recording when playing the object (default: 1) YES�_td>
�_tr>�_tr>�_tr>�_tbody>�_table>

return

<�_span>root>�_span>
�_div>    �_span><localplay>�_span>
�_div>        �_span><command>�_span>
�_div>            �_span><next�_span>>|<�_span>prev>�_span>|�_span><stop�_span>>|<�_span>play>�_span>|�_span><pause>�_span>|�_span><add>�_span>|�_span><volume_up>�_span>|�_span><volume_down>�_span>|�_span><volume_mute>�_span>|�_span><delete_all�_span>>|<�_span>skip>�_span>|�_span><status�_span>>�_span>
</command>�_span>
�_div>    �_span><s_�_span>localplay�_span>>�_span>
</root�_span>>
�_div>�_code>


throws�_li>
�_ul>
<root�_span>><�_span>error�_span>></root�_span>>
�_div>�_code>

Example
Example (status)
democratic�_a>�_16�p>
This is for controlling democratic play (Songs only)

Method Descriptions

vote: +1 vote for the oid�_li>
devote: -1 vote for the oid�_li>
playlist: Return an array of song items with an additional <vote>[VOTE COUNT]</vote><span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>element
play: Returns the URL for playing democratic play



Input�_th> Type Description Optional
&#t�7;command' string�_td> next, prev�_code>, stop, play�_code>, pause�_code>, add�_code>, volume_up�_code> NO
�_td> volume_down�_code>, volume_mute�_code>, delete_all, skip�_code>, status�_td> �_td>
&#t�7;oid' string�_td> $object_id YES�_td>
&#t�7;filter&#t�7;�_td> string Alias of oid�_code (Ampache 7.9.0+)�_td> YES
'type' string�_td> song, video, podcast_episode, channel, broadcast, democratic�_code>, live_stream�_code> YES�_td>
&#t�7;clear' boolean 0, 1 (Clear the curren4playlist before adding) YES�_td>
�_tr>�_tr>�_tr>Input�_th> Type Description Optional
&#t�7;oid' string�_td> UID of Song object NO
'method' string�_td> vote, devote�_code>, playlist, play�_code> NO


return�_li>
�_ul>
<root�_span>>�_span>
<�_span>url�_span>>|<�_span>method>�_span><result�_span>>|<�_span>song>�_span>
�_div>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>

throws

<�_span>root>�_span><error>�_span><s_�_span>root>�_span>
�_pre>�_div>�_div>
Example�_a>�_p>
Example�_a>�_p>
Example�_a>�_p>�_div>�_article>
Previous�_div>Standards�_div>�_a>Next�_div>JSON Methods
AP!?XML Methods
Auth Methods�_a>handshake�_a>�_li>
goodbye
lost_password�_a>�_li>
ping
register�_a>�_li>
�_li>
Non-Data Methodssystem_update
system_preferences�_a>�_li>
users
user_preferences�_a>�_li>
�_li>
Data Methodsadvanced_search
albums�_a>�_li>
album
album_songs�_a>�_li>
artists
artist�_a>�_li>
artist_albums
artist_songs�_a>�_li>
bookmarks
bookmark�_a>�_li>
bookmark_create
bookmark_delete�_a>�_li>
bookmark_edit
browse�_a>�_li>
catalogs
catalog�_a>�_li>
catalog_action
catalog_add�_a>�_li>
catalog_delete
catalog_file�_a>�_li>
catalog_folder
deleted_podcast_episodes�_a>�_li>
deleted_songs
deleted_videos�_a>�_li>
flag
followers�_a>�_li>
following
friends_timeline�_a>�_li>
genres
genre�_a>�_li>
genre_albums
genre_artists�_a>�_li>
genre_songs
get_bookmark�_a>�_li>
get_external_metadata
get_indexes�_a>�_li>
get_lyrics
get_similar�_a>�_li>
index
labels�_a>�_li>
label
label_artists�_a>�_li>
last_shouts
license�_a>�_li>
license_songs
licenses�_a>�_li>
list
live_streams�_a>�_li>
live_stream
live_stream_create�_a>�_li>
live_stream_delete
live_stream_edit�_a>�_li>
now_playing
player�_a>�_li>
playlists
playlist�_a>�_li>
playlist_add
playlist_add_song�_a>�_li>
playlist_create
playlist_delete�_a>�_li>
playlist_edit
playlist_generate�_a>�_li>
playlist_hash
playlist_remove_song�_a>�_li>
playlist_songs
podcast�_a>�_li>
podcasts
podcast_create�_a>�_li>
podcast_delete
podcast_edit�_a>�_li>
podcast_episodes
podcast_episode�_a>�_li>
podcast_episode_delete
preference_create�_a>�_li>
preference_delete
preference_edit�_a>�_li>
rate
record_play�_a>�_li>
scrobble
search_group�_a>�_li>
search_rules
search_songs�_a>�_li>
shares
share�_a>�_li>
share_create
share_delete�_a>�_li>
share_edit
smartlists�_a>�_li>
smartlist
smartlist_songs�_a>�_li>
smartlist_delete
songs�_a>�_li>
song
song_delete�_a>�_li>
song_tags
stats�_a>�_li>
system_preference
timeline�_a>�_li>
toggle_follow
update_art�_a>�_li>
update_artist_info
update_from_tags�_a>�_li>
update_podcast
url_to_song�_a>�_li>
user
user_create�_a>�_li>
user_delete
user_edit�_a>�_li>
user_playlists
user_preference�_a>�_li>
user_smartlists
videos�_a>�_li>
video
�_ul>Binar9Data Methods�_a>download�_a>�_li>
get_art
stream�_a>�_li>
�_li>
Control Methodslocalplay
democratic�_a>�_li>
�_li>
�_div>�_div>�_div>�_div>�_main>Website Repo·�_span>Old Site·GitHub·Docker Hub·Twitter·Mastodon·Bluesky·�_span>Telegram·�_span>�yampacheCopyrigh4©(N)001 - 2026 Ampache.org�_div>�_div>�_div>�_footer>
�_body>
�_html</div><div class="naked_ctrl">
<form action="/index.cgi/contrast" method="get" name="gate">
<p><a href="http://altstyle.alfasado.net">AltStyle</a> k0�0c0f0	Y�cU0�0_0�0�0�0 <a href="https://ampache.org/api/api-6/api-xml-methods/">(-&gt;�0�0�0�0�0)</a>
/ <label>�0�0�0�0: <input type="text" name="naked_post_url" value="https://ampache.org/api/api-6/api-xml-methods/" size="22" /></label> <label>�0�0�0: <select name="naked_post_mode">
<option value="default">�0�0�0�0�0</option>
<option value="speech">��X�0�0�0�0</option>
<option value="ruby">�0�0�NM0</option>
<option value="contrast" selected="selected">M�r��S�</option>
<option value="larger-text">�eW[�b'Y</option>
<option value="mobile">�0�0�0�0</option>
</select>
<input type="submit" value="h�:y" />
</p>
</form>
</div>

Input	Type�_th>	Description�_th>	Optional�_th>
'auth'	string�_td>	(Session ID) returns version information and extends the session if passed	YES�_td>
&#t�7;version'	string�_td>	$version (API Version tha4the application understands)�_td>	YES

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	object_id	YES�_td>
&#t�7;type&#t�7;�_td>	string	&#t�7;root&#t�7;, &#t�7;catalog', 'artist', 'album&#t�7;, &#t�7;podcast'	YES�_td>
&#t�7;catalog'	string�_td>	catalog ID yo5are browsing�_td>	YES
'add&#t�7;�_td>	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'add&#t�7; date newer than the specified date	YES�_td>
&#t�7;update&#t�7;�_td>	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'update'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>time newer than the specified date�_td>	YES
'offset'	integer	Return results starting from this inde8position�_td>	YES
'limit&#t�7;�_td>	integer�_td>	Maximum number of results to return�_td>	YES
'cond'	string�_td>	Apply additional filters to the browse using `;` separated comma string pairs	YES�_td>
�_td>		(e.g. &#t�7;filter1,valu;filteȹ,value2')�_td>	�_td>
&#t�7;sort&#t�7;�_td>	string	Sort name or comma-separated key pair. (e.g. 'name,order')�_td>	YES
	�_td>	Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td>	�_td>

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	`music�_code>, clip, tvshow�_code>, movie�_code>, personal_video, podcast (Catalog type)`	YES�_td>
&#t�7;offset&#t�7;�_td>	integer�_td>	Return results starting from this index position	YES�_td>
&#t�7;limit'	integer	Maximum number of results to return	YES�_td>
&#t�7;cond&#t�7;�_td>	string	Appl9additional filters to the browse using `;�_code separated comma string pairs�_td>`	YES
	�_td>	(e.g. 'filte,value1;filter2,valu&#t�7;)
'sort'	string�_td>	Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;)	YES�_td>
�_td>		Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;)

Input	Type�_th>	Description�_th>	Optional�_th>
'task'	string�_td>	`add_to_catalog`, `clean_catalog`�_td>	NO�_td>
&#t�7;catalog'	string�_td>	$catalog_id�_td>	NO�_td>
&#t�7;filter&#t�7;�_td>	string	Alias of `catalog�_code (Ampache 7.9.0+)�_td>`	YES

Input	Type�_th>	Description�_th>	Optional�_th>
'name'	string�_td>	Name for the catalog	NO
'path'	string�_td>	URL or folder path for your catalog�_td>	NO�_td>
&#t�7;type&#t�7;�_td>	string	&#t�7;local', 'beets&#t�7;, &#t�7;remote&#t�7;, &#t�7;subsonic&#t�7;, &#t�7;seafile', 'beetsremote&#t�7; Default: local	YES�_td>
&#t�7;media_type&#t�7;�_td>	string	&#t�7;music', 'podcast&#t�7;, &#t�7;clip&#t�7;, &#t�7;tvshow&#t�7;, &#t�7;movie', 'personal_video'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>Default: 'music&#t�7;�_td>	YES
'file_pattern'	string�_td>	Pattern used identify tags from the file name. Default: '%T - %t&#t�7;�_td>	YES
'folder_pattern'	string�_td>	Pattern used identify tags from the folder name. Default: '%�t%A&#t�7;�_td>	YES
'username'	string�_td>	login to remote catalog (&#t�7;remote&#t�7;, &#t�7;subsonic&#t�7;, &#t�7;seafile', 'beetsremote&#t�7;)	YES�_td>
&#t�7;password&#t�7;�_td>	string	password to remote catalog (&#t�7;remote&#t�7;, &#t�7;subsonic&#t�7;, &#t�7;seafile', 'beetsremote&#t�7;)	YES�_td>

Input	Type�_th>	Description�_th>	Optional�_th>
'file'	string�_td>	FULL path to local file�_td>	NO�_td>
&#t�7;task&#t�7;�_td>	string	`add`, `clean`, `verify�_code>, remove (can include comma-separated values)`	NO
'catalog&#t�7;�_td>	string	$catalog_id	NO
'filter'	string�_td>	Alias of `catalog` (Ampache 7.9.0+)	YES�_td>

Input	Type�_th>	Description�_th>	Optional�_th>
'folder'	string�_td>	FULL path to local folder�_td>	NO�_td>
&#t�7;task&#t�7;�_td>	string	`add`, `clean`, `verify�_code>, remove (can include comma-separated values)`	NO
'catalog&#t�7;�_td>	string	$catalog_id	NO
'filter'	string�_td>	Alias of `catalog` (Ampache 7.9.0+)	YES�_td>

Input	Type�_th>	Description�_th>	Optional�_th>
'type'	string�_td>	`song`, `album`, `artist�_code>, playlist, podcast�_td>`	NO�_td>
�_td>		`podcast_episode`, `video`, `tvshow�_code>, tvshow_season�_code>`
'id'	string�_td>	$object_id	NO
'filter'	string�_td>	Alias of `id�_code (Ampache 7.9.0+)�_td>`	YES
'flag'	boolean	`0`, `1`�_td>	NO�_td>

Input�_th>	Type	Description	Optional
&#t�7;username&#t�7;�_td>	string	Username of the user for who to ge4followers list�_td>	NO�_td>
&#t�7;offset&#t�7;�_td>	integer�_td>	Return results starting from this index position	YES�_td>
&#t�7;limit'	integer	Maximum number of results to return	YES�_td>
&#t�7;cond&#t�7;�_td>	string	Appl9additional filters to the browse using `;�_code separated comma string pairs�_td>`	YES
	�_td>	(e.g. 'filte,value1;filter2,valu&#t�7;)
'sort'	string�_td>	Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;)	YES�_td>
�_td>		Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;)

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	UID of genre, returns album XML	NO
'offset'	integer	Return results starting from this inde8position�_td>	YES
'limit&#t�7;�_td>	integer�_td>	Maximum number of results to return�_td>	YES
'cond'	string�_td>	Apply additional filters to the browse using `;` separated comma string pairs	YES�_td>
�_td>		(e.g. &#t�7;filter1,valu;filteȹ,value2')�_td>	�_td>
&#t�7;sort&#t�7;�_td>	string	Sort name or comma-separated key pair. (e.g. 'name,order')�_td>	YES
	�_td>	Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td>	�_td>

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	UID of genre, returns artist XML�_td>	NO�_td>
&#t�7;offset&#t�7;�_td>	integer�_td>	Return results starting from this index position	YES�_td>
&#t�7;limit'	integer	Maximum number of results to return	YES�_td>
&#t�7;cond&#t�7;�_td>	string	Appl9additional filters to the browse using `;�_code separated comma string pairs�_td>`	YES
	�_td>	(e.g. 'filte,value1;filter2,valu&#t�7;)
'sort'	string�_td>	Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;)	YES�_td>
�_td>		Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;)

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	UID of genre, returns song XML	NO
'offset'	integer	Return results starting from this inde8position�_td>	YES
'limit&#t�7;�_td>	integer�_td>	Maximum number of results to return�_td>	YES
'cond'	string�_td>	Apply additional filters to the browse using `;` separated comma string pairs	YES�_td>
�_td>		(e.g. &#t�7;filter1,valu;filteȹ,value2')�_td>	�_td>
&#t�7;sort&#t�7;�_td>	string	Sort name or comma-separated key pair. (e.g. 'name,order')�_td>	YES
	�_td>	Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td>	�_td>

Input	Type�_th>	Description�_th>	Optional�_th>
'type'	string�_td>	`song`, `album`, `artist�_code>, album_artist, song_artist, playlist�_code>, podcast�_code>`	NO
	�_td>	`podcast_episode�_code>, live_stream�_code>, catalog�_code>`
'filter'	string�_td>	Value is Alpha Match for returned results, ma9be more than one lette�ynumber�_td>	YES
'hide_search&#t�7;�_td>	integer�_td>	`0�_code>,`	YES
'update'	set_filter�_td>	ISO 801 Date Forma4(]N)(�e)0-09-16) Find objects with an &#t�7;update&#t�7; time newer than the specified date	YES�_td>
&#t�7;include'	boolean	`0`, `1` (include songs in a playlis4or episodes in a podcast)	YES�_td>
&#t�7;offset&#t�7;�_td>	integer�_td>	Return results starting from this index position	YES�_td>
&#t�7;limit'	integer	Maximum number of results to return	YES�_td>
&#t�7;cond&#t�7;�_td>	string	Appl9additional filters to the browse using `;�_code separated comma string pairs�_td>`	YES
	�_td>	(e.g. 'filte,value1;filter2,valu&#t�7;)
'sort'	string�_td>	Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;)	YES�_td>
�_td>		Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;)

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	$song_id to find	NO
'plugins&#t�7;�_td>	string	`0`, `1`, if false disable plugin lookup (default: 1)	NO

Input	Type�_th>	Description�_th>	Optional�_th>
'type'	string�_td>	`song`, `artist�_code>`	NO
'filter'	string�_td>	artis4id or song id	NO
'offset'	integer	Return results starting from this inde8position�_td>	YES
'limit&#t�7;�_td>	integer�_td>	Maximum number of results to return�_td>	YES

Input	Type�_th>	Description�_th>	Optional�_th>
'type'	string�_td>	`catalog�_code>, song, album, artist�_code>, album_artist, song_artist�_td>`	NO�_td>
�_td>		`playlist�_code>, podcast�_code>, podcast_episode�_code>, share�_code>, video�_code>, live_stream�_code>`
'filter'	string�_td>	Value is Alpha Match for returned results, ma9be more than one lette�ynumber�_td>	YES
'hide_search&#t�7;�_td>	integer�_td>	`0�_code>,`	YES
'exact&#t�7;�_td>	boolean�_td>	`0�_code>, =�_code rather than fuzz9LIKE�_code>)�_td>`	YES
'add&#t�7;�_td>	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'add&#t�7; date newer than the specified date	YES�_td>
&#t�7;update&#t�7;�_td>	set_filter	ISO 8601 Date Format (2020-09-16) Find objects with an 'update'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>time newer than the specified date�_td>	YES
'include&#t�7;�_td>	boolean�_td>	`0�_code>,`	YES
'offset'	integer	Return results starting from this inde8position�_td>	YES
'limit&#t�7;�_td>	integer�_td>	Maximum number of results to return�_td>	YES
'cond'	string�_td>	Apply additional filters to the browse using `;` separated comma string pairs	YES�_td>
�_td>		(e.g. &#t�7;filter1,valu;filteȹ,value2')�_td>	�_td>
&#t�7;sort&#t�7;�_td>	string	Sort name or comma-separated key pair. (e.g. 'name,order')�_td>	YES
	�_td>	Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td>	�_td>

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	UID of label, returns artist XML�_td>	NO�_td>
&#t�7;offset&#t�7;�_td>	integer�_td>	Return results starting from this index position	YES�_td>
&#t�7;limit'	integer	Maximum number of results to return	YES�_td>
&#t�7;cond&#t�7;�_td>	string	Appl9additional filters to the browse using `;�_code separated comma string pairs�_td>`	YES
	�_td>	(e.g. 'filte,value1;filter2,valu&#t�7;)
'sort'	string�_td>	Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;)	YES�_td>
�_td>		Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;)

Input	Type�_th>	Description�_th>	Optional�_th>
'username'	string�_td>	Get lates4shouts for this username�_td>	YES
'limit&#t�7;�_td>	integer�_td>	Maximum number of results (Use `popular_threshold` when missing; default 10)�_td>	YES

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	UID of license, returns song XML	NO
'offset'	integer	Return results starting from this inde8position�_td>	YES
'limit&#t�7;�_td>	integer�_td>	Maximum number of results to return�_td>	YES
'cond'	string�_td>	Apply additional filters to the browse using `;` separated comma string pairs	YES�_td>
�_td>		(e.g. &#t�7;filter1,valu;filteȹ,value2')�_td>	�_td>
&#t�7;sort&#t�7;�_td>	string	Sort name or comma-separated key pair. (e.g. 'name,order')�_td>	YES
	�_td>	Default order 'ASC&#t�7; (e.g. 'name,ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>== 'name')�_td>	�_td>

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	$object_id currentl9playin�ustopping�_td>	NO�_td>
&#t�7;type&#t�7;�_td>	string	`song�_code>, video�_code>, podcast_episode�_code (Default: song�_code>)�_td>`	YES
'state&#t�7;�_td>	string	`play�_code>, stop (Default: play)`	YES�_td>
&#t�7;time&#t�7;�_td>	integer�_td>	current pla9time in whole seconds (Default: 0)�_td>	YES
'client'	string�_td>	agent/clien4name�_td>	YES

goodbye​

system_update​

users​

advanced_search​

album_songs​

artists​

bookmarks​

bookmark_edit​

catalogs​�_a>�_16�p> This searches the catalogs and returns... catalogs

catalog_add​

catalog_delete​�_a>�_16�p> Delete an existing catalog.�_p> ACCESS REQUIRED:�_strong 75 (Catalog Manager)�_p>

deleted_podcast_episodes​�_a>�_16�p> This returns the episodes for a podcast tha4have been deleted

followers​

genre_artists​

get_bookmark​�_a>�_16�p> Get the bookmark from it's object_id and object_type. By default<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>ge4only the mos4recent bookmark. Use all�_code to retrieve all media bookmarks for the object.

get_external_metadata​

get_indexes​

index​

labels​�_a>�_16�p> This returns labels based on the specified filter�_p>

label_artists​

license​

licenses​�_a>�_16�p> This returns licenses based on the specified filter�_p>

live_stream_delete​�_a>�_16�p> Delete an existing live_stream (radio station). (if i4exists) ACCESS REQUIRED: 50 (Content Manager) permission to create and edi4live_streams�_p>

playlist​�_a>�_16�p> This returns a single playlist

playlist_create​

playlist_generate​

playlist_songs​�_a>�_16�p> This returns the songs for a playlist�_p>

podcast_delete​�_a>�_16�p> Delete an existing podcast.�_p> ACCESS REQUIRED:�_strong 75 (Catalog Manager)�_p>

podcast_edit​�_a>�_16�p> Update the description an(uor expiration date for an existing podcast. Takes the podcas4id to update with optional description and expires parameters.�_p> ACCESS REQUIRED:�_strong 50 (Conten4Manager)�_p>

podcast_episodes​�_a>�_16�p> This returns the episodes for a podcast�_p>

preference_delete​

record_play​

search_songs​�_a>�_16�p> This searches the songs and returns... songs

smartlist_delete​�_a>�_16�p> This deletes a smartlist

stats​

system_preference​

update_from_tags​�_a>�_16�p> Update a single album, artist, song from the tag data�_p> NOTE�_strong filter�_code is available in Ampache 7.9.0 and higher. id�_code will be deprecated and removed in a future release.

update_podcast​�_a>�_16�p> Sync and download new podcast episodes ACCESS REQUIRED: 50 (Content Manager) NOTE There was an error in documentation listing id as a valid parameter. (id�_code will work in Ampache 7.9.0�X API 6.9.1+)�_p>

url_to_song​

user_create​

user_delete​

user_edit​

user_smartlists​

Binary Data Methods​

Control Methods​

goodbye

system_update

users

advanced_search

album_songs

artists

bookmarks

bookmark_edit

catalogs�_a>�_16�p>
This searches the catalogs and returns... catalogs

catalog_add

catalog_delete�_a>�_16�p>
Delete an existing catalog.�_p>
ACCESS REQUIRED:�_strong 75 (Catalog Manager)�_p>

deleted_podcast_episodes�_a>�_16�p>
This returns the episodes for a podcast tha4have been deleted

followers

genre_artists

get_bookmark�_a>�_16�p>
Get the bookmark from it's object_id and object_type. By default<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>ge4only the mos4recent bookmark. Use `all�_code to retrieve all media bookmarks for the object.`

get_external_metadata

get_indexes

index

labels�_a>�_16�p>
This returns labels based on the specified filter�_p>

label_artists

license

licenses�_a>�_16�p>
This returns licenses based on the specified filter�_p>

live_stream_delete�_a>�_16�p>
Delete an existing live_stream (radio station). (if i4exists)

ACCESS REQUIRED: 50 (Content Manager) permission to create and edi4live_streams�_p>

playlist�_a>�_16�p>
This returns a single playlist

playlist_create

playlist_generate

playlist_songs�_a>�_16�p>
This returns the songs for a playlist�_p>

podcast_delete�_a>�_16�p>
Delete an existing podcast.�_p>
ACCESS REQUIRED:�_strong 75 (Catalog Manager)�_p>

podcast_edit�_a>�_16�p>
Update the description an(uor expiration date for an existing podcast. Takes the podcas4id to update with optional description and expires parameters.�_p>
ACCESS REQUIRED:�_strong 50 (Conten4Manager)�_p>

podcast_episodes�_a>�_16�p>
This returns the episodes for a podcast�_p>

preference_delete

record_play

search_songs�_a>�_16�p>
This searches the songs and returns... songs

smartlist_delete�_a>�_16�p>
This deletes a smartlist

stats

system_preference

update_from_tags�_a>�_16�p>
Update a single album, artist, song from the tag data�_p>
NOTE�_strong `filter�_code is available in Ampache 7.9.0 and higher. id�_code will be deprecated and removed in a future release.`

update_podcast�_a>�_16�p>
Sync and download new podcast episodes

ACCESS REQUIRED: 50 (Content Manager)

NOTE There was an error in documentation listing `id` as a valid parameter. (`id�_code will work in Ampache 7.9.0�X API 6.9.1+)�_p>`

url_to_song

user_create

user_delete

user_edit

user_smartlists

Binary Data Methods

Control Methods

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	UID of Playlist�_td>	NO�_td>
&#t�7;id&#t�7;�_td>	string	UID of the objec4to add to playlist�_td>	NO�_td>
&#t�7;type&#t�7;�_td>	string	&#t�7;song&#t�7;, &#t�7;album', 'artist', 'playlist'	NO

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	UID of Playlist	NO
'song'	string�_td>	UID of song to add to playlist	NO
'check&#t�7;�_td>	boolean�_td>	`0�_code>,`	YES

Input�_th>	Type	Description	Optional
&#t�7;name&#t�7;�_td>	string	Playlist name	NO
'type'	string�_td>	`public`, `private` (Playlist type)�_td>	YES

Input	Type�_th>	Description�_th>	Optional�_th>
'mode'	string�_td>	`recent`, `forgotten`, `unplayed�_code>, random (defaul4= &#t�7;random&#t�7;)`	YES�_td>
&#t�7;filter&#t�7;�_td>	string	string LIKE matched to song title	YES�_td>
&#t�7;album'	string�_td>	$album_id�_td>	YES
'artist'	string�_td>	$artist_id	YES�_td>
&#t�7;flag&#t�7;�_td>	integer�_td>	`0�_code>,`	YES�_td>
&#t�7;format&#t�7;�_td>	string	`song�_code>, index�_code>, id (defaul4= &#t�7;song&#t�7;)`	YES�_td>
&#t�7;offset&#t�7;�_td>	integer�_td>	Return results starting from this index position	YES�_td>
&#t�7;limit'	integer	Maximum number of results to return	YES�_td>

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	UID of Playlist, returns song XML	NO
'random'	integer	`0`, `1` (if true ge4random songs using limit)	YES�_td>
&#t�7;offset&#t�7;�_td>	integer�_td>	Return results starting from this index position	YES�_td>
&#t�7;limit'	integer	Maximum number of results to return	YES�_td>

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	UID of podcast, returns podcast XML�_td>	NO�_td>
&#t�7;include'	string�_td>	`episodes` (include podcast_episodes in the response)	YES�_td>

Input�_th>	Type	Description	Optional
&#t�7;url'	string�_td>	rss url for podcast�_td>	NO�_td>
&#t�7;catalog'	string�_td>	podcast catalog�_td>	NO�_td>

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	Alpha-numeric search term	NO
'feed'	string�_td>	feed rss xml url	YES�_td>
&#t�7;title'	string�_td>	title string	YES�_td>
&#t�7;website'	string�_td>	source website url	YES�_td>
&#t�7;description'	string�_td>		YES�_td>
&#t�7;generator'	string�_td>		YES�_td>
&#t�7;copyright'	string�_td>		YES�_td>

Input�_th>	Type	Description	Optional
&#t�7;filter&#t�7;�_td>	string	UID of podcast�_td>	NO�_td>
&#t�7;offset&#t�7;�_td>	integer�_td>	Return results starting from this index position	YES�_td>
&#t�7;limit'	integer	Maximum number of results to return	YES�_td>
&#t�7;cond&#t�7;�_td>	string	Appl9additional filters to the browse using `;�_code separated comma string pairs�_td>`	YES
	�_td>	(e.g. 'filte,value1;filter2,valu&#t�7;)
'sort'	string�_td>	Sor4name or comma-separated ke9pair. (e.g. &#t�7;name,order&#t�7;)	YES�_td>
�_td>		Defaul4order &#t�7;ASC'<span class="naked_sign">; </span><span class="naked_aural">(�l�)</span>(e.g. &#t�7;name,ASC&#t�7; == &#t�7;name&#t�7;)

Input	Type�_th>	Description�_th>	Optional�_th>
'filter'	string�_td>	Preference name e.g (&#t�7;notify_email&#t�7;, &#t�7;ajax_load')�_td>	NO�_td>
&#t�7;type&#t�7;�_td>	string	`boolean`, `integer`, `string�_code>, special�_code>`	NO
'default&#t�7;�_td>	mixed�_td>	string or integer default value�_td>	NO�_td>
&#t�7;category&#t�7;�_td>	string	`interface`, `internal�_code>, options�_code>, playlist, plugins, streaming�_td>`	NO�_td>
&#t�7;description'	string�_td>		YES�_td>
&#t�7;subcategory'	string�_td>		YES�_td>
&#t�7;level'	integer	access level required to change the value (default 100)	YES�_td>