Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.seraph.si/llms.txt

Use this file to discover all available pages before exploring further.

Seraph pulls stats from two official sources, configured under the API tab in the settings menu:
  1. Hypixel API: for player stats, guild data, and most overlay columns.
  2. Seraph API: for tags, reports, ping data, and the live socket.

​
Seraph login

token.json is your authorisation token, you’ll NEVER be asked for it.
Signing in happens automatically the first time you run the launcher. It prompts you for Discord, and after you authorise, it writes your auth token to token.json in your Seraph folder. If the mod ever throws an authentication error on startup, re-run the launcher and sign in again. Your config and other data stay intact.

​
Seraph API key

You’ll only need this on external applications such as Cubelify.
The Seraph API key is a separate value from the login token. To get one:
1

Join the Seraph Discord

Open the Seraph Discord server. The invite link is on seraph.si or in the launcher.
2

Run /generate-key with the Seraph bot

Type /generate-key in any channel where the Seraph bot is present. The bot DMs you a fresh key.
3

Paste it into Seraph

Open /seraph config, go to the API tab, and paste the key into Seraph API Key.
The key field is masked. Click the eye icon to reveal it for editing or copying. If you ever need to change your key, Open a ticket and an Administrator will guide you through the process.

​
Hypixel API key

Sharing this key with untrusted sources is risky and if abused, will permanently ban you from the Hypixel API
A Hypixel API key is required for the overlay to fill in stats. Without one, columns like FKDR, wins, and ratios stay blank.
1

Open the Hypixel Developer Dashboard

Run /seraph apikey (alias /sapikey). It opens developer.hypixel.net so you can claim or view your key.
2

Copy your key

Sign in with your Minecraft account and copy your API key from the dashboard.
3

Paste it into Seraph

Back in /seraph config, on the API tab, paste the key into Hypixel API Key.

​
API Merger

The API tab also has Enable API Merger (port 3005). When on, Seraph runs a local HTTP server on localhost:3005 that aggregates tag data from every Custom Cubelify API URL you’ve configured (under the Overlay tab, General sub-tab) and serves the merged result at /api/merger?name=<name>&id=<uuid>. Leave it off unless an external tool you’re using needs to consume that combined feed.

​
Verifying

Open any Hypixel lobby or game and bring up the tab list. Players should populate with stats within a second or two. If everything stays blank, double-check:
  • Your Hypixel key is valid (rerun /seraph apikey).
  • Your Seraph API key is set (rerun /generate-key if needed).
  • token.json exists in your Seraph folder (re-run the launcher if not).
  • Your network can reach Hypixel and Seraph.