Authentication API

POST

/api/login

Login a user.

Parameters

Name	Type	Description	Constraints
email	string	The email of the user.	Required
password	string	The password of the user.	Required

POST

/api/logout

Logout the current user.

POST

/api/register

Register a new user.

Parameters

Name	Type	Description	Constraints
name	string	The name of the user.	Required
email	string	The email of the user.	Required Unique
password	string	The password for the new account.	Required
password_confirmation	string	The password confirmation for the new account.	Required

POST

/api/password/forgot

Send a password reset link.

Parameters

Name	Type	Description	Constraints
email	string	The email of the user.	Required

POST

/api/login/{driver}/callback

Handle OAuth provider callback for login.

Parameters

Name	Type	Description	Constraints
driver	string	The OAuth provider (e.g., google, facebook).	Required
profile	object	The profile data returned by the OAuth provider.	Required

POST

/api/password/reset

Reset the user password.

Parameters

Name	Type	Description	Constraints
email	string	The email of the user.	Required
token	string	The password reset token.	Required
password	string	The new password.	Required
password_confirmation	string	The confirmation of the new password.	Required

GET

/api/email/verify/{id}

Verify if the user email address is verified.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the user.	Required

Users API

Admin endpoints

GET

/api/admin/users

Retrieve a list of users.

Example Response [+]

POST

/api/admin/users

Create a new user.

Parameters

Name	Type	Description	Constraints
email	string	The email of the user.	Required Unique Format: email
name	string	The name of the user.	Required Unique Min Length: 3 Max Length: 50
password	string	The password of the user.	Required Min Length: 8
available_disk_space	integer	The available disk space for the user (in MB).
avatar	file|url	The avatar image of the user.
roles	json	The roles to be assigned to the user.
permissions	json	The permissions to be assigned to the user.

Example Response [+]

GET

/api/admin/users/{user}

Retrieve a specific user by its ID.

Parameters

Name	Type	Description	Constraints
user	integer	The unique identifier for the user.

Example Response [+]

PUT

/api/admin/users/{user}

Update a specific user.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the user.	Required
email	string	The new email of the user.	Required Unique Format: email
name	string	The new name of the user.	Required Unique Min Length: 3 Max Length: 50
password	string	The new password of the user.	Min Length: 8
available_disk_space	integer	The available disk space for the user (in MB).
avatar	file|url	The avatar image of the user.
roles	json	The roles to be assigned to the user.
permissions	json	The permissions to be assigned to the user.

DELETE

/api/admin/users/{user}

Delete a specific user.

Parameters

Name	Type	Description	Constraints
user	integer	The unique identifier for the user.

Example Response [+]

User endpoints

GET

/api/user

Get the account information of the current logged user.

Example Response [+]

POST

/api/add-friend

Send a friend request to a user.

Parameters

Name	Type	Description	Constraints
user_id	integer	The ID of the user to send a friend request to.	Required

Example Response [+]

POST

/api/user/accept-friendship

Accept a friendship request.

Parameters

Name	Type	Description	Constraints
friend_id	integer	The unique identifier for the friend.	Required

Example Response [+]

POST

/api/user/cancel-subscription

Cancel the current subscription.

Parameters

Name	Type	Description	Constraints
subscription_id	integer	The unique identifier for the subscription.	Required
password	integer	The password on the current user.	Required

POST

/api/user/checkout-with-paypal

Checkout with PayPal.

POST

/api/user/checkout-with-stripe

Checkout with Stripe.

Parameters

Name	Type	Description	Constraints
payment_method	string	The payment method identifier from Stripe.	Required

POST

/api/user/create-intent

Create a payment intent with Stripe.

POST

/api/user/end-play/{play_id}

End a play session.

Parameters

Name	Type	Description	Constraints
play_id	integer	The unique identifier for the play session.	Required

GET

/api/user/follows/{type}

Get the follows of a specific type for the current user.

Parameters

Name	Type	Description	Constraints
type	string	The type of content to retrieve follows for. possible values are: artist, podcast	Required

GET

/api/user/likes/{type}

Get the likes of a specific type for the current user.

Parameters

Name	Type	Description	Constraints
type	string	The type of content to retrieve likes for. possible values are: song, album, playlist, radio-station	Required

Example Response [+]

GET

/api/user/friends

Get the friends of the current user.

Example Response [+]

GET

/api/user/notifications

Get the notifications for the current user.

Example Response [+]

POST

/api/user/playing

Update the current playing status for the user.

Parameters

Name	Type	Description	Constraints
playlist	integer	The unique identifier for the playlist.
genre_id	integer	The unique identifier for the genre.
radio	boolean	Whether the user is playing radio.
playlist_index	integer	The index of the current song in the playlist.

GET

/api/user/playlists

Get the playlists for the current user.

Example Response [+]

POST

/api/user/playlists

Create a new playlist for the current user.

Parameters

Name	Type	Description	Constraints
title	string	The name of the playlist.	Required
public	boolean	If the playlist should be public.	Required
cover	file|url	The cover image of the playlist.

DELETE

/api/user/playlists/{playlist}

Delete a specific playlist.

Parameters

Name	Type	Description	Constraints
playlist	integer	The unique identifier for the playlist.	Required

PUT

/api/user/playlists/{playlist}

Update a specific playlist.

Parameters

Name	Type	Description	Constraints
title	string	The name of the playlist.	Required
public	boolean	If the playlist should be public.	Required
cover	file|url	The cover image of the playlist.

GET

/api/user/purchases

Get the purchases for the current user.

Example Response [+]

GET

/api/user/recent-plays

Get the recent plays for the current user.

Example Response [+]

POST

/api/user/register-play

Register a play for the current user.

Parameters

Name	Type	Description	Constraints
song_id	integer	The unique identifier for the song.	Required

Example Response [+]

POST

/api/user/reject-friendship

Reject a friendship request.

Parameters

Name	Type	Description	Constraints
notification_id	integer	The unique identifier for the friend request notification.	Required

Example Response [+]

POST

/api/user/add-to-cart

Add item to the user's cart.

Parameters

Name	Type	Description	Constraints
cart	array	The updated cart items.	Required

POST

/api/user/remove-from-cart

Remove an item from the user's cart.

Parameters

Name	Type	Description	Constraints
item_id	integer	The unique identifier for the item.	Required

POST

/api/user/request-artist-account

Request an artist account.

Parameters

Name	Type	Description	Constraints
firstname	string	The first name of the user.	Required Min Length: 3
lastname	string	The last name of the user.	Required Min Length: 3
displayname	string	The display name of the user.	Required Min Length: 3 Unique
country	string	The country of the user.	Required
email	string	The email of the user.	Required Format: email
phone	string	The phone number of the user.	Required
address	string	The address of the user.	Required
spotify_link	string	The spotify_link of the artist.
youtube_link	string	The youtube_link of the artist.
soundcloud_link	string	The soundcloud_link of the artist.
itunes_link	string	The itunes_link of the artist.

POST

/api/user/save-account-settings

Save the account settings of a user.

Parameters

Name	Type	Description	Constraints
name	string	The name of the user.	Required
lang	string	The language preference of the user.
hide_activity	boolean	The activity visibility preference of the user.
currentPassword	string	The current password of the user.	Required Min Length: 8
newPassword	string	The new password of the user.	Required Min Length: 8

GET

/api/user/songs

Retrieve a list of songs for the current user.

Example Response [+]

POST

/api/user/songs

Add a new song for the current user.

Parameters

