API Reference

Complete REST API reference for AurisLink.

Authentication

All API requests require the authorization password in the header:

Authorization: youshallnotpass

Base URL

http://localhost:2333/v4

Endpoints

Get Server Info

GET /info

Get information about the AurisLink server.

Response:

{
  "version": "1.6.0",
  "buildLine": 1234,
  "git": {
    "branch": "main",
    "commit": "abc123",
    "commitTime": 1234567890
  },
  "jvm": "...",
  "lavaplayer": "...",
  "source": {
    "soundcloud": true,
    "deezer": true,
    "spotify": true
  }
}

Load Tracks

GET /loadtracks

Load tracks from a URL or search query.

Query Parameters:

  • identifier - URL or search query

Create Session

POST /sessions/{sessionId}

Create a new player session.

Get Player

GET /sessions/{sessionId}/players/{guildId}

Get player information for a guild.

Update Player

PATCH /sessions/{sessionId}/players/{guildId}

Update player state (volume, track, filters, etc).

Destroy Player

DELETE /sessions/{sessionId}/players/{guildId}

Destroy a player session.

Get Lyrics

GET /v4/lyrics

Get lyrics for a track.

Query Parameters:

  • identifier - Track identifier
  • source - Lyrics source (optional)

Get Stats

GET /stats

Get server statistics and metrics.

WebSocket Events

Connect to the WebSocket for real-time updates:

ws://localhost:2333/v4/websocket
Authorization: youshallnotpass

ready

Emitted when the WebSocket connection is ready.

playerUpdate

Emitted when player state changes.

stats

Emitted periodically with server statistics.

trackStart

Emitted when a track starts playing.

trackEnd

Emitted when a track finishes playing.

Error Codes

400 - Bad Request
401 - Unauthorized (Invalid password)
404 - Not Found
500 - Internal Server Error