Valet docs

Valet speaks ER:LC's API. If your bot works with ER:LC today, it works with Valet after you change the base URL and the key.

Getting started

1. Sign in at valet.cordyx.xyz/app and add your server with its ER:LC server key.
2. Make a key for each bot or developer and tick what it may do. Copy it straight away: Valet stores only a hash and can't show it again.
3. Replace https://api.erlc.gg with https://valet.cordyx.xyz/api and use the valet key. The old relay.cordyx.xyz address keeps working for the API.

To run commands, ER:LC also needs you to authorize Valet on your server once. The dashboard shows the link after you add a server.

Sending the key

Either header works. Use whichever needs fewer changes in your code.

Server-Key: vk_…
Authorization: Bearer vk_…

Valet keys start with vk_ and are 43 characters long. Keys made before the rename start with cxr_ and still work. Don't use them in browser code: anyone who opens the page can read them. Valet sends no CORS headers for that reason.

Endpoints

Anything else answers 404 with code 9007.

v2 fields

On GET /api/v2/server, each field you set to true needs its own permission. A field Valet doesn't know is refused, not ignored.

Commands

Valet reads the first word of the command and checks it against the key. Every command is its own permission. A command not listed here is refused for all keys. :bring and :to aren't listed because ER:LC can't run them remotely: they need someone in game to run them.

Limits

• Commands: one every 5 seconds per server, shared by all of that server's keys. That's ER:LC's own limit; Valet answers 429 with retry_after instead of passing the request on.
• Reads: identical requests within 5 seconds get the same answer. The X-Valet-Cache header says hit, shared or miss.
• 120 requests a minute per key.
• Activity logs are kept for 30 days.

Errors

Errors use ER:LC's shape, {"code": …, "message": "…"}. Codes from ER:LC pass through unchanged. Valet's own are in the 9000s.

Examples

Python

import os, requests

r = requests.get(
    "https://valet.cordyx.xyz/api/v2/server",
    params={"Players": "true", "Queue": "true"},
    headers={"Server-Key": os.environ["VALET_KEY"]},
)
print(r.json()["Players"])

curl

curl -X POST https://valet.cordyx.xyz/api/v1/server/command \
  -H "Authorization: Bearer $VALET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": ":h Server restart in 10 minutes"}'