Mirrors/koel
2
0
Fork 0
mirror of https://github.com/koel/koel synced 2024-11-28 06:50:27 +00:00
Code Issues Projects Releases Packages Wiki Activity
koel/api-docs/source/index.md
Thien Nguyen db9d00bc3b Fix Postman Collection link (#893)
2019-01-10 14:58:21 +01:00

48 KiB
Raw Blame History

title language_tabs includes search
API Reference
javascript
bash
true

Info

Welcome to the generated API reference. Get Postman Collection

This is the official API documentation for Koel, generated from the source code using Laravel API Documentation Generator. If you spot any mistake or want to add an improvement, please submit an issue or open a pull request.

#1. Authentication

Log a user in

Koel uses JSON Web Tokens (JWT) for authentication. After the user has been authenticated, a random "token" will be returned. This token should then be saved in a local storage and used as an Authorization: Bearer header for consecutive calls.

Notice: The token is valid for a week, after that the user will need to log in again.

Example request:

curl -X POST "http://koel.test/api/me"     -d "email"="john@doe.com" \
    -d "password"="SoSecureMuchW0w" 

const url = new URL("http://koel.test/api/me");

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "email": "john@doe.com",
    "password": "SoSecureMuchW0w",
})

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "token": "<a-random-string>"
}

HTTP Request

POST api/me

Body Parameters

Parameter Type Status Description
email string required The user's email.
password string required The password.

Log the current user out

Example request:

curl -X DELETE "http://koel.test/api/me" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/me");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

DELETE api/me

#2. Application data

Get application data

The big fat call to retrieve a set of application data catered for the current user (songs, albums, artists, playlists, interactions, and if the user is an admin, settings as well). Naturally, this call should be made right after the user has been logged in, when you need to populate the application's interface with useful information.

Example request:

curl -X GET -G "http://koel.test/api/data" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/data");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "albums": [
        {
            "id": 42,
            "artist_id": 42,
            "name": "...And Justice For All"
        },
        {
            "...": "..."
        }
    ],
    "allowDownload": true,
    "artists": [
        {
            "id": 42,
            "name": "Metallica"
        },
        {
            "...": "..."
        }
    ],
    "cdnUrl": "https:\/\/yourcdn.koel.example\/",
    "currentUser": {
        "id": 1,
        "name": "John Doe",
        "email": "john@doe.net",
        "is_admin": true,
        "preferences": {
            "lastfm_session_key": "hidden"
        }
    },
    "currentVersion": "v3.7.2",
    "interactions": [
        {
            "song_id": "f88c7671623c6b8be881e2a04e685509",
            "liked": false,
            "play_count": 5
        },
        {
            "...": "..."
        }
    ],
    "latestVersion": "v3.7.2",
    "playlists": [
        {
            "id": 1,
            "name": "Ballads",
            "rules": null,
            "is_smart": false
        },
        {
            "...": "..."
        }
    ],
    "recentlyPlayed": [
        "f78de3724e2823e7e4cfb660c4f691e9",
        "aebb93a69d6c8af79a1004aceabb201c",
        "..."
    ],
    "settings": {
        "media_path": "\/var\/www\/media"
    },
    "songs": [
        {
            "id": "00037ec0715a8781104ffd8efe0db06a",
            "album_id": 42,
            "artist_id": 42,
            "title": "Carpe Diem Baby",
            "created_at": "2015-12-10 05:52:22",
            "disc": 1,
            "track": 7,
            "length": 372.27
        },
        {
            "...": "..."
        }
    ],
    "supportsTranscoding": true,
    "useLastfm": true,
    "useYouTube": true,
    "useiTunes": true,
    "users": [
        {
            "id": 1,
            "name": "John Doe",
            "email": "john@doe.com",
            "is_admin": true
        },
        {
            "...": "..."
        }
    ]
}

HTTP Request

GET api/data

#3. Song interactions

Play a song

The GET request to play/stream a song. By default Koel will serve the file as-is, unless it's a FLAC. If the value of transcode is truthy, Koel will attempt to transcode the file into bitRatekbps using ffmpeg.

Example request:

curl -X GET -G "http://koel.test/api/{song}/play/{transcode?}/{bitrate?}" 