Name	Type	Description	Constraints
title	string	The title of the song.	Required
artist	string	The artist of the song.	Required
album	string	The album of the song.
duration	string	The duration of the song.
genre	string	The genre of the song.
release_date	date	The release date of the song.

DELETE

/api/user/songs/{id}

Delete a specific song.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the song.	Required

Example Response [+]

POST

/api/follow

Follow a user, an artist or a podcast

Parameters

Name	Type	Description	Constraints
type	string	The type of entity to follow.	Required Possible values: user, artist, podcast
id	integer	The unique identifier of the entity to follow.	Required
origin	string	The origin of the follow request.	Required

POST

/api/unfollow

Unfollow an entity.

Parameters

Name	Type	Description	Constraints
type	string	The type of entity to unfollow (user|artist|podcast).	Required
id	integer	The unique identifier of the entity being unfollowed.	Required
origin	string	The origin of the unfollow request.	Required

POST

/api/like

Like content.

Parameters

Name	Type	Description	Constraints
type	string	The type of content being liked (song|album|playlist).	Required
id	integer	The unique identifier of the content being liked.	Required
origin	string	The origin of the like request.	Required

POST

/api/dislike

Dislike content.

Parameters

Name	Type	Description	Constraints
type	string	The type of content being disliked (song|album|playlist).	Required
id	integer	The unique identifier of the content being disliked.	Required
origin	string	The origin of the dislike request.	Required

Roles API

Admin endpoints

Admin Role Routes

POST

/api/admin/roles

Create a new role.

Parameters

Name	Type	Description	Constraints
name	string	The name of the role.	Required
category	string	The category of the role (admin, artist or user).	Required
current_permissions	array	The permissions assigned to the role.	Required Min: 1

GET

/api/admin/roles

Get a list of all roles with their permissions.

Example Response [+]

POST

/api/admin/roles/sync

Sync the roles and permissions for all users.

PUT

/api/admin/roles/{role}

Update a specific role.

Parameters

Name	Type	Description	Constraints
role	int	The ID of the role.	Required
category	string	The category of the role (admin, artist or user).
name	string	The name of the role.	Required
current_permissions	array	The permissions assigned to the role.	Required Min: 1

DELETE

/api/admin/roles/{role}

Delete a specific role.

Parameters

Name	Type	Description	Constraints
role	int	The ID of the role.	Required

POST

/api/admin/save-roles

Save roles settings.

Parameters

Name	Type	Description	Constraints
roles	array	The roles to save.	Required Min: 1

POST

/api/admin/approve-user-artist-request

Approve the user's artist account request.

POST

/api/admin/reject-user-artist-request

Reject the user's artist account request.

POST

/api/admin/reset-roles

Reset all roles to their default permissions.

Playlists API

Admin endpoints

GET

/api/admin/playlists

Retrieve a list of playlists.

Example Response [+]

POST

/api/admin/playlists

Create a new playlist.

Parameters

Name	Type	Description	Constraints
title	string	The title of the playlist.	Required Max Length: 255 Min Length: 1
cover	string|UploadFile	The URL of the cover image or an uploaded file for the playlist.	Required
user_id	integer	The ID of the user creating the playlist.	Required
created_by	string	The role of the person creating the playlist (admin or user).	Required Max Length: 255
public	boolean	Whether the playlist is public or private.	Required

GET

/api/playlists/{id}

Retrieve a specific playlist by its ID.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the playlist.	Required

Example Response [+]

PUT

/api/admin/playlists/{id}

Update a specific playlist.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the playlist.	Required
title	string	The new title of the playlist.	Max Length: 255 Min Length: 1
cover	UploadFile	The new uploaded file for the playlist cover image.
public	boolean	The new visibility status of the playlist.

DELETE

/api/admin/playlists/{id}

Delete a specific playlist.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the playlist.	Required

POST

/api/admin/add-songs-to-playlists

Add songs to a playlist.

Parameters

Name	Type	Description	Constraints
playlists	array	The array of IDs of the playlists to add songs to.	Required
songs	array	An array of song IDs to add to the playlist.	Required

POST

/api/attach-to-playlist/{playlist}

Attach a song to a playlist.

Parameters

Name	Type	Description	Constraints
playlist	integer	The ID of the playlist.	Required
song_id	integer	The ID of the song to attach to the playlist.	Required

POST

/api/detach-from-playlist/{playlist}

Detach a song from a playlist.

Parameters

Name	Type	Description	Constraints
playlist	integer	The ID of the playlist.	Required
song_id	integer	The ID of the song to detach from the playlist.	Required

POST

/api/make-playlist-private/{playlist}

Make a playlist private.

Parameters

Name	Type	Description	Constraints
playlist	integer	The unique identifier for the playlist.	Required

POST

/api/make-playlist-public/{playlist}

Make a playlist public.

Parameters

Name	Type	Description	Constraints
playlist	integer	The unique identifier for the playlist.	Required

GET

/api/match-playlists

Match playlists based on criteria.

Parameters

Name	Type	Description	Constraints
query	string	The search query to match playlists against.

Example Response [+]

GET

/api/user/playlists

Retrieve playlists for the current user.

Example Response [+]

POST

/api/user/playlists

Create a new playlist for the current user.

Parameters

Name	Type	Description	Constraints
title	string	The title of the playlist.	Max Length: 255 Min Length: 1
public	boolean	Whether the playlist is public or private.

DELETE

/api/user/playlists/{id}

Delete a playlist for the current user.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the playlist.	Required

PUT

/api/user/playlists/{id}

Update a playlist for the current user.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the playlist.	Required
title	string	The new title of the playlist.	Max Length: 255 Min Length: 1
cover	string	The new URL of the cover image for the playlist.
public	boolean	The new visibility status of the playlist.

Songs API

Admin endpoints

POST

/api/upload

Upload a new song.

Parameters

Name	Type	Description	Constraints
song	file	The song file to upload.	Required Possible values: wav,mp3 Max: Size based on server setting
uploaded_by	string	The uploader role, either admin or user.	Required

GET

/api/songs/{song}

Get a specific song by its ID.

Parameters

Name	Type	Description	Constraints
song	integer	The unique identifier for the song.	Required

Example Response [+]

POST

/api/songs

Store a new song.

Parameters

Name	Type	Description	Constraints
title	string	The title of the song.	Required Max Length: 255 Min Length: 1
source	file|url	The source of the song, this could be the URL of the song, the file or the youtube video ID.	Required
cover	file|url	The cover image for the song.	Required
source_format	string	The format of the song source.	Required Format: in:file,audio_url,yt_video
artists	array	A list of artist IDs.	Format: json
genres	array	A list of genre IDs.	Format: json
prices	json	Pricing/licences information for the song.
duration	integer	The duration of the song in seconds.
uploaded_by	string	The role of the uploader who uploaded the song.	Required
user_id	integer	The ID of the user who uploaded the song.	Required
artist_id	integer	The ID of the artist.	Required
public	boolean	Whether the song is public or private.	Required
hls	boolean	Whether the song uses HLS streaming.
isProduct	boolean	Whether the song is a product.
isExclusive	boolean	Whether the song is exclusive.
isExplicit	boolean	Whether the song is explicit.
album_id	integer	The ID of the album.	Required
playSample	boolean	Whether to play a sample of the song.
saveFileFromURL	boolean	Whether to save the file from a URL.
sampleSeconds	integer	The number of seconds for the song sample.	Min: 0

PUT

/api/songs/{song}

Update an existing song.

Parameters

