Public API¶
The endpoints every signed-in user can call: the ones the apps use to browse a library, play a title, keep favorites and playlists, and ask for a media. One file per service.
| Spec | Description |
|---|---|
| library.swagger.json | Libraries, media items, search, people; the public projection a plugin's interface may read |
| playback.swagger.json | Streaming, progress tracking, watch history, resume |
| user.swagger.json | Authentication, profiles, API keys, Quick Connect |
| collection.swagger.json | Smart and manual collections |
| favorite.swagger.json | Favorite items |
| feed.swagger.json | Home feed sections (continue watching, recently added...) |
| playlist.swagger.json | Playlists, made by hand or by rules |
| rating.swagger.json | User ratings |
| share.swagger.json | Public share links |
| syncplay.swagger.json | Synchronized playback rooms |
| notification.swagger.json | In-app notifications |
| push.swagger.json | Web push subscriptions |
| music.swagger.json | Music library (artists, albums, tracks) |
| photo.swagger.json | Photo library (albums, photos) |
| media_request.swagger.json | Media requests: search, submit, policy; the administrator's answers and request access |
Authentication¶
Endpoints take Authorization: Bearer <token>: a session token from signing
in, or an API key within its scopes (Server API).
Open without one: signing in and renewing a session, signing up with an
invitation, Quick Connect, password reset, the setup wizard and its status,
and public download links.