OpenAPI Spec

The WakeLink relay serves a live FastAPI-generated OpenAPI document. Use the interactive viewers below to explore the schema, or consume the raw JSON directly.

Interactive Viewers

  • Swagger UI — interactive API explorer with try-it-out support
  • ReDoc — clean documentation viewer
  • Raw JSON — machine-readable OpenAPI schema

Using the Spec

The openapi.json document can be consumed by client generators such as openapi-generator or openapi-typescript to produce strongly-typed clients in any supported language:

bash
npx openapi-typescript https://wakelink-project.org/api/openapi.json -o wakelink-api.d.ts
💡Tip

The spec is fetched from the live relay instance. If the relay is briefly unavailable, reload the page once it is back up.