Name	Type	Description	Constraints
song	integer	The unique identifier for the song.	Required
title	string	The title of the song.	Max Length: 255 Min Length: 1
source	string	The source of the song.	Required
cover	file|url	The cover image for the song.
source_format	string	The format of the song source.	Required Format: in:file,audio_url,yt_video
artists	array	A list of artist IDs.	Format: json
genres	array	A list of genre IDs.	Format: json
prices	json	Pricing information for the song.
duration	integer	The duration of the song in seconds.
user_id	integer	The ID of the user who uploaded the song.	Required
artist_id	integer	The ID of the artist.	Required
public	boolean	Whether the song is public or private.	Required
hls	boolean	Whether the song uses HLS streaming.
isProduct	boolean	Whether the song is a product.
isExclusive	boolean	Whether the song is exclusive.
isExplicit	boolean	Whether the song is explicit.
album_id	integer	The ID of the album.	Required
playSample	boolean	Whether to play a sample of the song.
saveFileFromURL	boolean	Whether to save the file from a URL.
sampleSeconds	integer	The number of seconds for the song sample.	Min: 0

DELETE

/api/songs/{song}

Delete a specific song.

Parameters

Name	Type	Description	Constraints
song	integer	The unique identifier for the song.	Required

GET

/api/download-song/{id}

Download a specific song.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the song.	Required

GET

/api/more-from-genre/{genre_id}

Get more songs from a genre.

Parameters

Name	Type	Description	Constraints
genre_id	integer	The unique identifier for the genre.	Required

GET

/api/match-songs

Match songs based on criteria.

Parameters

Name	Type	Description	Constraints
query	string	The query to match with.	Required

GET

/api/artist/match-songs/{keyword}

Match songs by artist and keyword.

Parameters

Name	Type	Description	Constraints
keyword	string	The keyword to search for matching songs.	Required

POST

/api/make-song-private/{id}

Make a song private.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the song.	Required

POST

/api/make-song-public/{id}

Make a song public.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the song.	Required

GET

/api/next-songs

Get the next songs in the queue.

Example Response [+]

GET

/api/user/songs

Get songs for the current user.

Example Response [+]

POST

/api/import-youtube-video

Import a YouTube video as a song.

Parameters

Name	Type	Description	Constraints
url	string	The URL of the YouTube video.	Required

POST

/api/delete-songs

Delete multiple songs.

Parameters

Name	Type	Description	Constraints
song_ids	array	An array of song IDs to delete.	Required

GET

/api/stream/{type}/{id}

Stream content by type and ID.

Parameters

Name	Type	Description	Constraints
type	string	The type of content to stream song or episode.	Required
id	integer	The unique identifier for the content.	Required

Example Response [+]

Albums API

Admin endpoints

POST

/api/admin/albums

Create a new album.

Parameters

Name	Type	Description	Constraints
title	string	The title of the album.	Required
release_date	date	The release date of the album.	Required
cover	file|url	The cover image of the album.	Required
created_by	string	The creator of the album.	Required
isProduct	boolean	Whether the album is a product.
isExclusive	boolean	Whether the album is exclusive.
isExplicit	boolean	Whether the album is explicit.
spotify_link	string	The Spotify link of the album.
youtube_link	string	The YouTube link of the album.
soundcloud_link	string	The SoundCloud link of the album.
itunes_link	string	The iTunes link of the album.
deezer_link	string	The Deezer link of the album.
songs	string	The songs array as string.
artists	string	The artists array as a string.

GET

/api/admin/albums

Retrieve a list of albums.

Example Response [+]

GET

/api/admin/albums/{album}

Retrieve a specific album by its ID.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the album.	Required

Example Response [+]

PUT

/api/admin/albums/{album}

Update a specific album.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the album.	Required
title	string	The new title of the album.	Required
release_date	date	The new release date of the album.	Required
cover	file|url	The new cover image of the album.	Required
created_by	string	The new creator of the album.	Required
isProduct	boolean	The new product status of the album.
isExclusive	boolean	The new exclusive status of the album.
isExplicit	boolean	The new explicit status of the album.
spotify_link	string	The new Spotify link of the album.
youtube_link	string	The new YouTube link of the album.
soundcloud_link	string	The new SoundCloud link of the album.
itunes_link	string	The new iTunes link of the album.
deezer_link	string	The new Deezer link of the album.
songs	array	The new songs in the album.
artists	array	The new artists of the album.

DELETE

/api/admin/albums/{album}

Delete a specific album.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the album.	Required

GET

/api/more-from-album/{id}

Get more songs from an album.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the album.	Required
origin	string	The origin source of the album.	Required

Radio Stations API

Admin endpoints

Admin Radio Station Routes

POST

/api/admin/radio-stations

Store a new radio station.

Parameters

Name	Type	Description	Constraints
name	string	Name of the radio station.	Required Min: 1 Max: 255
streamEndpoint	string	Stream endpoint of the radio station.	Required
serverType	string	Type of server.	Required Possible values: shoutcast, icecast
serverURL	string	Server URL.
serverID	string	Server ID.
serverMount	string	Server mount point.
serverUsername	string	Server username.
serverPassword	string	Server password.
statsEndpoint	string	Endpoint for statistics.
statsSource	string	Source of statistics.	Required
highlight	boolean	Highlight status.
proxy	boolean	To use your server as a proxy.
interval	integer	Interval for statistics update.	Required Min: 0
cover	file|url	Cover image for the radio station.
genres	array	Genres associated with the radio station.

PUT

/api/admin/radio-stations/{radio_station}

Update an existing radio station.

Parameters

Name	Type	Description	Constraints
radio_station	integer	ID of the radio station.	Required
name	string	Name of the radio station.	Required Min: 1 Max: 255
streamEndpoint	string	Stream endpoint of the radio station.	Required
serverType	string	Type of server.	Required Possible values: shoutcast, icecast
serverURL	string	Server URL.
serverID	string	Server ID.
serverMount	string	Server mount point.
serverUsername	string	Server username.
serverPassword	string	Server password.
statsEndpoint	string	Endpoint for statistics.
statsSource	string	Source of statistics.	Required
highlight	boolean	Highlight status.
proxy	boolean	Proxy status.
interval	integer	Interval for statistics update.	Required Min: 0
cover	file|url	Cover image for the radio station.
genres	array	Genres associated with the radio station.

PUT

/api/admin/radio-stations/{radio_station}

Update an existing radio station.

Parameters

Name	Type	Description	Constraints
radio_station	integer	ID of the radio station.	Required
name	string	Name of the radio station.	Required
streamEndpoint	string	Stream endpoint of the radio station.	Required
serverType	string	Type of server.	Possible values: shoutcast, icecast
serverURL	string	Server URL.
serverID	string	Server ID.
serverMount	string	Server mount point.
serverUsername	string	Server username.
serverPassword	string	Server password.
statsEndpoint	string	Endpoint for statistics.
statsSource	string	Source of statistics.
highlight	boolean	Highlight status.
proxy	boolean	Proxy status.
interval	integer	Interval for statistics update.
cover	file|url	Cover image for the radio station.
genres	array	Genres associated with the radio station.

GET

/api/admin/radio-stations

Get a list of radio stations.

Example Response [+]

DELETE

/api/admin/radio-stations/{radio_station}

Delete a radio station.

Parameters

Name	Type	Description	Constraints
radio_station	integer	ID of the radio station.	Required

User endpoints

User Radio Station Routes

GET

/api/get-stream-metadata-pr/{station_id}

Get stream metadata using proxy.

Parameters

Name	Type	Description	Constraints
station_id	integer	ID of the radio station.	Required

Example Response [+]

GET

/api/get-stream-metadata-sr/{station_id}

Get stream metadata from server.

Parameters

