Skip to main content

​
Base URL

EnvironmentBase URL
Productionhttps://api.suprlogs.com
Localhttp://localhost:4704

​
Authentication

  • API keys: Create keys in Dashboard → Settings → API Keys.
  • Send the key as either:
    • Authorization: Bearer <your-api-key>
    • X-API-KEY: <your-api-key>
  • Authenticated endpoints return 401 Unauthorized when credentials are missing or invalid.
  • API keys are shown only once at creation. After that, only metadata and prefix are visible.

​
Response format

  • Success responses return JSON payloads.
  • Error responses return JSON with an error field.
  • Common status codes: 400, 401, 403, 404, 422, 500.

​
Endpoints

The Endpoints section in the sidebar is generated directly from the OpenAPI spec produced by pnpm generate:openapi. It includes current /v1 API routes and updates as route-level @openapi annotations are added.