/
KO
koel
/
Koel API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 35m ago · Updated 1mo ago
latest
OpenAPI 3.0.0
MIT
2026-07-17
40
12
50.4 KB
b8837d22df45
authentication
4
get
Get profile
put
Update profile
post
Log in
delete
Log out
data
1
get
Get application data
download
4
get
Download songs
get
Download album
get
Download artist
get
Download playlist
interaction
5
post
Increase play count
post
Toggle like/unlike a song
post
Like multiple songs
post
Unlike multiple songs
get
Get recently played songs
last.fm
3
post
Scrobble a song
post
Set Last.fm session key
get
Connect to Last.fm
media information
7
put
Update song(s) information
get
Get album's extra information
get
Get artist's extra information
get
Get song's extra information
put
Upload album's cover
put
Upload artist's image
get
Get album's thumbnail
playback
1
get
Play a song
playlist
3
get
Get current user's playlists
post
Create another playlist
patch
Update a playlist
S3 integration
1
post
Save a song from S3
search
2
get
Search for songs, albums, and artists
get
Search for songs
settings
1
put
Save the application settings
user
3
post
Create a user
delete
Delete a user
patch
Update a user
get
Get playlist's songs
delete
put
delete
Remove a song from S3
post
Upload a song
user
Create a user
Create a new user
post
/api/user
Request body
object
required
name
string
required
email
string
email
required
password
string
password
required
is_admin
boolean
required
Response
OK
User
required
A User model
id
integer
required
name
string
required
email
string
required
is_admin
boolean
required
preferences
object
required