_introduction.md

Song Requests

The song request endpoints allow you to view, add, edit, and delete song from the song request queue and playlist as well as modify the settings for song requests.

Song Request Settings Resource

Fields	Type	Description
enabled	boolean	The status of song requests. If true, song requests are enabled and songs can be requested by users. If false, song requests are disabled and are nonfunctional.
limits	object	Contains user-configurable song request limits
limits .queue	number	The maximum number of songs in the queue (minimum 1, maximum 100)
limits .user	number	The maximum number of songs a user can request at a time (minimum 1, maximum 100)
limits .playlistOnly	boolean	If true, song requests will be limited to the configured playlist. If false, requests can be made from any listed providers
limits .exemptUserLevel	enum	The userlevel required to be exempt from the limits
playlist	enum	The playlist AutoDJ will source from when the queue is empty. If limits.playlistOnly is true all requested songs must be on this playlist. Available playlists are listed in the song request settings GET endpoint as playlists.
providers	array	An array of enums for the enabled song request providers. Providers are the services which we support pulling songs from. Available providers are listed in the song request settings GET endpoint as providers.
searchProvider	enum	Instead of requiring users to request songs with a URL or ID, users can search for the closest match to request a song. This controls where that search is performed. Available providers are listed in the song request settings GET endpoint as providers.
userLevel	enum	The userlevel required to be able to request songs
volume	number	The volume that the AutoDJ player runs at (minimum 0, maximum 100)
youtube	object	YouTube-specific song request settings
youtube .limitToMusic	boolean	To reduce non-music videos from being requested, you can limit to just the music category by setting this to true. If set to false, videos are not restricted to just the music category.
youtube .limitToLikedVideos	boolean	To reduce bad videos from being requested, you can limit to videos with more likes than dislikes by setting this to true. If set to false, videos with more dislikes than likes are able to be requested. Defaults to true

Playlist Item Resource

Fields	Type	Description
_id	string	The playlist item's unique id
createdAt	date	The time the playlist item was created
track	object	Track Information
track .artist	string, optional	Track Artist
track .duration	number	Track Duration (in seconds)
track .provider	enum	Track Provider (like "youtube" or "soundcloud")
track .providerId	string	Track Provider's unique id
track .title	string	Track Title
track .url	string	Track URL
updatedAt	date	The last time the playlist item was updated

Queue Item Resource

Fields	Type	Description
_position	number, optional	The queue item's position in the queue
_id	string	The queue item's unique id
createdAt	date	The time the queue item was created
track	object	Track Information
track .artist	string, optional	Track Artist
track .duration	number	Track Duration (in seconds)
track .provider	enum	Track Provider (like "youtube" or "soundcloud")
track .providerId	string	Track Provider's unique id
track .title	string	Track Title
track .url	string	Track URL
user	object	Information about who the queue item belongs to
user .displayName	string	User display name
user .name	string	User unique name
user .provider	enum	User provider (like "twitch" or "youtube")
user .providerId	string	User provider's unique id
updatedAt	date	The last time the queue item was updated