Name	Type	Description	Constraints
station_id	integer	ID of the radio station.	Required

Example Response [+]

GET

/api/highlights

Get highlighted radio stations.

Example Response [+]

GET

/api/match-radio-stations

Match radio stations.

Parameters

Name	Type	Description	Constraints
query	string	Search query.

Example Response [+]

GET

/api/radio-station/{radioStation}

Get a specific radio station by ID.

Parameters

Name	Type	Description	Constraints
radioStation	integer	ID of the radio station.	Required

Example Response [+]

Podcasts API

Admin endpoints

POST

/api/podcasts

Store a new podcast.

Parameters

Name	Type	Description	Constraints
title	string	The title of the podcast.	Required Max Length: 255 Min Length: 1
description	string	A brief description of the podcast.
genres	array	The genre IDs of the podcast.	Required
artist_id	integer	The artist ID of the podcast.
cover	file|url	The cover image of the podcast.	Required

PUT

/api/podcasts/{podcast}

Update an existing podcast.

Parameters

Name	Type	Description	Constraints
podcast	integer	The unique identifier for the podcast.	Required
title	string	The title of the podcast.	Max Length: 255 Min Length: 1
description	string	A brief description of the podcast.
genres	array	The genre IDs of the podcast.
artist_id	integer	The artist ID of the podcast.
cover	file|url	The cover image of the podcast.

GET

/api/podcasts/{podcast}

Get a specific podcast by its ID.

Parameters

Name	Type	Description	Constraints
podcast	integer	The unique identifier for the podcast.	Required

Example Response [+]

DELETE

/api/podcasts/{podcast}

Delete a specific podcast.

Parameters

Name	Type	Description	Constraints
podcast	integer	The unique identifier for the podcast.	Required

GET

/api/artist/podcasts

Get current artist's podcasts.

Example Response [+]

GET

/api/podcast-genre-podcasts/{podcastGenre}

Get podcasts by podcast genre.

Parameters

Name	Type	Description	Constraints
podcastGenre	integer	The unique identifier for the podcast genre.	Required

GET

/api/podcast-genre/{podcastGenre}

Show a specific podcast genre.

Parameters

Name	Type	Description	Constraints
podcastGenre	integer	The unique identifier for the podcast genre.	Required

Example Response [+]

GET

/api/podcast-genres

List all podcast genres.

Example Response [+]

GET

/api/match-podcasts

Match podcasts based on criteria.

Parameters

Name	Type	Description	Constraints
query	string	The search query to match podcasts against.

Example Response [+]

Episode Routes

POST

/api/episodes

Store a new episode.

Parameters

Name	Type	Description	Constraints
title	string	The title of the episode.	Required Max Length: 255 Min Length: 1
description	string	A brief description of the episode.
podcast_id	integer	The ID of the podcast the episode belongs to.	Required
duration	string	The duration of the episode.
source_format	string	The format of the episode source.	Required Format: in:file
uploaded_by	string	The uploader role, either admin or user.	Required
source	file|url	The source of the song, this could be the URL of the song or the file.	Required

GET

/api/episodes/{episode}

Get a specific episode by its ID.

Parameters

Name	Type	Description	Constraints
episode	integer	The unique identifier for the episode.	Required

Example Response [+]

PUT

/api/episodes/{episode}

Update an existing episode.

Parameters

Name	Type	Description	Constraints
episode	integer	The unique identifier for the episode.	Required
title	string	The title of the episode.	Max Length: 255 Min Length: 1
description	string	A brief description of the episode.
podcast_id	integer	The ID of the podcast the episode belongs to.	Required
duration	string	The duration of the episode.
source_format	string	The format of the episode source.	Format: in:file
uploaded_by	string	The user who uploaded the episode.
source	string	The source of the episode.
file_size	integer	The size of the episode file.

DELETE

/api/episodes/{episode}

Delete a specific episode.

Parameters

Name	Type	Description	Constraints
episode	integer	The unique identifier for the episode.	Required

GET

/api/download-episode/{id}

Download a specific episode by its ID.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the episode.	Required

GET

/api/artist/episodes

Get the current artist's episodes.

Genres API

Admin endpoints

Admin Genre Routes

POST

/api/admin/genres

Store a new genre.

Parameters

Name	Type	Description	Constraints
name	string	Name of the genre.	Required Min Length: 1 Max Length: 15
slug	string	Slug of the genre.	Unique
cover	file|url	Cover image of the genre.
icon	file|url	Icon of the genre.

GET

/api/admin/genres

Get a list of all genres.

Example Response [+]

GET

/api/admin/genres/{genre}

Get details of a specific genre by ID.

Parameters

Name	Type	Description	Constraints
genre	integer	ID of the genre.	Required

Example Response [+]

PUT

/api/admin/genres/{genre}

Update an existing genre by ID.

Parameters

Name	Type	Description	Constraints
genre	integer	ID of the genre.	Required
name	string	Name of the genre.	Required Min Length: 1 Max Length: 15
slug	string	Slug of the genre.	Unique
cover	file|url	Cover image of the genre.
icon	file	Icon of the genre.

DELETE

/api/admin/genres/{genre}

Delete a specific genre by ID.

Parameters

Name	Type	Description	Constraints
genre	integer	ID of the genre.	Required

User endpoints

GET

/api/genre/{id}

Get details of a specific genre by ID.

Parameters

Name	Type	Description	Constraints
id	integer	ID of the genre.	Required

Example Response [+]

GET

/api/genres

Get a list of all genres.

Example Response [+]

GET

/api/genre-content/{genre_id}

Get all content for a specific genre by ID.

Parameters

Name	Type	Description	Constraints
genre_id	integer	ID of the genre.	Required

Example Response [+]

GET

/api/match-genres

Match genres based on a given keyword.

Parameters

Name	Type	Description	Constraints
query	string	Keyword to search for matching genres.	Required

Example Response [+]

Podcast Genre Routes

POST

/api/admin/podcast-genres

Store a new podcast genre.

Parameters

Name	Type	Description	Constraints
name	string	Name of the podcast genre.	Required Min Length: 1 Max Length: 15
slug	string	Slug of the podcast genre.	Required Unique
cover	file|url	Cover image of the podcast genre.

GET

/api/admin/podcast-genres

Get a list of all podcast genres.

Example Response [+]

GET

/api/admin/podcast-genres/{podcast_genre}

Get details of a specific podcast genre by ID.

Parameters

Name	Type	Description	Constraints
podcast_genre	integer	ID of the podcast genre.	Required

Example Response [+]

PUT

/api/admin/podcast-genres/{podcast_genre}

Update an existing podcast genre by ID.

Parameters

Name	Type	Description	Constraints
podcast_genre	integer	ID of the podcast genre.	Required
name	string	Name of the podcast genre.	Required Min Length: 1 Max Length: 15
slug	string	Slug of the podcast genre.	Required Unique
cover	file|url	Cover image of the podcast genre.

DELETE

/api/admin/podcast-genres/{podcast_genre}

Delete a specific podcast genre by ID.

Parameters

Name	Type	Description	Constraints
podcast_genre	integer	ID of the podcast genre.	Required

GET

/api/podcast-genre-podcasts/{podcastGenre}

Get all podcasts for a specific podcast genre by ID.

Parameters

Name	Type	Description	Constraints
podcastGenre	integer	ID of the podcast genre.	Required

Example Response [+]

GET

/api/podcast-genre/{podcastGenre}

Get details of a specific podcast genre by ID.

Parameters

Name	Type	Description	Constraints
podcastGenre	integer	ID of the podcast genre.	Required

