API Overview - Shipstar

Base URL

All V1 API endpoints are served at:

https://app.shipstar.ai/api/v1

Authentication

Most public content endpoints (changelogs, blogs, KB articles) do not require authentication. The /me and mailing list endpoints require a Bearer token.

Authorization: Bearer YOUR_API_KEY

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:

{
  "detail": "Error message describing the issue"
}

Validation Errors (422)

Validation errors include location and message details:

{
  "detail": [
    {
      "loc": ["path", "public_slug"],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

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

Endpoint Category	Limit
Public content	100 requests/minute
Authenticated endpoints	100 requests/minute
Add mailing list recipients	30 requests/minute

See the Error Handling Guide for details on handling rate limit responses.

​Base URL

​Authentication

​Endpoints

​Public Content (No Auth Required)