000%
A clean, versioned REST API for player control, analytics and playlists is in development. This page documents the planned surface — nothing here is live yet.
In development. The public API hasn't launched yet. Want early access or a say in the endpoint design? Get in touch and we'll add you to the waitlist.
Base URL
Final base URL will be announced at launch — designed to be stable from day one.
Authentication
Discord-scoped OAuth2 tokens are planned, with per-app rate limits.
Stability
Versioned as /v1. Breaking changes will be announced 90 days ahead.
Illustrative examples of the planned surface — shapes may change before launch.
/v1/guildsPlannedPlanned — returns the Discord guilds you can manage with SYN MUSIC installed.
{
"guilds": [
{
"id": "964311722381975592",
"name": "The Workshop",
"player": { "state": "playing", "track": "Alan Walker - Faded" }
}
]
}/v1/guilds/{id}/playerPlannedPlanned — fetches the current player state including track, position, volume and queue preview.
{
"state": "playing",
"track": { "title": "Faded", "artist": "Alan Walker", "duration": 213 },
"position": 87,
"volume": 100,
"loop": "off",
"queueLength": 24
}/v1/guilds/{id}/player/playPlannedPlanned — queues and plays a track, playlist or search query in the guild's voice channel.
{ "query": "lofi chill mix", "shuffle": false }{ "ok": true, "track": { "title": "lofi chill mix", "duration": 1080 } }/v1/guilds/{id}/player/skipPlannedPlanned — skips the currently playing track.
{ "ok": true, "skipped": "Faded", "next": "Fade" }/v1/guilds/{id}/player/volumePlannedPlanned — sets the player volume between 0 and 200.
{ "volume": 85 }{ "ok": true, "volume": 85 }/v1/guilds/{id}/player/filtersPlannedPlanned — applies one of the built-in audio filters — 8D, Nightcore, Vaporwave, Lo-Fi, Bass Boost and more.
{ "filter": "8d" }{ "ok": true, "filter": "8d" }/v1/guilds/{id}/analyticsPlannedPlanned — returns listening analytics for the guild over a given range.
{
"range": "30d",
"hours_listened": 128420,
"top_artists": [ { "name": "Alan Walker", "plays": 1241 } ]
}/v1/statusPlannedPlanned — public endpoint with live uptime and latency for every SYN MUSIC service.
{
"status": "operational",
"services": [
{ "name": "Audio Streaming", "status": "operational", "latency_ms": 38 }
]
}Want early access, webhooks or enterprise rate limits? Join the waitlist →
Add SYN MUSIC in under two minutes — free forever, with every premium feature included. No setup stress, no paywall, no limits.