The official public API for Clippsly Listener.
Clippsly Listener is a personal music locker that lets you upload, organize and stream your own music library from anywhere. This repository contains the OpenAPI specification for the public Listener API and its compatibility layers.
The complete API specification is available in:
The specification follows the OpenAPI standard and can be imported into tools such as Swagger UI, Postman and Insomnia.
Manage your Listener account, create App Passwords and view your storage usage at:
https://listener.clippsly.app
The native Listener API uses App Passwords.
Supported authentication methods:
Authorization: Bearer <app_password>
or
X-Clippsly-App-Key: <app_password>
App Passwords can be created from the Listener Portal.
Clippsly provides compatibility endpoints for existing music players.
https://listener.clippsly.app/external/subsonic
Authentication:
u=<clippsly_username>
p=<app_password>
These compatibility layers allow existing Subsonic-compatible applications to connect to Clippsly Listener without requiring changes.
- Versioned REST API
- OpenAPI specification
- App Password authentication
- Personal music locker
- Album management
- Playlist management
- Folder uploads
- Playback API
- Multiple audio quality variants
- Subsonic compatibility
- Navidrome compatibility
The native API is available under:
/v1/
Future breaking changes will be introduced under a new version while keeping previous versions available.
Licensed under the Apache License 2.0. See LICENSE for details.