1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608# API Reference
Resonance exposes a REST API for managing the music discovery pipeline.
## Base URL
```
http://localhost:8080/api/v1
```
## Authentication
All endpoints (except `/health`) require authentication when enabled.
### Basic Auth
```bash
curl -u admin:password http://localhost:8080/api/v1/queue/pending
```
### API Key Auth
```bash
curl -H "Authorization: Bearer your_api_key" http://localhost:8080/api/v1/queue/pending
```
Or via header:
```bash
curl -H "X-API-Key: your_api_key" http://localhost:8080/api/v1/queue/pending
```
---
## Endpoints
### Health
#### GET /health
Health check endpoint (no auth required).
**Response:**
```json
{
"status": "healthy",
"version": "1.0.0",
"services": {
"lb_fetch": "running",
"catalog_discovery": "running",
"slskd_downloader": "running"
}
}
```
---
### Queue Management
#### GET /api/v1/queue/pending
List all pending items awaiting approval.
**Query Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `source` | string | all | Filter by source: `listenbrainz`, `catalog`, or `all` |
| `sort` | string | `added_at` | Sort by: `added_at`, `score`, `artist`, `year` |
| `order` | string | `desc` | Sort order: `asc` or `desc` |
| `limit` | int | 50 | Max items to return |
| `offset` | int | 0 | Pagination offset |
**Response:**
```json
{
"items": [
{
"artist": "Justice",
"album": "Cross",
"mbid": "abc123-def456-...",
"type": "album",
"added_at": "2026-01-11T10:00:00Z",
"score": 2.45,
"source": "catalog",
"similar_to": ["Daft Punk", "Kavinsky"],
"cover_url": "https://coverartarchive.org/release-group/abc123/front-250",
"year": 2007
}
],
"total": 71,
"limit": 50,
"offset": 0
}
```
#### GET /api/v1/queue/approved
List approved items (processed to wishlist).
**Response:** Same format as pending.
#### GET /api/v1/queue/rejected
List rejected MBIDs.
**Response:**
```json
{
"rejected": ["mbid-1", "mbid-2", "mbid-3"],
"total": 3
}
```
#### POST /api/v1/queue/approve
Approve one or more pending items.
**Request Body:**
```json
{
"mbids": ["abc123-...", "def456-..."]
}
```
Or approve all:
```json
{
"all": true
}
```
**Response:**
```json
{
"approved": 2,
"message": "2 items approved and added to wishlist"
}
```
#### POST /api/v1/queue/reject
Reject one or more pending items.
**Request Body:**
```json
{
"mbids": ["abc123-...", "def456-..."]
}
```
**Response:**
```json
{
"rejected": 2,
"message": "2 items rejected"
}
```
#### DELETE /api/v1/queue/pending/{mbid}
Remove a specific item from pending queue without rejecting.
**Response:**
```json
{
"removed": true,
"mbid": "abc123-..."
}
```
---
### Wishlist
#### GET /api/v1/wishlist
List current wishlist entries.
**Response:**
```json
{
"items": [
{
"entry": "a:\"Justice - Cross\"",
"artist": "Justice",
"title": "Cross",
"type": "album"
}
],
"total": 5
}
```
#### POST /api/v1/wishlist
Add a manual entry to the wishlist.
**Request Body:**
```json
{
"artist": "Daft Punk",
"title": "Discovery",
"type": "album"
}
```
**Response:**
```json
{
"added": true,
"entry": "a:\"Daft Punk - Discovery\""
}
```
#### DELETE /api/v1/wishlist/{entry}
Remove an entry from the wishlist.
**Response:**
```json
{
"removed": true
}
```
---
### Downloads
#### GET /api/v1/downloads/active
Get active downloads from slskd.
**Response:**
```json
{
"downloads": [
{
"id": "download-id",
"username": "uploader123",
"filename": "01 - Track.flac",
"size": 45000000,
"downloaded": 27000000,
"progress": 60,
"speed": 1200000,
"state": "InProgress"
}
],
"total": 3
}
```
#### GET /api/v1/downloads/completed
Get recently completed downloads.
**Response:**
```json
{
"downloads": [
{
"id": "download-id",
"username": "uploader123",
"directory": "Justice - Cross (2007) [FLAC]",
"files": 12,
"size": 450000000,
"completed_at": "2026-01-11T10:30:00Z"
}
],
"total": 15
}
```
#### GET /api/v1/downloads/failed
Get failed downloads (from downloaded.json with no files).
**Response:**
```json
{
"items": [
{
"entry": "a:\"Obscure Artist - Rare Album\"",
"reason": "No results found",
"failed_at": "2026-01-11T09:00:00Z"
}
],
"total": 2
}
```
#### POST /api/v1/downloads/retry
Retry a failed download.
**Request Body:**
```json
{
"entry": "a:\"Obscure Artist - Rare Album\""
}
```
**Response:**
```json
{
"queued": true,
"message": "Added back to wishlist for retry"
}
```
#### POST /api/v1/downloads/search
Search slskd directly.
**Request Body:**
```json
{
"query": "Justice Cross FLAC",
"timeout": 15000
}
```
**Response:**
```json
{
"results": [
{
"username": "uploader123",
"files": [...],
"score": 85
}
],
"total": 10
}
```
---
### Actions
#### POST /api/v1/actions/lb-fetch
Trigger lb-fetch immediately.
**Response:**
```json
{
"started": true,
"message": "lb-fetch started"
}
```
#### POST /api/v1/actions/catalog
Trigger catalog-discovery immediately.
**Response:**
```json
{
"started": true,
"message": "catalog-discovery started"
}
```
#### POST /api/v1/actions/downloader
Trigger slskd-downloader immediately.
**Response:**
```json
{
"started": true,
"message": "slskd-downloader started"
}
```
#### GET /api/v1/actions/status
Get status of running actions.
**Response:**
```json
{
"lb_fetch": {
"running": false,
"last_run": "2026-01-11T10:00:00Z",
"next_run": "2026-01-11T16:00:00Z"
},
"catalog_discovery": {
"running": false,
"last_run": "2026-01-10T10:00:00Z",
"next_run": "2026-01-17T10:00:00Z"
},
"slskd_downloader": {
"running": true,
"started_at": "2026-01-11T10:45:00Z"
}
}
```
---
### Library
#### GET /api/v1/library/stats
Get library statistics from Navidrome.
**Response:**
```json
{
"artists": 847,
"albums": 2341,
"tracks": 28456,
"total_size": "245 GB",
"total_duration": "1823 hours"
}
```
#### GET /api/v1/library/check
Check if an album exists in the library.
**Query Parameters:**
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `artist` | string | Yes | Artist name |
| `album` | string | Yes | Album title |
**Response:**
```json
{
"exists": true,
"match": {
"artist": "Daft Punk",
"album": "Discovery",
"year": 2001,
"tracks": 14
}
}
```
---
### Settings
#### GET /api/v1/settings
Get current configuration (sensitive values redacted).
**Response:**
```json
{
"listenbrainz": {
"username": "saybis",
"approval_mode": "manual"
},
"mode": "album",
"fetch_count": 100,
"catalog_discovery": {
"enabled": true,
"max_artists_per_run": 10,
"min_similarity": 0.3,
"mode": "manual"
}
}
```
#### PATCH /api/v1/settings
Update configuration values.
**Request Body:**
```json
{
"catalog_discovery": {
"max_artists_per_run": 15
}
}
```
**Response:**
```json
{
"updated": true,
"restart_required": false
}
```
---
### Search
#### GET /api/v1/search/musicbrainz
Search MusicBrainz for artists/albums.
**Query Parameters:**
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | Search query |
| `type` | string | No | `artist` or `release-group` |
**Response:**
```json
{
"results": [
{
"name": "Justice",
"type": "artist",
"mbid": "abc123-...",
"country": "FR",
"disambiguation": "French electronic duo"
}
]
}
```
---
## WebSocket Endpoints (Phase 5)
### WS /api/v1/ws/logs
Real-time log streaming.
**Messages:**
```json
{
"timestamp": "2026-01-11T10:00:00Z",
"level": "INFO",
"service": "lb-fetch",
"message": "Added 5 albums to pending queue"
}
```
### WS /api/v1/ws/downloads
Download progress updates.
**Messages:**
```json
{
"type": "progress",
"id": "download-id",
"progress": 65,
"speed": 1200000
}
```
### WS /api/v1/ws/queue
Queue change notifications.
**Messages:**
```json
{
"type": "added",
"count": 5,
"source": "catalog"
}
```
---
## Error Responses
All errors follow this format:
```json
{
"error": true,
"code": "INVALID_REQUEST",
"message": "Missing required field: mbids",
"details": {}
}
```
### Error Codes
| Code | HTTP Status | Description |
|------|-------------|-------------|
| `UNAUTHORIZED` | 401 | Invalid or missing authentication |
| `FORBIDDEN` | 403 | Insufficient permissions |
| `NOT_FOUND` | 404 | Resource not found |
| `INVALID_REQUEST` | 400 | Malformed request |
| `CONFLICT` | 409 | Resource already exists |
| `INTERNAL_ERROR` | 500 | Server error |
| `SERVICE_UNAVAILABLE` | 503 | External service unavailable |
---
## Rate Limiting
The API does not implement rate limiting by default. For public-facing deployments, configure rate limiting in your reverse proxy (Caddy, nginx, Traefik, etc.).
---
## OpenAPI Specification
The full OpenAPI spec is available at:
```
GET /api/v1/openapi.json
GET /docs # Interactive Swagger UI
GET /redoc # ReDoc documentation
```