API Overview

OmniLux exposes a REST API for core server operations. The public docs focus on the most common integration surfaces and intentionally avoid exhaustive coverage of internal or sensitive admin workflows.

Start here

Auth

Get a bearer token first

Most integrations start with login and the standard Authorization header.

Library

Browse media and metadata

Use this surface for catalogs, dashboards, search, and media detail lookups.

Playback

Start playback and report progress

Use this surface for players, HLS consumers, and continue-watching flows.

Base URL

http://your-server:4000/api

All endpoints are prefixed with /api.

Authentication

Most endpoints require a bearer token:

Authorization: Bearer <token>

Use HTTPS whenever the server is reachable outside your local network, and keep tokens out of screenshots, logs, and shared example commands.

Response format

Successful responses return data directly. Error responses use a compact JSON structure:

{
  "error": "Human-readable error message",
  "code": "MACHINE_READABLE_CODE"
}

See Errors for common error codes and general rate-limiting behavior.

Main surfaces

• Authentication for login and bearer-token usage.
• Library for roots, files, metadata, and storage summaries.
• Streaming and Live TV for playback and guide data.
• Profile and Errors for user preferences and operational handling.