v38

latestOpenAPI 3.0.3AGPL-3.0raw.githubusercontent.com2026-08-022461333.9 MB
Authentication

Authenticate and start a session (deprecated)

When you do not have an API key you can request a session token using handshake which can then be used as your authentication token.

post/handshake

Query parameters

authstring

Passphrase (timestamp + password hash) or API key. This is a credential, not an existing session token, so it is not the same value as the auth security scheme. Omit it when authenticating with a Bearer token or the auth header. Prefer sending it in the request body rather than the query string.

userstring

Username (required for login/password authentication).

timestampinteger

UNIX time used in seed of password hash (required for login/password authentication).

versionstring

API version the client understands. REST callers should omit it -- the version in the URL path wins; if both are sent and disagree, the path version is used and this parameter is ignored.

Request body

userstring

Username (required for login/password authentication).

timestampinteger

UNIX time used in seed of password hash (required for login/password authentication).

versionstring

API version the client understands. REST callers should omit it -- the version in the URL path wins; if both are sent and disagree, the path version is used and this parameter is ignored.

Response

Session info or error

authstring nullable required
streamtokenstring nullable required
apistring required
updatestring required
addstring required
cleanstring required
max_songinteger required
max_albuminteger required
max_artistinteger required
max_videointeger required
max_podcastinteger required
max_podcast_episodeinteger required
songsinteger required
albumsinteger required
artistsinteger required
genresinteger required
playlistsinteger required
searchesinteger required
playlists_searchesinteger required
usersinteger required
catalogsinteger required
videosinteger required
podcastsinteger required
podcast_episodesinteger required
sharesinteger required
licensesinteger required
live_streamsinteger required
labelsinteger required
usernamestring required