Skip to main content

​
Prerequisites

Before you begin, you’ll need:
  • A Shipstar account (sign up here)
  • An API key from your Dashboard
  • At least one GitHub repository connected

​
Get Your API Key

1

Log in to Dashboard

Go to app.shipstar.ai and log in to your account.
2

Navigate to API Keys

Click on API Keys in the sidebar to access your API key management.
3

Create a New Key

Click Create API Key, give it a name, and copy your new API key.
Store your API key securely. You won’t be able to see it again after creation.

​
Connect a GitHub Repository

Before generating content, connect your GitHub account and select repositories to track:
1

Connect GitHub

In the dashboard, go to Sources and click Connect GitHub. Authorize Shipstar to access your repositories.
2

Select Repositories

Choose which repositories to track. Shipstar will analyze commits from these repos when generating content.

​
Generate Your First Content

​
Generate a Changelog

Use the following request to generate a changelog from your recent commits: 
curl -X POST "https://api.shipstar.ai/api/internal/sources/github/changelog" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

​
Example Response

{
  "content_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "pending"
}
Content generation runs in the background. The status will transition from pending to processing to completed.

​
Check Content Status

Poll for the result using the content ID: 
curl -X GET "https://api.shipstar.ai/api/internal/sources/content/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Customize the Date Range

By default, Shipstar analyzes the last 7 days of commits. You can specify a custom range:
cURL
curl -X POST "https://api.shipstar.ai/api/internal/sources/github/changelog" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "start_date": "2025-03-01T00:00:00Z",
    "end_date": "2025-03-31T23:59:59Z",
    "product_name": "My Product"
  }'

​
Publish Your Content

Once content is generated, publish it to get a public URL:
cURL
curl -X POST "https://api.shipstar.ai/api/internal/content/a1b2c3d4-e5f6-7890-abcd-ef1234567890/publish" \
  -H "Authorization: Bearer YOUR_API_KEY"
Response
{
  "public_slug": "my-product-changelog-march-2025",
  "is_published": true,
  "public_url": "https://api.shipstar.ai/api/v1/changelog/my-product-changelog-march-2025"
}
Published content is accessible without authentication at the public URL and includes an RSS feed.

​
Try Other Content Types

Replace the endpoint path to generate different types of content:
Content TypeEndpoint
Product UpdatePOST /sources/github/product-update
Feature BlogPOST /sources/github/feature-blog
Blog PostPOST /sources/github/blog-post
LinkedIn PostPOST /sources/github/linkedin-post
Twitter ThreadPOST /sources/github/twitter-thread
Feature PagePOST /sources/github/feature-page
KB ArticlesPOST /sources/github/kb-articles
ChangelogPOST /sources/github/changelog
Release Notes EmailPOST /sources/github/release-notes-email
All endpoints accept the same request body with optional start_date, end_date, and product_name.

​
Next Steps

How It Works

Learn how Shipstar transforms commits into content

Authentication

Deep dive into API authentication

Error Handling

Learn how to handle API errors

API Reference

Explore the full API documentation