Example Response [+]

GET

/api/podcast-genres

Get a list of all podcast genres.

Example Response [+]

Pages API

Admin endpoints

POST

/api/admin/pages

Store a new page.

Parameters

Name	Type	Description	Constraints
name	string	The name of the page.	Required Unique
title	string	The title of the page.	Required Unique
path	string	The path of the page.	Required Unique
content	string	The content of the page.
showLinkOnTheRightSidebar	boolean	Whether to show a link to this page on the right sidebar.
blank	boolean	Whether the page is blank.
description	string	The description of the page.
icon	string	The icon for the page. A material design icon, like: home

PUT

/api/admin/pages/{page}

Update an existing page.

Parameters

Name	Type	Description	Constraints
page	integer	The unique identifier for the page.	Required
name	string	The name of the page.	Unique
title	string	The title of the page.	Unique
path	string	The path of the page.	Unique
content	string	The content of the page.
showLinkOnTheRightSidebar	boolean	Whether to show a link to this page on the right sidebar.
blank	boolean	Whether the page is blank.
description	string	The description of the page.
icon	string	The icon for the page. A material design icon, like: home

GET

/api/admin/pages

Get a list of pages.

Example Response [+]

GET

/api/pages

Get a list of pages for the right sidebar.

Example Response [+]

GET

/api/admin/pages-infos

Get page information only.

Example Response [+]

GET

/api/admin/pages/{page}

Show a specific page by its ID.

Parameters

Name	Type	Description	Constraints
page	integer	The unique identifier for the page.	Required

Example Response [+]

GET

/api/page

Show a specific page by its path.

Parameters

Name	Type	Description	Constraints
path	string	The path of the page.	Required

Example Response [+]

DELETE

/api/admin/pages/{page}

Delete a specific page.

Parameters

Name	Type	Description	Constraints
page	integer	The unique identifier for the page.	Required

GET

/api/best-podcasts

Get the best podcasts.

Parameters

Name	Type	Description	Constraints
nb_items	integer	Number of items to retrieve.

Example Response [+]

GET

/api/charts

Get the charts page data.

Example Response [+]

GET

/api/latest-podcasts

Get the latest released podcasts.

Example Response [+]

GET

/api/most-liked-albums

Get the most liked albums.

Example Response [+]

GET

/api/most-liked-songs

Get the most liked songs.

Example Response [+]

GET

/api/new-albums

Get the new albums.

Example Response [+]

GET

/api/new-releases

Get the new releases.

Example Response [+]

GET

/api/new-songs

Get the new songs.

Example Response [+]

GET

/api/popular-albums

Get the most popular albums.

Example Response [+]

GET

/api/popular-podcasts

Get the most popular podcasts.

Example Response [+]

GET

/api/popular-songs

Get the most popular songs.

Example Response [+]

GET

/api/section/content/{id}

Get the content of a specified section by ID.

Parameters

Name	Type	Description	Constraints
id	integer	ID of the section.	Required

Example Response [+]

Artists API

Admin endpoints

POST

/api/admin/artists

Store a new artist.

Parameters

Name	Type	Description	Constraints
firstname	string	The first name of the artist.	Required Min Length: 3
lastname	string	The last name of the artist.	Required Min Length: 3
displayname	string	The display name of the artist.	Required Min Length: 3 Unique
country	string	The country of the artist.
email	string	The email of the artist.	Unique
phone	string	The phone number of the artist.
address	string	The address of the artist.
avatar	file|url	The avatar image of the artist.
spotify_link	string	The Spotify link of the artist.
youtube_link	string	The YouTube link of the artist.
soundcloud_link	string	The SoundCloud link of the artist.
itunes_link	string	The iTunes link of the artist.
deezer_link	string	The Deezer link of the artist.

GET

/api/admin/artists

Get a list of artists.

Example Response [+]

GET

/api/admin/artists/{artist}

Show a specific artist by their ID.

Parameters

Name	Type	Description	Constraints
artist	integer	The unique identifier for the artist.	Required

Example Response [+]

PUT

/api/admin/artists/{artist}

Update an existing artist.

Parameters

Name	Type	Description	Constraints
artist	integer	The unique identifier for the artist.	Required
firstname	string	The first name of the artist.	Min Length: 3
lastname	string	The last name of the artist.	Min Length: 3
displayname	string	The display name of the artist.	Min Length: 3 Unique
country	string	The country of the artist.
email	string	The email of the artist.	Unique
phone	string	The phone number of the artist.
address	string	The address of the artist.
avatar	file|url	The avatar image of the artist.
spotify_link	string	The Spotify link of the artist.
youtube_link	string	The YouTube link of the artist.
soundcloud_link	string	The SoundCloud link of the artist.
itunes_link	string	The iTunes link of the artist.
deezer_link	string	The Deezer link of the artist.

DELETE

/api/admin/artists/{artist}

Delete a specific artist.

Parameters

Name	Type	Description	Constraints
artist	integer	The unique identifier for the artist.	Required

GET

/api/artist

Get logged in artist account information.

GET

/api/artist/albums

Get logged in artist albums.

GET

/api/artist/analytics

Get logged in artist analytics.

POST

/api/artist/contact

Contact administration as an artist.

Parameters

Name	Type	Description	Constraints
message	string	The message to send to the admins.	Required

GET

/api/more-from-artist/{id}

Get more songs from an artist.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the artist.	Required
origin	string	The origin source of the artist.	Required

Example Response [+]

GET

/api/artist/match-songs/{keyword}

Match artist songs by keyword.

Parameters

Name	Type	Description	Constraints
keyword	string	The keyword to match songs.	Required

GET

/api/artist/notifications

Get logged in artist notifications.

GET

/api/artist/plays/{duration}

Get logged in artist plays by duration.

Parameters

Name	Type	Description	Constraints
duration	string	The duration for fetching plays.	Required

GET

/api/artist/podcasts

Get logged in artist podcasts.

POST

/api/artist/request-payout

Request artist payout.

Parameters

Name	Type	Description	Constraints
amount	number	The amount to request for payout.	Required Min: 1

POST

/api/artist/save-personal-infos

Save logged in artist personal information.

Parameters

Name	Type	Description	Constraints
firstname	string	The first name of the artist.	Required Min Length: 3
lastname	string	The last name of the artist.	Required Min Length: 3
displayname	string	The display name of the artist.	Required Min Length: 3 Unique
country	string	The country of the artist.
email	string	The email of the artist.	Unique
phone	string	The phone number of the artist.
address	string	The address of the artist.
avatar	file|url	The avatar image of the artist.
spotify_link	string	The Spotify link of the artist.
youtube_link	string	The YouTube link of the artist.
soundcloud_link	string	The SoundCloud link of the artist.
itunes_link	string	The iTunes link of the artist.
deezer_link	string	The Deezer link of the artist.

GET

/api/artist/songs

Get logged in artist songs.

GET

/api/artist/{id}

Show artist details.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the artist.	Required

Example Response [+]

GET

/api/artist/{id}/songs

Get artist songs.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the artist.	Required

Example Response [+]

Translations API

GET

/api/admin/languages

Get a list of all languages.

Example Response [+]

POST

/api/admin/languages

Store a new language.

Parameters

Name	Type	Description	Constraints
name	string	The name of the language.	Required Unique
locale	string	The locale ID of the language.	Required Unique
status	boolean	The status of the language (active or inactive).	Required
similar	string	The locale code of a similar language to copy translations from.
isDefault	boolean	Whether this language should be set as the default language.

DELETE

/api/admin/languages/{id}

