> ## Documentation Index
> Fetch the complete documentation index at: https://docs.velora.crickdevs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Velora local API

> Localhost-only API for the Velora desktop app, including registration, token auth, playback reads, and playback controls.

The Velora local API is a localhost-only HTTP and WebSocket interface exposed by the Electron desktop app. It lets approved local applications read playback state and send playback controls.

## Availability

* Recommended Velora Version: `6.5.0`
* Minimum Velora Version: `6.3.0`
* Host: `127.0.0.1`
* Default port: `39031`
* Base URL: `http://127.0.0.1:39031`
* Transport: HTTP and WebSocket
* CORS: `*` with `Authorization` and `Content-Type`
* Scope: local machine only (loopback addresses)

<Warning>
  If Velora is running a version lower than 6.3.0, the API will not be accessible.
</Warning>

<Warning>
  The local API is designed for trusted local integrations. It does not accept non-loopback traffic.
</Warning>

## What you can do

With `read` permission:

* Check server status
* Read the current track
* Read playback state
* Read playback queue
* Read the signed-in user's public profile snapshot
* Subscribe to playback updates over WebSocket

With `write` permission:

* Play a specific track (or resume)
* Pause playback
* Skip to next track
* Seek to a position in milliseconds
* Toggle play and pause

## Quick start

1. Register your local app with `POST /register`.
2. Poll `GET /request-status?request_id=...` until you receive an `access_token`.
3. Use `Authorization: Bearer <token>` (or `access_token` query param) for authenticated calls.
4. Connect to `ws://127.0.0.1:39031/ws?access_token=<token>` for real-time events.

```bash theme={null}
curl -X POST http://127.0.0.1:39031/register \
  -H "Content-Type: application/json" \
  -d '{
    "app": {
      "name": "Game Launcher",
      "description": "Local game launcher that allows downloading and playing games",
      "developer": "CrickDevs",
      "website": "https://gamelauncher.crickdevs.com",
      "icon": "https://gamelauncher.crickdevs.com/icon.png"
    },
    "permissions": ["read", "write"]
  }'
```