Skip to content

Getting Started

Welcome to the Hyperion API v4 documentation. This is the previous stable version of the API.

Base URL

All API requests should be made to:

https://api.sylvain.sh/v4

Quick Example

Rate Limiting

Some endpoints have rate limiting to prevent abuse. If you exceed the rate limit, you'll receive an error response:

json
{
    "message": "Too Many Requests",
    "error": "You have exceeded the limit of 2000 requests per hour.",
    "documentation": "https://docs.sylvain.sh",
    "status": "429"
}

Depending on the endpoint and limiter, the error message may also be:

  • Global rate limit exceeded.
  • Rate limit exceeded. Try again in X seconds.

Error Handling

All endpoints return consistent error responses:

json
{
    "message": "Bad Request",
    "error": "Description of the error",
    "documentation": "https://docs.sylvain.sh/v4/{endpoint}",
    "status": "400"
}

Other Versions