const url = new URL("http://koel.test/api/{song}/play/{transcode?}/{bitrate?}");

    let params = {
            "jwt-token": "IHcH5I1rWR40Sqg2",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[]

HTTP Request

GET api/{song}/play/{transcode?}/{bitrate?}

Query Parameters

Parameter Status Description
jwt-token required The JWT token.

Increase play count

Increase a song's play count as the currently authenticated user. This request should be made whenever a song is played. An "interaction" record including the song and current user's data will be returned.

Example request:

curl -X POST "http://koel.test/api/interaction/play" \
    -H "Authorization: Bearer {token}" \
    -d "song"="0146d01afb742b01f28ab8b556f9a75d" 

const url = new URL("http://koel.test/api/interaction/play");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "song": "0146d01afb742b01f28ab8b556f9a75d",
})

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "song_id": "0146d01afb742b01f28ab8b556f9a75d",
    "liked": true,
    "play_count": 228,
    "song": {
        "id": "0146d01afb742b01f28ab8b556f9a75d",
        "album_id": 1363,
        "artist_id": 430,
        "title": "The Show Must Go On",
        "length": 407.33,
        "track": 0,
        "disc": 1,
        "created_at": "2017-02-07 10:35:03",
        "artist": {
            "id": 430,
            "name": "Queen",
            "image": "https:\/\/koel.yourdomain.net\/img\/artists\/5a7727c2afbb09.08223866.png"
        },
        "album": {
            "id": 1363,
            "artist_id": 430,
            "name": "Innuendo",
            "cover": "https:\/\/koel.yourdomain.net\/img\/covers\/5899a2d7a19c90.72864263.jpg",
            "created_at": "2017-02-07 10:35:03",
            "is_compilation": false
        }
    },
    "user": {
        "id": 1,
        "name": "John Doe",
        "email": "john@doe.com",
        "is_admin": true,
        "preferences": {
            "lastfm_session_key": "hidden"
        }
    }
}

HTTP Request

POST api/interaction/play

Body Parameters

Parameter Type Status Description
song string required The ID of the song.

Like or unlike a song

An "interaction" record including the song and current user's data will be returned.

Example request:

curl -X POST "http://koel.test/api/interaction/like" \
    -H "Authorization: Bearer {token}" \
    -d "song"="0146d01afb742b01f28ab8b556f9a75d" 

const url = new URL("http://koel.test/api/interaction/like");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "song": "0146d01afb742b01f28ab8b556f9a75d",
})

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "song_id": "0146d01afb742b01f28ab8b556f9a75d",
    "liked": true,
    "play_count": 228,
    "song": {
        "id": "0146d01afb742b01f28ab8b556f9a75d",
        "album_id": 1363,
        "artist_id": 430,
        "title": "The Show Must Go On",
        "length": 407.33,
        "track": 0,
        "disc": 1,
        "created_at": "2017-02-07 10:35:03",
        "artist": {
            "id": 430,
            "name": "Queen",
            "image": "https:\/\/koel.yourdomain.net\/img\/artists\/5a7727c2afbb09.08223866.png"
        },
        "album": {
            "id": 1363,
            "artist_id": 430,
            "name": "Innuendo",
            "cover": "https:\/\/koel.yourdomain.net\/img\/covers\/5899a2d7a19c90.72864263.jpg",
            "created_at": "2017-02-07 10:35:03",
            "is_compilation": false
        }
    },
    "user": {
        "id": 1,
        "name": "John Doe",
        "email": "john@doe.com",
        "is_admin": true,
        "preferences": {
            "lastfm_session_key": "hidden"
        }
    }
}

HTTP Request

POST api/interaction/like

Body Parameters

Parameter Type Status Description
song string required The ID of the song.

Like multiple songs

Like several songs at once, useful for "batch" actions. An array of "interaction" records containing the song and user data will be returned.

Example request:

curl -X POST "http://koel.test/api/interaction/batch/like" \
    -H "Authorization: Bearer {token}" \
    -d "songs"="[]" 

