Class: MusebaseResource

Playlists

addTrackToPlaylist()

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

addTrackToPlaylist(playlistId, trackId): Promise<BaseOkay>

Adds a track to playlist

Parameters

playlistId

number

Playlist identifier

trackId

number

Track identifier

Returns

Promise<BaseOkay>

BaseOkay Operation result

Since

1.0.0

Throws

If parameters are invalid

Example

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

---

createPlaylist()

POST /musebase/playlists

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

Creates a new playlist

Parameters

name

string

Playlist name

release

string

Release information

description

string

Playlist description

cover

number

Cover photo ID

Returns

Promise<Playlist>

Playlist Created playlist

Since

1.0.0

Throws

If playlist data is invalid

Example

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

---

deletePlaylist()

DELETE /musebase/playlists/{playlist_id}

deletePlaylist(playlistId): Promise<BaseOkay>

Deletes a playlist

Parameters

playlistId

number

Playlist identifier

Returns

Promise<BaseOkay>

DeletePlaylistResponse Delete response

Since

1.0.0

Throws

If playlist ID is invalid

Example

await rest.musebase.deletePlaylist(123);

---

getPlaylist()

GET /musebase/playlists/{playlist_id}

getPlaylist(playlistId): Promise<Playlist>

Gets a playlist by identifier

Parameters

playlistId

number

Playlist identifier

Returns

Promise<Playlist>

Playlist object

Since

1.0.0

Throws

If playlist ID is invalid

Example

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

---

getUserPlaylists()

GET /user/{user_tag}/playlists

getUserPlaylists(tag): Promise<Playlist[]>

Gets user playlists by tag

Parameters

tag

string

User tag

Returns

Promise<Playlist[]>

Array of Playlist objects

Since

1.0.0

Throws

If tag is invalid

Example

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

---

removeTrackFromPlaylist()

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

removeTrackFromPlaylist(playlistId, trackId): Promise<Playlist>

Removes a track from playlist

Parameters

playlistId

number

Playlist identifier

trackId

number

Track identifier

Returns

Promise<Playlist>

DeleteTrackResponse Delete response

Since

1.0.0

Throws

If parameters are invalid

Example

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

---

updatePlaylist()

PATCH /musebase/playlists/{playlist_id}

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

Updates a playlist

Parameters

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

Since

1.0.0

Throws

If parameters are invalid

Example

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

Tracks

find()

GET /musebase/find/{mask}

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

Find tracks

Parameters

query

string

Song name or artist

page?

number

Page number (optional)

Returns

Promise<Track[]>

Track list

Since

1.0.0

Deprecated

Use rest.search.tracks() instead

Example

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

---

getTrack()

GET /musebase/{track_id}

getTrack(trackId): Promise<Track>

Gets a track by identifier

Parameters

trackId

number

Track identifier

Returns

Promise<Track>

Track object

Since

1.0.0

Throws

If track ID is invalid

Example

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