processing (AI generation in progress), draft (ready for editing), published (finalized and visible).
List Releases
GET /api/projects/:projectId/releases
Returns all releases for the specified project, ordered by creation date descending.
Path Parameters
Request
Generate Release
POST /api/projects/:projectId/releases/generate
Triggers AI generation of release notes from GitHub commits in the given date range. The release is created immediately with status: "processing" and transitions to status: "draft" when the AI finishes (or status: "draft" with an errorMessage if generation fails). Poll the Get Release endpoint to check progress.
Path Parameters
Request Body
One or more GitHub repository URLs to pull commits from (e.g.,
["https://github.com/org/repo"]).201 Created
Get Release
GET /api/projects/:projectId/releases/:releaseId
Returns a single release by its ID. Use this to poll for status transitions from processing to draft.
Path Parameters
Request
Update Release
PUT /api/projects/:projectId/releases/:releaseId
Updates the title or content of a release. You can edit draft releases before publishing.
Path Parameters
Request Body
Request
Delete Release
DELETE /api/projects/:projectId/releases/:releaseId
Permanently deletes a release and all its attachments.
Path Parameters
Request
Publish Release
POST /api/projects/:projectId/releases/:releaseId/publish
Marks a draft release as published and records the current timestamp in publishedAt.
Path Parameters
Request
Export Release
GET /api/projects/:projectId/releases/:releaseId/export
Returns the release content as a downloadable Markdown file.
Path Parameters
Request
200 OK with Content-Type: text/markdown and a Content-Disposition: attachment header containing the Markdown content.
Send to Slack
POST /api/projects/:projectId/releases/:releaseId/send-slack
Sends the release to the Slack channel configured in the project’s release settings. Requires a Slack integration to be set up for the project.
Path Parameters
Request
Send via Email
POST /api/projects/:projectId/releases/:releaseId/send-email
Sends the release to the email recipients configured in the project’s release settings.
Path Parameters
Request