Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.suprlogs.com/llms.txt

Use this file to discover all available pages before exploring further.

​
What is SuprLogs?

SuprLogs turns your GitHub commit history into human-readable changelogs. Connect repositories in the dashboard; we scan commits and store published changelog entries you can show on our hosted pages or consume from your own stack. This documentation site focuses on the small, stable integration surface: a health check, an authenticated projects endpoint, and public changelog routes for listing or fetching individual posts by slug—ideal if you want SuprLogs as the system of record and a custom frontend elsewhere.

Open the dashboard

Connect repos, manage projects, API keys, and hosted changelog settings.

​
What you can do with the documented API

  • GET /health — Check that the API is up.
  • GET /v1/projects — List every project you can access (per API key scope) with nested published entries. Authenticated.
  • GET /v1/changelog/{slug} — List published entries for a project. Public, paginated.
  • GET /v1/changelog/{slug}/entries/{id} — Fetch a single published entry. Public.
Create API keys under Settings → API Keys and send Authorization: Bearer <key> or X-API-KEY: <key> for authenticated routes. The changelog routes require no auth. The base URL is https://api.suprlogs.com (or your deployment).

API Reference

Base URL, authentication, and OpenAPI-backed endpoints.

​
Next steps

Quickstart

Connect a repo and fetch changelog entries.

API Reference

Endpoints, request/response shapes, and examples.