Public REST/JSON reference

Changeloggen API

Auto-generate user-facing changelog entries from your merged GitHub pull requests. Connect a repo, watch as PRs are classified (feature, bugfix, security, breaking change, internal), edit copy in-place, and publish a release-notes block to GitHub Releases, a CHANGELOG.md commit, your website, or a webhook. Free tier covers public repos. Part of the Logic Igniter Developer & DevOps bundle.

Access boundary

These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.

Base URL

https://api.logicigniter.com

Auth

Authorization: Bearer YOUR_API_KEY

Version

OpenAPI 3.0.3 · 1.0.0

Spec

/api-specs/changeloggen.json

Operations rendered

Response models rendered

GET/api/v1/changeloggen/health

Service liveness

Liveness probe — returns 200 if the service is reachable.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/changeloggen/health" \
  -H "Accept: application/json"

Responses

200

Service healthy

GET/api/v1/changeloggen/customers

List customers

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/changeloggen/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CustomersResponse

Page of customers

401Error

Missing or invalid API key.

POST/api/v1/changeloggen/customers

Provision a customer

Idempotent customer provision. Free tier covers public repos only.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: CreateCustomerRequest

Sample JSON payload for evaluation.

{
  "email": "[email protected]",
  "name": "Example Inc."
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/changeloggen/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","name":"Example Inc."}'

Responses

201Customer

Customer created or returned

400Error

Invalid email or missing name

401Error

Missing or invalid API key.

GET/api/v1/changeloggen/customers/{id}

Get a customer by id

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/changeloggen/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200Customer

Customer record

401Error

Missing or invalid API key.

404Error

Customer not found

PUT/api/v1/changeloggen/customers/{id}

Update a customer

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string (uuid)

Request body (required)

Schema: UpdateCustomerRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/changeloggen/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200Customer

Updated customer

400Error

Invalid update

401Error

Missing or invalid API key.

404Error

Customer not found

GET/api/v1/changeloggen/repos

List registered repositories

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/changeloggen/repos" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200ReposResponse

Page of repositories

401Error

Missing or invalid API key.

POST/api/v1/changeloggen/repos

Add a GitHub repository

Register a public or private GitHub repo to ingest PRs from. Returns the repo id used in subsequent calls. The first ingest runs asynchronously — poll `GET /repos/{id}/prs` to see PRs land.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: AddRepoRequest

Sample JSON payload for evaluation.

{
  "github_owner": "example-org",
  "github_repo": "example-repo",
  "default_branch": "main"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/changeloggen/repos" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"github_owner":"example-org","github_repo":"example-repo","default_branch":"main"}'

Responses

201Repository

Repository registered

400Error

Missing owner/repo or unreachable repository

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. The free tier covers public repos and entry-level usage; paid plans unlock private repos, custom rules, and unlimited releases.

GET/api/v1/changeloggen/repos/{repo_id}/prs

List PRs for a repo

Return the PRs ingested for a given repository, paginated. Each PR carries an auto-assigned `classification` from the configured rules — reclassify via POST /prs/{pr_id}/reclassify when wrong.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type
`repo_id`required	path	string (uuid)
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/changeloggen/repos/:repo_id/prs" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200PRsResponse

Page of PRs

401Error

Missing or invalid API key.

404Error

Repository not found

POST/api/v1/changeloggen/prs/{pr_id}/reclassify

Reclassify a PR

Manually override the auto-classifier for a single PR. Most useful when training the classifier on a repo's conventions.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`pr_id`required	path	string (uuid)

Request body (required)

Schema: ReclassifyPRRequest

Sample JSON payload for evaluation.

{
  "classification": "CHANGELOG_CATEGORY_FEATURE"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/changeloggen/prs/:pr_id/reclassify" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"classification":"CHANGELOG_CATEGORY_FEATURE"}'

Responses

200PullRequest

Updated PR

400Error

Invalid classification

401Error

Missing or invalid API key.

404Error

PR not found

PUT/api/v1/changeloggen/rules

Set classification rules

Replace the workspace's classification rules. Each PR is classified by checking, in order: GitHub label → conventional-commit prefix → file-path glob. Empty rules object resets to defaults.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: SetRulesRequest

Sample JSON payload for evaluation.

{
  "rules": {
    "include_internal": false,
    "label_overrides": {
      "sec": "security"
    },
    "prefix_map": {
      "feat": "feature",
      "fix": "bugfix"
    },
    "file_rules": {
      "docs/**": "docs"
    }
  }
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/changeloggen/rules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"rules":{"include_internal":false,"label_overrides":{"sec":"security"},"prefix_map":{"feat":"feature","fix":"bugfix"},"file_rules":{"docs/**":"docs"}}}'

Responses

200ClassificationRulesRecord

Updated rules

400Error

Invalid category key in rules

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. The free tier covers public repos and entry-level usage; paid plans unlock private repos, custom rules, and unlimited releases.

GET/api/v1/changeloggen/repos/{repo_id}/entries

List changelog entries for a repo

List the user-facing changelog entries derived from ingested PRs. Optionally filter by category. Each entry is editable (user_facing_description) and excludable (included = false skips it from generated releases).

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type
`repo_id`required	path	string (uuid)
`page_size`	query	integer
`page_token`	query	string
`category_filter`	query	ChangelogCategory

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/changeloggen/repos/:repo_id/entries" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200EntriesResponse

Page of entries

401Error

Missing or invalid API key.

404Error

Repository not found

PUT/api/v1/changeloggen/entries/{entry_id}

Edit a changelog entry

Override the auto-generated user-facing description before publishing.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`entry_id`required	path	string (uuid)

Request body (required)

Schema: EditEntryRequest

Sample JSON payload for evaluation.

{
  "user_facing_description": "Added bulk import for domain monitoring."
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/changeloggen/entries/:entry_id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"user_facing_description":"Added bulk import for domain monitoring."}'

Responses

200ChangelogEntry

Updated entry

401Error

Missing or invalid API key.

404Error

Entry not found

POST/api/v1/changeloggen/entries/{entry_id}/exclude

Exclude an entry from publication

Mark an entry as excluded (`included = false`). Excluded entries don't appear in the next generated release.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`entry_id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/changeloggen/entries/:entry_id/exclude" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200ChangelogEntry

Entry excluded

401Error

Missing or invalid API key.

404Error

Entry not found

POST/api/v1/changeloggen/repos/{repo_id}/releases

Generate a release

Bundle all included entries since the previous release into a versioned `ReleaseChangelog` with rendered Markdown. Does not publish — call POST /releases/{release_id}/publish to deliver to GitHub Releases / a CHANGELOG.md commit / website / webhook.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`repo_id`required	path	string (uuid)

Request body (required)

Schema: GenerateReleaseRequest

Sample JSON payload for evaluation.

{
  "version": "v1.4.0"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/changeloggen/repos/:repo_id/releases" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"version":"v1.4.0"}'

Responses

201ReleaseChangelog

Generated release

400Error

Missing or duplicate version

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. The free tier covers public repos and entry-level usage; paid plans unlock private repos, custom rules, and unlimited releases.

404Error

Repository not found

POST/api/v1/changeloggen/releases/{release_id}/publish

Publish a release

Deliver the generated release to one or more publish targets. If `targets` is empty, uses the targets stored on the release record from the previous attempt — useful for retries.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`release_id`required	path	string (uuid)

Request body (required)

Schema: PublishReleaseRequest

Sample JSON payload for evaluation.

{
  "targets": [
    "PUBLISH_TARGET_GITHUB_RELEASE",
    "PUBLISH_TARGET_CHANGELOG_FILE"
  ]
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/changeloggen/releases/:release_id/publish" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"targets":["PUBLISH_TARGET_GITHUB_RELEASE","PUBLISH_TARGET_CHANGELOG_FILE"]}'

Responses

200PublishResult

Publish result (may include partial failures in `delivered_to`)

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. The free tier covers public repos and entry-level usage; paid plans unlock private repos, custom rules, and unlimited releases.

404Error

Release not found

Data models

Error

Field	Type	Notes
`error`required	string

ChangelogCategory

PublishTarget

AddRepoRequest

Field	Type	Notes
`github_owner`required	string	Example: "example-org"
`github_repo`required	string	Example: "example-repo"
`default_branch`	string	Example: "main"

Repository

Field	Type	Notes
`id`	string (uuid)
`github_owner`	string
`github_repo`	string
`default_branch`	string

ReposResponse

Field	Type	Notes
`items`	array<Repository>
`next_page_token`	string
`total_count`	integer

PullRequest

Field	Type	Notes
`id`	string (uuid)
`repo_id`	string (uuid)
`pr_number`	integer
`title`	string
`classification`	ChangelogCategory
`merged_at`	string (date-time)

PRsResponse

Field	Type	Notes
`items`	array<PullRequest>
`next_page_token`	string
`total_count`	integer

ReclassifyPRRequest

Field	Type	Notes
`classification`required	ChangelogCategory

ClassificationRules

Field	Type	Notes
`include_internal`	boolean
`label_overrides`	object
`prefix_map`	object
`file_rules`	object

SetRulesRequest

Field	Type	Notes
`rules`required	ClassificationRules

ClassificationRulesRecord

Field	Type	Notes
`id`	string (uuid)
`rules`	ClassificationRules

ChangelogEntry

Field	Type	Notes
`id`	string (uuid)
`repo_id`	string (uuid)
`pr_number`	integer
`category`	ChangelogCategory
`user_facing_description`	string
`included`	boolean
`generated_at`	string (date-time)

EntriesResponse

Field	Type	Notes
`items`	array<ChangelogEntry>
`next_page_token`	string
`total_count`	integer

EditEntryRequest

Field	Type	Notes
`user_facing_description`required	string

GenerateReleaseRequest

Field	Type	Notes
`version`required	string	Example: "v1.4.0"

ReleaseChangelog

Field	Type	Notes
`id`	string (uuid)
`repo_id`	string (uuid)
`version`	string
`changelog_markdown`	string
`publish_targets`	array<PublishTarget>
`generated_at`	string (date-time)

PublishReleaseRequest

Field	Type	Notes
`targets`	array<PublishTarget>

PublishResult

Field	Type	Notes
`id`	string (uuid)
`success`	boolean
`delivered_to`	array<PublishTarget>

CreateCustomerRequest

Field	Type	Notes
`email`required	string (email)
`name`required	string

UpdateCustomerRequest

Field	Type	Notes
`email`	string (email)
`name`	string

Customer

Field	Type	Notes
`id`	string (uuid)
`email`	string (email)
`name`	string
`created_at`	string (date-time)

CustomersResponse

Field	Type	Notes
`items`	array<Customer>
`next_page_token`	string
`total_count`	integer