Skip to main content

​
Base URL

All V1 API endpoints are served at:

​
Authentication

Most public content endpoints (changelogs, blogs, KB articles) do not require authentication. The /me and mailing list endpoints require a Bearer token.
See the Authentication Guide for details on creating and managing API keys.

​
Endpoints

​
Public Content (No Auth Required)

These endpoints serve published content and are freely accessible:

Changelogs

List and retrieve published changelogs with RSS feeds

Blog Posts

List and retrieve published blog posts with RSS feeds

Knowledge Base

List and retrieve published KB article sets

Health Check

Check API availability

​
Authenticated

Get Current User

Verify your API token and retrieve your user profile

Mailing Lists

List mailing lists and bulk-add recipients

​
Response Format

All endpoints return JSON responses. Public content endpoints return the generated content directly. Error responses follow this format:

​
Validation Errors (422)

Validation errors include location and message details:

​
RSS Feeds

Published changelogs and blog posts include RSS 2.0 feeds. Append /feed to any changelog or blog post URL:
  • GET /changelog/{slug}/feed — RSS feed for a single changelog
  • GET /blog/{slug}/feed — RSS feed for a single blog post
  • GET /blogs/feed — RSS feed of all published blog posts

​
Rate Limits

Limits are applied per client IP. Every rate-limited response includes standard headers so clients (and AI agents) can self-throttle in real time: When a limit is exceeded, the API returns 429 Too Many Requests with a Retry-After header (in seconds). Wait at least that long before retrying.
See the Error Handling Guide for details on handling rate limit responses.

​
Versioning

The API is versioned in the URL path (/api/v1). Breaking changes only ship in a new version, and deprecations are announced ahead of any removal — see the Versioning & Deprecation Policy.