Lokale API

Bibliothek lesen, Metadaten ändern und den Player steuern, per HTTP auf deinem Rechner, für eigene Skripte und das Stream-Deck-Plugin.

ProZuletzt aktualisiert:

Auf dieser Seite

ZugangLink zu „Zugang“

Die lokale API läuft mit dem Companion-Server: Einstellungen → Integrationen → „Companion & lokale API“ → „Companion aktivieren“. Dort stehen „Adresse“ und „Pairing-Token“. Standardmäßig ist der Server nur auf diesem Rechner (Loopback) erreichbar.

Bibliothek lesenLink zu „Bibliothek lesen“

Anfrage
GET /api/library
Authorization: Bearer <Token>

Die Antwort enthält öffentliche Metadaten, Revisionen von Tracks und Playlists und aufgelöste Smartlists. Nach einem Neustart des Servers neu paaren.

ÄnderungenLink zu „Änderungen“

Erst „Mobile Änderungen und Player-Steuerung erlauben“ einschalten. Jede Änderung braucht die aktuelle Revision aus GET:

Track ändern
POST /api/changes
Authorization: Bearer <Token>
Content-Type: application/json

{
  "type": "track",
  "id": "Track-ID aus GET",
  "baseRevision": "Revision aus GET",
  "patch": { "rating": 4, "notes": "Peak-Time", "tags": ["Audience:Club"] }
}

Erlaubte Track-Felder: title, artist, album, genre, bpm, key, tags, rating, energy, notes, favorite. Eine veraltete Revision ergibt 409 und ändert nichts; ist die Schreibfreigabe aus, kommt 405. Erfolgreiche Änderungen erscheinen am Desktop und lassen sich dort zurücknehmen.

Player steuernLink zu „Player steuern“

Player-Befehl
POST /api/control

{ "action": "play", "trackId": "Track-ID aus GET" }

Aktionen: toggle, pause, next, previous, jump-forward (+8 Beats), jump-back (−8 Beats), play und enqueue. Der Desktop-Player muss geöffnet sein.

Etwas fehlt oder stimmt nicht? Sag uns Bescheid. Die Oberfläche gibt es auch auf Englisch; die Docs nennen die deutschen Bezeichnungen.

Originale Sonodex-App · Demo-Bibliothek