const url = new URL("http://koel.test/api/interaction/batch/like");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "songs": "[]",
})

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[
    {
        "song_id": "0146d01afb742b01f28ab8b556f9a75d",
        "liked": true,
        "play_count": 228,
        "song": {
            "id": "0146d01afb742b01f28ab8b556f9a75d",
            "album_id": 1363,
            "artist_id": 430,
            "title": "The Show Must Go On",
            "length": 407.33,
            "track": 0,
            "disc": 1,
            "created_at": "2017-02-07 10:35:03",
            "artist": {
                "id": 430,
                "name": "Queen",
                "image": "https:\/\/koel.yourdomain.net\/img\/artists\/5a7727c2afbb09.08223866.png"
            },
            "album": {
                "id": 1363,
                "artist_id": 430,
                "name": "Innuendo",
                "cover": "https:\/\/koel.yourdomain.net\/img\/covers\/5899a2d7a19c90.72864263.jpg",
                "created_at": "2017-02-07 10:35:03",
                "is_compilation": false
            }
        },
        "user": {
            "id": 1,
            "name": "John Doe",
            "email": "john@doe.com",
            "is_admin": true,
            "preferences": {
                "lastfm_session_key": "hidden"
            }
        }
    },
    {
        "...": "..."
    }
]

HTTP Request

POST api/interaction/batch/like

Body Parameters

Parameter Type Status Description
songs array required An array of song IDs.

Unlike multiple songs

Unlike several songs at once, useful for "batch" actions. An array of "interaction" records containing the song and user data will be returned.

Example request:

curl -X POST "http://koel.test/api/interaction/batch/unlike" \
    -H "Authorization: Bearer {token}" \
    -d "songs"="[]" 

const url = new URL("http://koel.test/api/interaction/batch/unlike");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "songs": "[]",
})

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[
    {
        "song_id": "0146d01afb742b01f28ab8b556f9a75d",
        "liked": true,
        "play_count": 228,
        "song": {
            "id": "0146d01afb742b01f28ab8b556f9a75d",
            "album_id": 1363,
            "artist_id": 430,
            "title": "The Show Must Go On",
            "length": 407.33,
            "track": 0,
            "disc": 1,
            "created_at": "2017-02-07 10:35:03",
            "artist": {
                "id": 430,
                "name": "Queen",
                "image": "https:\/\/koel.yourdomain.net\/img\/artists\/5a7727c2afbb09.08223866.png"
            },
            "album": {
                "id": 1363,
                "artist_id": 430,
                "name": "Innuendo",
                "cover": "https:\/\/koel.yourdomain.net\/img\/covers\/5899a2d7a19c90.72864263.jpg",
                "created_at": "2017-02-07 10:35:03",
                "is_compilation": false
            }
        },
        "user": {
            "id": 1,
            "name": "John Doe",
            "email": "john@doe.com",
            "is_admin": true,
            "preferences": {
                "lastfm_session_key": "hidden"
            }
        }
    },
    {
        "...": "..."
    }
]

HTTP Request

POST api/interaction/batch/unlike

Body Parameters

Parameter Type Status Description
songs array required An array of song IDs.

Get recently played songs

Get a list of songs recently played by the current user.

Example request:

curl -X GET -G "http://koel.test/api/interaction/recently-played/{count?}" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/interaction/recently-played/{count?}");

    let params = {
            "count": "2",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[
    "0146d01afb742b01f28ab8b556f9a75d",
    "c741133cb8d1982a5c60b1ce2a1e6e47"
]

HTTP Request

GET api/interaction/recently-played/{count?}

Query Parameters

Parameter Status Description
count optional The maximum number of songs to be returned.

#4. Playlist management

Get current user's playlists

Example request:

curl -X GET -G "http://koel.test/api/playlist" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/playlist");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[
    {
        "id": 13,
        "name": "Ballads",
        "rules": null,
        "is_smart": false
    },
    {
        "id": 17,
        "name": "Brand New Tracks",
        "rules": [
            {
                "id": 1543242741773,
                "rules": [
                    {
                        "id": 1543242742767,
                        "model": "interactions.play_count",
                        "operator": "is",
                        "value": [
                            "0"
                        ]
                    }
                ]
            }
        ],
        "is_smart": true
    },
    {
        "id": 12,
        "name": "Great Solos",
        "rules": null,
        "is_smart": false
    }
]

HTTP Request

GET api/playlist

Create a new playlist

Example request:

curl -X POST "http://koel.test/api/playlist" \
    -H "Authorization: Bearer {token}" \
    -d "name"="Sleepy Songs" \
    -d "rules"="[]" 

