Skip to content

Added API endpoint docs #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EnchantedGoldenApple wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added API endpoint docs #215

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions docs/api_endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# API Endpoints

**GET /debug**
- Description: Returns recent debug output (tail of log or configured debug command).
- Parameters: none
- Response: JSON: {"debug_msg": "..."}


**GET /queue**
- Description: Shows queued/background tasks and their status
- Parameters: none
- Response: JSON array of task objects

**POST /search**
- Description: Search Deezer for matching music
- Request JSON body:
- `type` (string): one of `track`, `album`, `album_track`, `artist`, `artist_album`, `artist_top`
- `query` (string): search query (non-empty)
- Response: JSON array of search results (artist, id, title/album)

**POST /download**
- Description: Download a Deezer track or album and optionally add to playlist / zip
- Request JSON body:
- `type` (string): `album` or `track`
- `music_id` (int): id of the album or track
- `add_to_playlist` (bool)
- `create_zip` (bool)
- Response: JSON: {"task_id": <integer>}

**POST /youtubedl**
- Description: Download a media URL using youtube-dl and optionally add to playlist
- Request JSON body:
- `url` (string): http(s) url supported by youtube-dl
- `add_to_playlist` (bool)
- Response: JSON: {"task_id": <integer>}

**POST /playlist/deezer**
- Description: Download all songs from a public Deezer playlist
- Request JSON body:
- `playlist_url` (string): Deezer playlist URL or id
- `add_to_playlist` (bool)
- `create_zip` (bool)
- Response: JSON: {"task_id": <integer>}

**POST /playlist/spotify**
- Description: Parse a Spotify playlist, find songs on Deezer and download them
- Request JSON body:
- `playlist_name` (string): friendly name for the created folder
- `playlist_url` (string): Spotify playlist URL or id
- `add_to_playlist` (bool)
- `create_zip` (bool)
- Response: JSON: {"task_id": <integer>}

**POST /favorites/deezer**
- Description: Download favorite songs of a Deezer user
- Request JSON body:
- `user_id` (string): numeric Deezer user id (string of digits)
- `add_to_playlist` (bool)
- `create_zip` (bool)
- Response: JSON: {"task_id": <integer>}