Delete a specific language.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the language.	Required

PUT

/api/admin/languages/{id}/update

Update an existing language.

Parameters

Name	Type	Description	Constraints
id	integer	The unique identifier for the language.	Required
name	string	The name of the language.	Required
status	boolean	The status of the language (active or inactive).	Required
isDefault	boolean	Whether this language should be set as the default language.

POST

/api/admin/save-messages/{locale}

Save translations for a specific language.

Parameters

Name	Type	Description	Constraints
locale	string	The locale code of the language.	Required
messages	array	An array of translation messages to save.	Required

GET

/api/admin/{locale}/messages

Get translations for a specific language.

Parameters

Name	Type	Description	Constraints
locale	string	The locale code of the language.	Required

Example Response [+]

Settings API

Admin endpoints

POST

/api/admin/reset-settings

Reset all settings to their default values.

POST

/api/admin/save-ad-settings

Save ad settings.

Parameters

Name	Type	Description	Constraints
rect_ad	string	The code for rectangular ads.
square_ad	string	The code for square ads.
enableAds	boolean	Enable or disable ads.	Required

POST

/api/admin/save-analytics-settings

Save analytics settings.

Parameters

Name	Type	Description	Constraints
ga4	boolean	Enable or disable GA4 analytics.	Required
ga4MID	string	GA4 Measurement ID.
analytics_play_event	boolean	Track play events.
analytics_download_event	boolean	Track download events.
analytics_like_event	boolean	Track like events.
analytics_adClick_event	boolean	Track ad click events.
analytics_fileUpload_event	boolean	Track file upload events.
analytics_chat_event	boolean	Track chat events.
analytics_login_event	boolean	Track login events.
analytics_purchase_event	boolean	Track purchase events.
analytics_subscription_event	boolean	Track subscription events.

POST

/api/admin/save-billing-settings

Save billing settings.

Parameters

Name	Type	Description	Constraints
enable_billing	boolean	Enable or disable billing.	Required
default_currency	string	Default currency for billing.
stripe_gateway	boolean	Enable or disable Stripe gateway.
stripe_client_id	string	Stripe client ID.
stripe_secret	string	Stripe secret key.
paypal_gateway	boolean	Enable or disable PayPal gateway.
paypal_client_id	string	PayPal client ID.
paypal_secret	string	PayPal secret key.
paypal_sandbox_mode	boolean	Enable or disable PayPal sandbox mode.

POST

/api/admin/save-feed-settings

Save podcast feed settings.

Parameters

Name	Type	Description	Constraints
feedsLang	string	Language for the podcast feeds.	Required
feedsFormat	string	Format for the podcast feeds.	Required
podcastFeedsUrl	string	URL for the podcast feeds.	Required
podcastFeedsCount	integer	Number of podcasts in the feed.	Required
podcastFeedsDescription	string	Description of the podcast feed.	Required
podcastFeedsTitle	string	Title of the podcast feed.	Required
podcastFeedsImage	string	Image for the podcast feed.
podcastFeeds	boolean	Enable or disable podcast feeds.

POST

/api/admin/save-appearance-settings

Save appearance settings.

Parameters

Name	Type	Description	Constraints
logo	file|string	The application logo, either as a file upload or a relative path.
favicon	file|string	The application favicon, either as a file upload or a relative path.
playerLanding	string	The path of the landing/home page of your app.	Required
hideRightSidebar	boolean	Hide or show the right sidebar.	Required
enableThemeSwitcher	boolean	Enable or disable the theme switcher.	Required
defaultThemeID	integer	The ID of the default theme.	Required

POST

/api/admin/save-mail-settings

Save mail settings.

Parameters

Name	Type	Description	Constraints
enable_mail	boolean	Enable or disable mail settings.	Required
mailMailer	string	Mail mailer type (smtp or mailgun).
host	string	Mail host for SMTP mailer.
port	integer	Mail port for SMTP mailer.
username	string	Mail username for SMTP mailer.
password	string	Mail password for SMTP mailer.
encryption	string	Mail encryption method for SMTP mailer.
mailgunAPIKey	string	Mailgun API key for Mailgun mailer.
mailgunURL	string	Mailgun URL for Mailgun mailer.
from_address	string	The from address for mails.	Required
from_name	string	The from name for mails.	Required

POST

/api/admin/save-player-settings

Save player settings.

Parameters

Name	Type	Description	Constraints
disableVideo	boolean	Disable video playback.	Required
hideDownloadButton	boolean	Hide the download button.	Required
playerVolume	integer	Default player volume (0-100).	Required Min: 0 Max: 100
autoPlay	boolean	Enable or disable auto play.
crossfade	integer	Duration of crossfade in milliseconds.	Min: 0
shuffleOrder	boolean	Enable or disable shuffle order.
enable_ffmpeg	boolean	Enable or disable FFMPEG.
ffmpeg_path	string	Path to FFMPEG.
ffprobe_path	string	Path to FFProbe.
enable_youtubedl	boolean	Enable or disable YouTube-DL.
youtubedl_path	string	Path to YouTube-DL.
enable_wave_form	boolean	Enable or disable waveforms.
enable_hls	boolean	Enable or disable HLS.
hls_chunk_duration	integer	Duration of HLS chunks in seconds.	Min: 1
enable_hls_encryption	boolean	Enable or disable HLS encryption.

POST

/api/admin/save-provider-settings

Save provider settings.

Parameters

Name	Type	Description	Constraints
provider_spotify	boolean	Enable or disable Spotify provider.
spotifyClientID	string	Spotify client ID.
spotifyClientSecret	string	Spotify client secret.
spotify_search	boolean	Enable or disable Spotify search.
show_external_link_spotify	boolean	Show or hide external link to Spotify.

POST

/api/admin/save-search-settings

Save search settings.

Parameters

Name	Type	Description	Constraints
searchMethod	string	The method to use for search (e.g., tntsearch, algolia, mysql).	Required Possible values: tntsearch, algolia, mysql
algoliaAppID	string	Algolia App ID.
algoliaSecret	string	Algolia Secret Key.

POST

/api/admin/save-storage-settings

Save storage settings.

Parameters

Name	Type	Description	Constraints
storageDisk	string	Storage disk to use (e.g., s3, ftp, b2, wasabi, digital_ocean).	Required
S3Key	string	S3 key for storage.
S3Secret	string	S3 secret for storage.
S3Region	string	S3 region for storage.
S3Bucket	string	S3 bucket for storage.
S3Endpoint	string	S3 endpoint for storage.
WasabiKey	string	Wasabi key for storage.
WasabiSecret	string	Wasabi secret for storage.
WasabiRegion	string	Wasabi region for storage.
WasabiBucket	string	Wasabi bucket for storage.
FTP_HOST	string	FTP host for storage.
FTP_USERNAME	string	FTP username for storage.
FTP_PASSWORD	string	FTP password for storage.
FTP_PORT	integer	FTP port for storage.
FTP_ROOT	string	FTP root for storage.
FTP_PASSIVE	boolean	Enable or disable FTP passive mode.
FTP_SSL	boolean	Enable or disable FTP SSL.
FTP_TIMEOUT	integer	FTP timeout in seconds.
blackblazeKeyID	string	Blackblaze key ID for storage.
blackblazeApplicationKey	string	Blackblaze application key for storage.
blackblazeBucketID	string	Blackblaze bucket ID for storage.
blackblazeBucketName	string	Blackblaze bucket name for storage.
blackblazeEndpoint	string	Blackblaze endpoint for storage.
digitalOceanKey	string	DigitalOcean key for storage.
digitalOceanSecret	string	DigitalOcean secret for storage.
digitalOceanRegion	string	DigitalOcean region for storage.
digitalOceanBucket	string	DigitalOcean bucket for storage.
maxImageSize	integer	Maximum image size for uploads.	Required
optimize_images	boolean	Enable or disable image optimization.	Required
image_dimensions	integer	Dimensions for image optimization.	Required
thumb_dimensions	integer	Thumbnail dimensions for image optimization.	Required
maxFileSize	integer	Maximum file size for uploads.	Required
availableUserDiskSpace	integer	Available disk space for users.	Required
availableArtistDiskSpace	integer	Available disk space for artists.	Required