const url = new URL("http://koel.test/api/playlist");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "name": "Sleepy Songs",
    "rules": "[]",
})

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "id": 42,
    "name": "Sleepy Songs",
    "rules": [],
    "is_smart": false
}

HTTP Request

POST api/playlist

Body Parameters

Parameter Type Status Description
name string required Name of the playlist.
rules array optional An array of rules if creating a "smart playlist."

Rename a playlist

Example request:

curl -X PUT "http://koel.test/api/playlist/{playlist}" \
    -H "Authorization: Bearer {token}" \
    -d "name"="Catchy Songs" 

const url = new URL("http://koel.test/api/playlist/{playlist}");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "name": "Catchy Songs",
})

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "id": 42,
    "name": "Catchy Songs",
    "rules": [],
    "is_smart": false
}

HTTP Request

PUT api/playlist/{playlist}

PATCH api/playlist/{playlist}

Body Parameters

Parameter Type Status Description
name string required New name of the playlist.

Delete a playlist

Example request:

curl -X DELETE "http://koel.test/api/playlist/{playlist}" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/playlist/{playlist}");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[]

HTTP Request

DELETE api/playlist/{playlist}

Replace a playlist's content

Instead of adding or removing songs individually, a playlist's content is replaced entirely with an array of song IDs.

Example request:

curl -X PUT "http://koel.test/api/playlist/{playlist}/sync" \
    -H "Authorization: Bearer {token}" \
    -d "songs"="[]" 

const url = new URL("http://koel.test/api/playlist/{playlist}/sync");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "songs": "[]",
})

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[]

HTTP Request

PUT api/playlist/{playlist}/sync

Body Parameters

Parameter Type Status Description
songs array required An array of song IDs.

Get a playlist's songs

Example request:

curl -X GET -G "http://koel.test/api/playlist/{playlist}/songs" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/playlist/{playlist}/songs");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[
    "0146d01afb742b01f28ab8b556f9a75d",
    "c741133cb8d1982a5c60b1ce2a1e6e47",
    "..."
]

HTTP Request

GET api/playlist/{playlist}/songs

#5. Media information

Update song information

Example request:

curl -X PUT "http://koel.test/api/songs" \
    -H "Authorization: Bearer {token}" \
    -d "songs"="[]" \
    -d "data"="{}" 

const url = new URL("http://koel.test/api/songs");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "songs": "[]",
    "data": "{}",
})

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PUT api/songs

Body Parameters

Parameter Type Status Description
songs array required An array of song IDs to be updated.
data object required The new data, with these supported fields: title, artistName, albumName, and lyrics.

Get album's extra information

Get extra information about an album via Last.fm.

Example request:

curl -X GET -G "http://koel.test/api/album/{album}/info" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/album/{album}/info");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "url": "https:\/\/www.last.fm\/music\/Queen\/Innuendo",
    "image": "https:\/\/lastfm-img2.akamaized.net\/i\/u\/300x300\/b56adcd16ca6454498981a8470a3ec06.png",
    "wiki": {
        "summary": "Innuendo is a 1991 album by English rock band Queen...",
        "full": "Innuendo is a 1991 album by English rock band Queen. It is the band's fourteenth studio album..."
    },
    "tracks": [
        {
            "title": "Innuendo",
            "length": 392,
            "url": "https:\/\/www.last.fm\/music\/Queen\/_\/Innuendo"
        },
        {
            "title": "I'm Going Slightly Mad",
            "length": 247,
            "url": "https:\/\/www.last.fm\/music\/Queen\/_\/I%27m+Going+Slightly+Mad"
        },
        {
            "...": "..."
        }
    ],
    "cover": "https:\/\/koel.yourdomain.net\/img\/covers\/5a771ec82a5d72.25096250.png"
}

HTTP Request

GET api/album/{album}/info

Get artist's extra information

Get extra information about an artist via Last.fm.

Example request:

curl -X GET -G "http://koel.test/api/artist/{artist}/info" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/artist/{artist}/info");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "url": "https:\/\/www.last.fm\/music\/Queen",
    "image": "https:\/\/koel.yourdomain.net\/img\/artists\/5a772708e7de19.84120679.png",
    "bio": {
        "summary": "Queen were an English rock band originally consisting of four members...",
        "full": "Queen were an English rock band originally consisting of four members: vocalist Freddie Mercury, guitarist Brian May, bass guitarist John Deacon, and drummer Roger Taylor..."
    }
}

