Authentication

The Hyperion API uses Bearer token authentication to identify users with premium plans.

Usage

To authenticate your requests, include your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" https://api.sylvain.sh/v6/infos

Checking Your Plan

Use GET /auth to check which tier a token resolves to, along with its limits:

curl -H "Authorization: Bearer YOUR_API_KEY" https://api.sylvain.sh/auth

{
    "authenticated": true,
    "tier": "pro",
    "limits": {
        "hourly": 6000,
        "burst": 120
    }
}

Without a token, it returns the default tier instead of an error:

{
    "authenticated": false,
    "tier": "default",
    "limits": {
        "hourly": 2000,
        "burst": 50
    }
}

An invalid token returns the same 401 shown below.

Rate Limits

Plan	Requests/hour	Burst/10s
Free	2,000	50
Advanced	3,500	80
Pro	6,000	120
Business	10,000	200

Burst Limit

The burst limit prevents sending too many requests in a short window. If you exceed the burst limit, you will receive a 429 Too Many Requests response.

See the Pricing page for more details.

Rate Limit Headers

Every response carries your current quota, so a client can pace itself instead of discovering its limit by hitting it.

Header	Description
X-RateLimit-Limit	Requests allowed in the current window
X-RateLimit-Remaining	Requests left in the current window
X-RateLimit-Reset	When the window resets
Retry-After	Seconds to wait before retrying, sent only on a 429

New in 6.0.0

These headers did not exist before 6.0.0. Read X-RateLimit-Remaining on every response and slow down as it approaches zero, rather than waiting for a 429.

Error Responses

Invalid Token

If the provided token is incorrect or expired:

{
    "message": "Unauthorized",
    "error": "Invalid token.",
    "status": 401
}

No Token

Note

If no token is provided, the request is treated as unauthenticated and uses the Free tier limits (2,000 requests/hour).

Getting an API Key

To obtain an API key, purchase a plan on the Pricing page. Your unique token will be sent to your email after purchase.