POST

/api/admin/save-seo-settings

Save SEO settings.

Parameters

Name	Type	Description	Constraints
siteTitle	string	The site title for SEO purposes.	Required Max: 255
siteDescription	string	The site description for SEO purposes.	Required Max: 255
homePageTitle	string	The title for the home page.	Required Max: 255
homePageDescription	string	The description for the home page.	Required Max: 255
browsePageTitle	string	The title for the browse page.	Required Max: 255
browsePageDescription	string	The description for the browse page.	Required Max: 255
podcastsPageTitle	string	The title for the podcasts page.	Required Max: 255
podcastsPageDescription	string	The description for the podcasts page.	Required Max: 255
artistPageTitle	string	The title for the artist page.	Required Max: 255
artistPageDescription	string	The description for the artist page.	Required Max: 255
songPageTitle	string	The title for the song page.	Required Max: 255
songPageDescription	string	The description for the song page.	Required Max: 255
albumPageTitle	string	The title for the album page.	Required Max: 255
albumPageDescription	string	The description for the album page.	Required Max: 255
podcastPageTitle	string	The title for the podcast page.	Required Max: 255
podcastPageDescription	string	The description for the podcast page.	Required Max: 255
playlistPageTitle	string	The title for the playlist page.	Required Max: 255
playlistPageDescription	string	The description for the playlist page.	Required Max: 255
genrePageTitle	string	The title for the genre page.	Required Max: 255
genrePageDescription	string	The description for the genre page.	Required Max: 255
podcastGenrePageTitle	string	The title for the podcast genre page.	Required Max: 255
podcastGenrePageDescription	string	The description for the podcast genre page.	Required Max: 255
userProfilePageTitle	string	The title for the user profile page.	Required Max: 255
userProfilePageDescription	string	The description for the user profile page.	Required Max: 255

POST

/api/admin/save-general-settings

Save general settings.

Parameters

Name	Type	Description	Constraints
locale	string	The locale of the application.	Required
enableLangSwitcher	boolean	Enable or disable the language switcher.	Required
appName	string	The name of the application.	Required Max: 255
appUrl	string	The URL of the application.	Required
enablePodcasts	boolean	Enable or disable podcasts.	Required
enableBrowse	boolean	Enable or disable the browse feature.	Required
enableUserUpload	boolean	Enable or disable user uploads.	Required
youtubePlugin	boolean	Enable or disable the YouTube plugin.	Required
enableEmbedPlayer	boolean	Enable or disable the embed player.	Required
allowGuestsToContact	boolean	Allow or disallow guests to contact.	Required
enableFriendshipSystem	boolean	Enable or disable the friendship system.	Required
disableCookieConsentPopup	boolean	Enable or disable the cookies consent popup that shows on the website.	Required
enableRealtime	boolean	Enable or disable realtime functionality.	Required
pusherAppId	string	Pusher App ID. Required if realtime is enabled.
pusherKey	string	Pusher key. Required if realtime is enabled.
pusherSecret	string	Pusher secret. Required if realtime is enabled.
pusherCluster	string	Pusher cluster. Required if realtime is enabled.
enableChat	boolean	Enable or disable chat functionality.	Required
enable_artist_account	boolean	Enable or disable artist accounts.	Required
allowArtistAccountRequests	boolean	Allow or disallow artist account requests.	Required
enable_royalties	boolean	Enable or disable royalties.	Required
artist_royalty	integer	The percentage of artist royalties.	Required Min: 0 Max: 100
artist_sale_cut	integer	The percentage of artist sale cut.	Required Min: 0 Max: 100
enable_share_facebook	boolean	Enable or disable sharing on Facebook.	Required
enable_share_twitter	boolean	Enable or disable sharing on Twitter.	Required
enable_share_whatsapp	boolean	Enable or disable sharing on WhatsApp.	Required
enable_share_telegram	boolean	Enable or disable sharing on Telegram.	Required
account_agreement	string	The account agreement text.
facebook_link	string	The link to the Facebook page.
youtube_link	string	The link to the YouTube channel.
twitter_link	string	The link to the Twitter profile.
soundcloud_link	string	The link to the SoundCloud profile.
spotify_link	string	The link to the Spotify profile.

POST

/api/admin/save-auth-settings

Save authentication settings.

Parameters

Name	Type	Description	Constraints
disableRegistration	boolean	Disable user registration.	Required
requireAuth	boolean	Require authentication for accessing the application.	Required
requireEmailConfirmation	boolean	Require email confirmation for user registration.	Required
enableGoogleLogin	boolean	Enable Google login.
googleOAuthClientID	string	Google OAuth client ID. Required if Google login is enabled.
enableFacebookLogin	boolean	Enable Facebook login.	Required
facebookOAuthClientID	string	Facebook OAuth client ID. Required if Facebook login is enabled.

POST

/api/admin/upload-section-background

Upload a section background image.

Parameters

Name	Type	Description	Constraints
background	file	The background image file.	Required
title	string	Title of the section.	Required
description	string	Description of the section.	Required

GET

/api/admin/settings

Get all settings.

Example Response [+]

Themes API

Admin endpoints

Theme Routes

POST

/api/admin/themes

Store a new theme.

Parameters

Name	Type	Description	Constraints
name	string	The name of the theme.	Required
title	string	The title of the theme.	Required
colors	string	The color configuration of the theme.	Required
enable_light_dark_switcher	boolean	Enable or disable the light/dark mode switcher.	Required

GET

/api/admin/themes

Get a list of themes.

Example Response [+]

PUT

/api/admin/themes/{theme}

Update an existing theme.

Parameters

Name	Type	Description	Constraints
theme	integer	The unique identifier for the theme.	Required
name	string	The name of the theme.	Required
title	string	The title of the theme.	Required
colors	string	The color configuration of the theme.	Required
enable_light_dark_switcher	boolean	Enable or disable the light/dark mode switcher.	Required

DELETE

/api/admin/themes/{theme}

Delete a specific theme.

Parameters

Name	Type	Description	Constraints
theme	integer	The unique identifier for the theme.	Required

GET

/api/admin/reset-theme-colors/{theme}

Reset theme colors to default.

Parameters

Name	Type	Description	Constraints
theme	integer	The unique identifier for the theme.	Required

POST

/api/admin/themes/{theme}/reset-landing-page-settings

Reset landing page settings for a theme.

Parameters

Name	Type	Description	Constraints
theme	integer	The unique identifier for the theme.	Required

POST

/api/admin/themes/{theme}/save-landing-page-settings

Save landing page settings for a theme.

Parameters

Name	Type	Description	Constraints
theme	integer	The unique identifier for the theme.	Required
headerBackground	file	The header background image for the landing page.
footerBackground	file	The footer background image for the landing page.
enableLandingPage	boolean	Enable or disable the landing page.	Required

GET

/api/theme

Get the current theme.

Example Response [+]

GET

/api/theme/{themeName}

Get a theme by its name.

Parameters