HTTP Request

GET api/artist/{artist}/info

Get song's extra information

Get a song's extra information. The response of this request is a superset of both corresponding album/{album}/info and artist/{artist}/info requests, combined with the song's lyrics and related YouTube videos, if applicable. This means you can (and should) cache this information somewhere ;)

Example request:

curl -X GET -G "http://koel.test/api/song/{song}/info" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/song/{song}/info");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "lyrics": "...",
    "album_info": {
        "url": "https:\/\/www.last.fm\/music\/Queen\/Innuendo",
        "image": "https:\/\/lastfm-img2.akamaized.net\/i\/u\/300x300\/b56adcd16ca6454498981a8470a3ec06.png",
        "wiki": {
            "summary": "Innuendo is a 1991 album by English rock band Queen...",
            "full": "Innuendo is a 1991 album by English rock band Queen. It is the band's fourteenth studio album and the last..."
        },
        "tracks": [
            {
                "title": "Innuendo",
                "length": 392,
                "url": "https:\/\/www.last.fm\/music\/Queen\/_\/Innuendo"
            },
            {
                "title": "I'm Going Slightly Mad",
                "length": 247,
                "url": "https:\/\/www.last.fm\/music\/Queen\/_\/I%27m+Going+Slightly+Mad"
            },
            {
                "...": "..."
            }
        ]
    },
    "artist_info": {
        "url": "https:\/\/www.last.fm\/music\/Queen",
        "image": "https:\/\/koel.yourdomain.net\/img\/artists\/5a772708e7de19.84120679.png",
        "bio": {
            "summary": "Queen were an English rock band...",
            "full": "<br \/>\nQueen were an English rock band originally consisting of four members: vocalist Freddie Mercury, guitarist Brian May, bass guitarist John Deacon, and drummer Roger Taylor..."
        }
    },
    "youtube": {
        "kind": "youtube#searchListResponse",
        "etag": "\"XI7nbFXulYBIpL0ayR_gDh3eu1k\/UMIztE1sQ8L9tu7igiTaSoBA9tw\"",
        "nextPageToken": "CAoQAA",
        "regionCode": "CH",
        "pageInfo": {
            "totalResults": 1000000,
            "resultsPerPage": 10
        },
        "items": [
            {
                "kind": "youtube#searchResult",
                "etag": "\"XI7nbFXulYBIpL0ayR_gDh3eu1k\/bRRI2oEvvXIbCBFKv8WrLUaG-0A\"",
                "id": {
                    "kind": "youtube#video",
                    "videoId": "t99KH0TR-J4"
                },
                "snippet": {
                    "publishedAt": "2013-10-15T14:24:31.000Z",
                    "channelId": "UCiMhD4jzUqG-IgPzUmmytRQ",
                    "title": "Queen - The Show Must Go On (Official Video)",
                    "description": "Subscribe to the Official Queen Channel Here http:\/\/bit.ly\/Subscribe2Queen Taken from Innuendo, 1991. Queen - The Show Must Go On (promo video, 1991) ...",
                    "thumbnails": {
                        "default": {
                            "url": "https:\/\/i.ytimg.com\/vi\/t99KH0TR-J4\/default.jpg",
                            "width": 120,
                            "height": 90
                        },
                        "medium": {
                            "url": "https:\/\/i.ytimg.com\/vi\/t99KH0TR-J4\/mqdefault.jpg",
                            "width": 320,
                            "height": 180
                        },
                        "high": {
                            "url": "https:\/\/i.ytimg.com\/vi\/t99KH0TR-J4\/hqdefault.jpg",
                            "width": 480,
                            "height": 360
                        }
                    },
                    "channelTitle": "Queen Official",
                    "liveBroadcastContent": "none"
                }
            },
            {
                "...": "..."
            }
        ]
    }
}

HTTP Request

GET api/song/{song}/info

#6. Download

Download one or several songs

Example request:

curl -X GET -G "http://koel.test/api/download/songs" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/download/songs");

    let params = {
            "songs": "xssITiRFm57vV9VF",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[]

HTTP Request

GET api/download/songs

Query Parameters

Parameter Status Description
songs optional array An array of song IDs

Download a whole album

Example request:

curl -X GET -G "http://koel.test/api/download/album/{album}" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/download/album/{album}");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[]

HTTP Request

GET api/download/album/{album}

Download all songs by an artist

Don't see why one would need this, really. Let's pray to God the user doesn't trigger this on Elvis.

Example request:

curl -X GET -G "http://koel.test/api/download/artist/{artist}" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/download/artist/{artist}");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[]

HTTP Request

GET api/download/artist/{artist}

Download a whole playlist

Example request:

curl -X GET -G "http://koel.test/api/download/playlist/{playlist}" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/download/playlist/{playlist}");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[]

HTTP Request

GET api/download/playlist/{playlist}

Download all songs favorite'd by the current user

Example request:

curl -X GET -G "http://koel.test/api/download/favorites" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/download/favorites");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[]

HTTP Request

GET api/download/favorites

#7. User management

Create a new user

Example request:

curl -X POST "http://koel.test/api/user" \
    -H "Authorization: Bearer {token}" \
    -d "name"="John Doe" \
    -d "email"="john@doe.com" \
    -d "password"="SoSecureMuchW0w" 

const url = new URL("http://koel.test/api/user");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "name": "John Doe",
    "email": "john@doe.com",
    "password": "SoSecureMuchW0w",
})

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "id": 42,
    "name": "John Doe",
    "email": "john@doe.com"
}

HTTP Request

POST api/user

Body Parameters

Parameter Type Status Description
name string required User's name.
email string required User's email.
password string required User's password.

Update a user

Example request:

curl -X PUT "http://koel.test/api/user/{user}" \
    -H "Authorization: Bearer {token}" \
    -d "name"="Johny Doe" \
    -d "email"="johny@doe.com" \
    -d "password"="wJgmKkTITwHmdgUG" 

const url = new URL("http://koel.test/api/user/{user}");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "name": "Johny Doe",
    "email": "johny@doe.com",
    "password": "wJgmKkTITwHmdgUG",
})

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[]

HTTP Request

PUT api/user/{user}

PATCH api/user/{user}

Body Parameters

Parameter Type Status Description
name string required New name.
email string required New email.
password string optional New password (null/blank for no change)

Delete a user

Example request:

curl -X DELETE "http://koel.test/api/user/{user}" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/user/{user}");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[]

HTTP Request

DELETE api/user/{user}

Get current user's profile

Example request:

curl -X GET -G "http://koel.test/api/me" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/me");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "id": 42,
    "name": "John Doe",
    "email": "john@doe.com"
}

HTTP Request

GET api/me

Update current user's profile

Example request:

curl -X PUT "http://koel.test/api/me" \
    -H "Authorization: Bearer {token}" \
    -d "name"="Johny Doe" \
    -d "email"="johny@doe.com" \
    -d "password"="Lm4qQDyLb3NNddWI" 

const url = new URL("http://koel.test/api/me");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "name": "Johny Doe",
    "email": "johny@doe.com",
    "password": "Lm4qQDyLb3NNddWI",
})

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[]

HTTP Request

PUT api/me

Body Parameters

Parameter Type Status Description
name string required New name.
email string required New email.
password string optional New password (null/blank for no change)

#8. Settings

Save the application settings

Save the application settings. Right now there's only one setting to be saved (media_path).

Example request:

curl -X POST "http://koel.test/api/settings" \
    -H "Authorization: Bearer {token}" \
    -d "media_path"="/var/www/media/" 

const url = new URL("http://koel.test/api/settings");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "media_path": "/var/www/media/",
})

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[]

HTTP Request

POST api/settings

Body Parameters

Parameter Type Status Description
media_path string required Absolute path to the media folder.

#AWS integration

These routes are meant for Amazon Web Services (AWS) integration with Koel. For more information, visit koel-aws.

Store a song

Create a new song or update an existing one with data sent from AWS.

Example request:

curl -X POST "http://koel.test/api/os/s3/song" 

const url = new URL("http://koel.test/api/os/s3/song");

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/os/s3/song

Remove a song

Remove a song whose information matches with data sent from AWS.

Example request:

curl -X DELETE "http://koel.test/api/os/s3/song" 

const url = new URL("http://koel.test/api/os/s3/song");

let headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

DELETE api/os/s3/song

#Last.fm integration

Scrobble a song

Create a Last.fm scrobble entry for a song.

Example request:

curl -X POST "http://koel.test/api/{song}/scrobble/{timestamp}" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/{song}/scrobble/{timestamp}");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/{song}/scrobble/{timestamp}

Connect to Last.fm

Connect the current user to Last.fm. This is actually NOT an API request. The application should instead redirect the current user to this route, which will send them to Last.fm for authentication. After authentication is successful, the user will be redirected back to api/lastfm/callback?token=<Last.fm token>.

Example request:

curl -X GET -G "http://koel.test/api/lastfm/connect" \
    -H "Authorization: Bearer {token}"

const url = new URL("http://koel.test/api/lastfm/connect");

    let params = {
            "jwt-token": "AgOg6hUdoPnDBWHi",
        };
    Object.keys(params).forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "error": "token_not_provided"
}

HTTP Request

GET api/lastfm/connect

Query Parameters

Parameter Status Description
jwt-token required The JWT token of the user.

Set Last.fm session key

Set the Last.fm session key for the current user. This call should be made after the user is connected to Last.fm.

Example request:

curl -X POST "http://koel.test/api/lastfm/session-key" \
    -H "Authorization: Bearer {token}" \
    -d "key"="9mVYhfjKFsD9W160" 

const url = new URL("http://koel.test/api/lastfm/session-key");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "key": "9mVYhfjKFsD9W160",
})

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

[]

HTTP Request

POST api/lastfm/session-key

Body Parameters

Parameter Type Status Description
key string required The Last.fm session key.

#YouTube integration

Search for YouTube videos

Search YouTube for videos related to a song (using its title and artist name).

Example request:

curl -X GET -G "http://koel.test/api/youtube/search/song/{song}" \
    -H "Authorization: Bearer {token}" \
    -d "pageToken"="26tAbdCbQhXPqp73" 

const url = new URL("http://koel.test/api/youtube/search/song/{song}");

let headers = {
    "Authorization": "Bearer {token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

let body = JSON.stringify({
    "pageToken": "26tAbdCbQhXPqp73",
})

fetch(url, {
    method: "GET",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "kind": "youtube#searchListResponse",
    "etag": "\"XI7nbFXulYBIpL0ayR_gDh3eu1k\/UMIztE1sQ8L9tu7igiTaSoBA9tw\"",
    "nextPageToken": "CAoQAA",
    "regionCode": "CH",
    "pageInfo": {
        "totalResults": 1000000,
        "resultsPerPage": 10
    },
    "items": [
        {
            "kind": "youtube#searchResult",
            "etag": "\"XI7nbFXulYBIpL0ayR_gDh3eu1k\/bRRI2oEvvXIbCBFKv8WrLUaG-0A\"",
            "id": {
                "kind": "youtube#video",
                "videoId": "t99KH0TR-J4"
            },
            "snippet": {
                "publishedAt": "2013-10-15T14:24:31.000Z",
                "channelId": "UCiMhD4jzUqG-IgPzUmmytRQ",
                "title": "Queen - The Show Must Go On (Official Video)",
                "description": "Subscribe to the Official Queen Channel Here http:\/\/bit.ly\/Subscribe2Queen Taken from Innuendo, 1991. Queen - The Show Must Go On (promo video, 1991) ...",
                "thumbnails": {
                    "default": {
                        "url": "https:\/\/i.ytimg.com\/vi\/t99KH0TR-J4\/default.jpg",
                        "width": 120,
                        "height": 90
                    },
                    "medium": {
                        "url": "https:\/\/i.ytimg.com\/vi\/t99KH0TR-J4\/mqdefault.jpg",
                        "width": 320,
                        "height": 180
                    },
                    "high": {
                        "url": "https:\/\/i.ytimg.com\/vi\/t99KH0TR-J4\/hqdefault.jpg",
                        "width": 480,
                        "height": 360
                    }
                },
                "channelTitle": "Queen Official",
                "liveBroadcastContent": "none"
            }
        },
        {
            "...": "..."
        }
    ]
}

HTTP Request

GET api/youtube/search/song/{song}

Body Parameters

Parameter Type Status Description
pageToken string optional The nextPageToken, if applicable.