Super People Docs
API Reference

Service

The liveness check — the only route that needs no session.

The liveness check — the only route that needs no session.

Generated from the OpenAPI spec by npm run docs:api -w api. Do not edit this page — change the decorators in apps/api/src/ and regenerate.

Conventions

  • Auth — none; these routes are public.
  • Errors — every non-2xx response has the body described in Errors.
  • Types — a ? after a field name means it is optional; | null means it is present but may be null.

Endpoints

GET /api/v1/health — Liveness check

The only route that needs no session. Use it to validate a base URL.

Returns 200 → HealthResponse

Data models

HealthResponse

FieldTypeNotes
statusstring
versionstring
timestring ISO 8601

On this page