Class: MusebaseResource

Playlists

.addTrackToPlaylist(playlistId, trackId): Promise<BaseOkay> 1.0.0

POST /musebase/playlists/{playlist_id}/tracks/{track_id}

Adds a track to playlist

Parameters

Name	Type	Description
playlistId	number	Playlist identifier
trackId	number	Track identifier

Returns

Promise<BaseOkay>

BaseOkay Operation result

Throws

If parameters are invalid

Example

await rest.musebase.addTrackToPlaylist(123, 456);

---

.createPlaylist(name, release, description, cover): Promise<Playlist> 1.0.0

POST /musebase/playlists

Creates a new playlist

Parameters

Name	Type	Description
name	string	Playlist name
release	string	Release information
description	string	Playlist description
cover	number	Cover photo ID

Returns

Promise<Playlist>

Playlist Created playlist

Throws

If playlist data is invalid

Example

const playlist = await rest.musebase.createPlaylist('My Playlist', '2024', 'Description', 123);

---

.deletePlaylist(playlistId): Promise<BaseOkay> 1.0.0

DELETE /musebase/playlists/{playlist_id}

Deletes a playlist

Parameters

Name	Type	Description
playlistId	number	Playlist identifier

Returns

Promise<BaseOkay>

DeletePlaylistResponse Delete response

Throws

If playlist ID is invalid

Example

await rest.musebase.deletePlaylist(123);

---

.getPlaylist(playlistId): Promise<Playlist> 1.0.0

GET /musebase/playlists/{playlist_id}

Gets a playlist by identifier

Parameters

Name	Type	Description
playlistId	number	Playlist identifier

Returns

Promise<Playlist>

Playlist object

Throws

If playlist ID is invalid

Example

const playlist = await rest.musebase.getPlaylist(123);

---

.getUserPlaylists(tag): Promise<Playlist[]> 1.0.0

GET /user/{user_tag}/playlists

Gets user playlists by tag

Parameters

Name	Type	Description
tag	string	User tag

Returns

Promise<Playlist[]>

Array of Playlist objects

Throws

If tag is invalid

Example

const playlists = await rest.musebase.getUserPlaylists('username');

---

.removeTrackFromPlaylist(playlistId, trackId): Promise<Playlist> 1.0.0

DELETE /musebase/playlists/{playlist_id}/tracks/{track_id}

Removes a track from playlist

Parameters

Name	Type	Description
playlistId	number	Playlist identifier
trackId	number	Track identifier

Returns

Promise<Playlist>

DeleteTrackResponse Delete response

Throws

If parameters are invalid

Example

await rest.musebase.removeTrackFromPlaylist(123, 456);

---

.updatePlaylist(playlistId, name, release, description, cover): Promise<BaseOkay> 1.0.0

PATCH /musebase/playlists/{playlist_id}

Updates a playlist

Parameters

Name	Type	Description
playlistId	number	Playlist identifier
name	string	Playlist name
release	string	Release information
description	string	Playlist description
cover	number	Cover photo ID

Returns

Promise<BaseOkay>

EditPlaylistResponse Update response

Throws

If parameters are invalid

Example

await rest.musebase.updatePlaylist(123, 'Updated Name', '2024', 'New description', 456);

Tracks

find()

find(query, page?): Promise<Track[]>

Find tracks

Parameters

Name	Type	Description
query	string	Song name or artist
page?	number	Page number (optional)

Returns

Promise<Track[]>

Track list

Deprecated

Use rest.search.tracks() instead

Example

// Use rest.search.tracks() instead
const tracks = await rest.search.tracks('Bohemian Rhapsody');

---

.getTrack(trackId): Promise<Track> 1.0.0

GET /musebase/{track_id}

Gets a track by identifier

Parameters

Name	Type	Description
trackId	number	Track identifier

Returns

Promise<Track>

Track object

Throws

If track ID is invalid

Example

const track = await rest.musebase.getTrack(123);