Name	Type	Description	Constraints
themeName	string	The name of the theme.	Required

Example Response [+]

Chat API

User endpoints

POST

/api/send/{session}

Send a message to a specific session.

Parameters

Name	Type	Description	Constraints
session	integer	The ID of the chat session.	Required
content	string	The content of the message.	Required
to_user	integer	The ID of the recipient user.	Required

POST

/api/sessions/create

Create a new chat session.

Parameters

Name	Type	Description	Constraints
user_id	integer	The ID of the user to create a session with.	Required

POST

/api/sessions/{session}/block

Block a user in a specific session.

Parameters

Name	Type	Description	Constraints
session	integer	The ID of the chat session.	Required
user_id	integer	The ID of the user to block.	Required

POST

/api/sessions/{session}/chats

Get chats in a specific session.

Parameters

Name	Type	Description	Constraints
session	integer	The ID of the chat session.	Required

Example Response [+]

POST

/api/sessions/{session}/clear

Clear chat in a specific session.

Parameters

Name	Type	Description	Constraints
session	integer	The ID of the chat session.	Required

POST

/api/sessions/{session}/read

Mark messages as read in a specific session.

Parameters

Name	Type	Description	Constraints
session	integer	The ID of the chat session.	Required

POST

/api/sessions/{session}/unblock

Unblock a user in a specific session.

Parameters

Name	Type	Description	Constraints
session	integer	The ID of the chat session.	Required
user_id	integer	The ID of the user to unblock.	Required

Subscriptions API

Admin endpoints

POST

/api/admin/subscriptions

Store a new subscription.

Parameters

Name	Type	Description	Constraints
user_id	integer	ID of the user.	Required
plan_id	integer	ID of the plan.	Required
gateway	string	Payment gateway used.	Required

GET

/api/admin/subscriptions

Get a list of all subscriptions.

Example Response [+]

DELETE

/api/admin/subscriptions/{subscription}

Delete a specific subscription by ID.

Parameters

Name	Type	Description	Constraints
subscription	integer	ID of the subscription.	Required

Plan Routes

POST

/api/admin/plans

Store a new plan.

Parameters

Name	Type	Description	Constraints
name	string	Name of the plan.	Required
currency	string	Currency of the plan.	Required
amount	float	Amount of the plan.	Required
interval	string	Interval of the plan (e.g., monthly, yearly).	Required
storage_space	integer	Storage space provided by the plan.
active	boolean	Whether the plan is active or not.	Required
recommended	boolean	Whether the plan is recommended or not.
upgradable	boolean	Whether the plan is upgradable or not.
position	integer	Position of the plan in the list.
badge	string	Badge for the plan.
displayed_features	array	Features displayed for the plan.
roles	array	Roles associated with the plan.	Required
permissions	array	Permissions associated with the plan.	Required

GET

/api/admin/plans

Get a list of all plans.

Example Response [+]

PUT

/api/admin/plans/{plan}

Update an existing plan by ID.

Parameters

Name	Type	Description	Constraints
plan	integer	ID of the plan.	Required
name	string	Name of the plan.	Required
currency	string	Currency of the plan.
amount	float	Amount of the plan.
interval	string	Interval of the plan (e.g., monthly, yearly).
storage_space	integer	Storage space provided by the plan.
active	boolean	Whether the plan is active or not.	Required
recommended	boolean	Whether the plan is recommended or not.
upgradable	boolean	Whether the plan is upgradable or not.
position	integer	Position of the plan in the list.
badge	string	Badge for the plan.
displayed_features	array	Features displayed for the plan.
roles	array	Roles associated with the plan.	Required
permissions	array	Permissions associated with the plan.	Required

DELETE

/api/admin/plans/{plan}

Delete a specific plan by ID.

Parameters

Name	Type	Description	Constraints
plan	integer	ID of the plan.	Required

GET

/api/plans

Get a list of all active plans for users.

Example Response [+]

DELETE

/api/admin/payout-methods/{payout_method}

Delete a specific payout method.

Parameters

Name	Type	Description	Constraints
payout_method	integer	ID of the payout method.	Required

Example Response [+]

GET

/api/admin/payouts

Get a list of all payouts.

Example Response [+]

POST

/api/admin/payouts/{payout}

Updates the status of the payout.

Parameters

Name	Type	Description	Constraints
payout	integer	The unique identifier for the payout.	Required
status	string	The status of the payout.	Required Possible values: pending, payed, requested, rejected
details	string	Additional details about the payout.

Example Response [+]

Payouts API

Admin endpoints

Admin Payout Routes

DELETE

/api/admin/payout-methods/{payout_method}

Delete a specific payout method.

Parameters

Name	Type	Description	Constraints
payout_method	integer	ID of the payout method.	Required

Example Response [+]

GET

/api/payout-options

Get available payout options.

Example Response [+]

POST

/api/admin/payouts

Store a new payout.

Parameters

Name	Type	Description	Constraints
user_id	integer	ID of the user.	Required
amount	decimal	Amount of the payout.	Required
status	string	Status of the payout.	Required
details	string	Details of the payout.

Example Response [+]

GET

/api/admin/payouts

Get a list of all payouts.

Example Response [+]

GET

/api/admin/payouts/{payout}

Show a specific payout.

Parameters

Name	Type	Description	Constraints
payout	integer	ID of the payout.	Required

Example Response [+]

PUT

/api/admin/payouts/{payout}

Update an existing payout.

Parameters

Name	Type	Description	Constraints
payout	integer	ID of the payout.	Required
user_id	integer	ID of the user.	Required
amount	decimal	Amount of the payout.	Required
status	string	Status of the payout.	Required
details	string	Details of the payout.

Example Response [+]

DELETE

/api/admin/payouts/{payout}

Delete a specific payout.

Parameters

Name	Type	Description	Constraints
payout	integer	ID of the payout.	Required

Example Response [+]

Analytics API

Admin endpoints

Admin Analytics Routes

GET

/api/admin/analytics

Get the overall analytics data for the admin dashboard.

Example Response [+]

GET

/api/admin/plays/{duration}

Get the plays analytics data for a specified duration.

Parameters

Name	Type	Description	Constraints
duration	string	Duration for the analytics data. Possible values: lw (last week), lm (last month), ly (last year).	Required

Example Response [+]

GET

/api/admin/sales/{duration}

Get the sales analytics data for a specified duration.

Parameters

Name	Type	Description	Constraints
duration	string	Duration for the analytics data. Possible values: lw (last week), lm (last month), ly (last year).	Required

Example Response [+]

Artist Analytics

GET

/api/artist/analytics

Get the analytics data for the artist dashboard.

GET

/api/artist/plays/{duration}

Get the artist plays analytics data for a specified duration.

Parameters

Name	Type	Description	Constraints
duration	string	Duration for the analytics data. Possible values: lw (last week), lm (last month), ly (last year).	Required

Search API

GET

/api/search/{keyword}

Search for various content types using a keyword.

Parameters

Name	Type	Description	Constraints
keyword	string	The keyword to search for.	Required
engines	array	Optional parameter to specify search engines. Possible values: local, spotify, *	Possible values: local, spotify, *

Example Response [+]

GET

/api/search/{keyword}/{type}

Search for a specific content type using a keyword.

Parameters

Name	Type	Description	Constraints
keyword	string	The keyword to search for.	Required
type	string	The type of content to search for. Possible values: songs, artists, albums, podcasts, playlists, radio-stations, profiles.	Required
engines	array	Optional parameter to specify search engines. Possible values: local, spotify, *	Possible values: local, spotify, *

Example Response [+]