Skip to main content

​
Prerequisites

  • A SuprLogs account (sign up at suprlogs.com).
  • A GitHub repository (public for Hobby, or private on Pro/Enterprise).
  • An API key (create one in the dashboard under Settings → API Keys).

​
Base URL and authentication

  • Base URL: https://api.suprlogs.com (or your deployment; local dev: http://localhost:4704).
  • Authentication: Send your API key as Authorization: Bearer <your-api-key> or X-API-KEY: <your-api-key>.

​
Step 1: Health check

GET /health confirms the API is running. 
curl "https://api.suprlogs.com/health"
Response (200): 
{
  "status": "ok",
  "timestamp": "2026-03-05T12:00:00.000Z",
  "service": "suprlogs-api"
}

​
Step 2: Connect a repository (coming soon)

Repository connection and changelog scan are available via the dashboard and /v1 endpoints. Typical flow:
  1. Connect your GitHub App installation and select repository/branch.
  2. SuprLogs scans commit history and generates changelog entries.
  3. Fetch entries via API or view them on your hosted changelog (e.g. mycompany.suprlogs.app).

​
Next steps