Productmind API

A release ships your code: for each application, Productmind compares the development branch with the production branch, lists the commits and opens a pull request. Create a release and prepare it, follow its checks, draft the release notes, curate the work it contains, then ship it to merge every pull request and tag the result. When your deployment pipeline records a production deployment, the release becomes Released and the features it shipped move to Stable. See Releases.


List releases in a workspace

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases

Returns all releases in the workspace. Filterable by status (planned, in_progress, released: every application merged, deployed: every merged application's production deployment completed, archived). Releases group features into coherent deliverables for go-to-market tracking.

List releases in a workspace › path Parameters

workspaceId
​string · required

Workspace UUID

List releases in a workspace › query Parameters

page
​number

Page number (1-indexed, default 1)

limit
​number

Items per page (default 50)

sortBy
​string · enum

Field to sort by

Enum values:
name
status
releasedAt
createdAt
relevance
sortOrder
​string · enum

Sort direction (default desc)

Enum values:
asc
desc
search
​string

Full-text search across searchable fields

status
​

Filter by release status (single value or array)

tags
​string

Comma-separated tag names to filter by

List releases in a workspace › Responses

200

List of releases

​ReleaseDTO[] · required
​object
​object

Create a release

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases

Create a new release. Supply the applications to release; the release identifies itself by its generated REL-n display id and is named after it, so name is optional and normally omitted — the release-notes draft titles it from the actual commits. Passing applicationIds also starts the background prepare.

Create a release › path Parameters

workspaceId
​string · required

Workspace UUID

Create a release › Request Body

name
​string · minLength: 1 · maxLength: 200

Optional human label, e.g. "November ship" or "Checkout revamp". Normally left empty — the release names itself after its generated REL-n display id, and the release-notes draft replaces that with a title derived from the actual commits. Supply one only when you already know what this release is called.

description
​string

Release notes (markdown). Normally left empty — the prepare job drafts these from the actual commits and the user edits them afterwards.

status
​string · enum
Enum values:
planned
in_progress
released
deployed
archived
applicationIds
​string[]

IDs of the Applications to release. Supplying them here links the applications AND starts the background prepare (diff production vs development, list the commits, open a pull request per application, draft the notes). Each application must have a connected git repository.

Create a release › Responses

Created release

​ReleaseDTO · required

Get where the in-progress releases stand

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/readiness

The workspace's In Progress releases, newest first, split in two. readyToMerge: every application still to merge has an open pull request the Release button would merge (prepared, not closed, no provider merge block, checks neither failing nor running) and its checks were read. beingPrepared: every other In Progress release, with how many of its applications are ready and why it is waiting, in the ship gate's own words. Releases in any other status are in neither list. Backs the Releases entry's sidebar counts (releasesReadyToMerge, releasesBeingPrepared in the work counts).

Get where the in-progress releases stand › path Parameters

workspaceId
​string · required

Workspace UUID

Get where the in-progress releases stand › Responses

200

The In Progress releases, ready to merge or being prepared

​ReleaseReadinessDTO · required

Get a release by ID

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}

Retrieve a release with full details including items (features), deployments, and computed progress (task completion percentages).

Get a release by ID › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Get a release by ID › Responses

200

Release details

​ReleaseDTO · required

Delete a release

DELETE
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}

Delete a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Delete a release › Responses

200

Deleted

No data returned

Update a release

PATCH
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}

Update a release's name, release notes (description), or status.

Update a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Update a release › Request Body

name
​string · minLength: 1 · maxLength: 200
​

Release notes (markdown). Pushed into every pull-request body at ship time.

status
​string · enum
Enum values:
planned
in_progress
released
deployed
archived
​

Update a release › Responses

200

Updated release

​ReleaseDTO · required

List what a release shipped

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/shipped

The units of work this release shipped - Tasks, Bug reports, and Sessions that carry neither - grouped by the Feature each rolls up to. Resolved from the release's actual commits at prepare time (a commit SHA matching a coding session's deployment, or a BUG-/TASK-/SSID- display ID CITED by a commit - in its subject, on a Fixes:/Refs:-style trailer line, or at the start or end of a body line. A display ID merely mentioned mid-sentence, or quoted inside a code span, is not a citation and does not attach the work), so it is evidence rather than a plan. A Bug report linked to several Features is returned under each of them. Work that belongs to no Feature is returned in a group whose feature is null. commitsTruncated is true when an application's recorded commits are only the newest of its range (preparing a very large release stops reading at a time budget), so work cited only by older commits is not listed.

List what a release shipped › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

List what a release shipped › Responses

200

Shipped work, grouped by feature

​ReleaseShippedGroupDTO[] · required
​ReleaseCuratedItemDTO[] · required
​ReleaseItemProvenanceDTO[] · required
itemCount
​number · required
commitsTruncated
​boolean · required

Re-resolve what a release shipped

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/shipped/rederive

Re-runs the work-item resolution over the commits ALREADY RECORDED for this release, and returns the rebuilt list in the shape GET /shipped uses. It does NOT re-diff the repositories and does NOT change the commit list — unlike prepare-release, which re-compares the live branches and would rewrite a shipped release's frozen range. Safe at any status, because it reads only persisted rows and needs no repository access. Rows a human added by hand (derived: false) are left alone; every derived row is rebuilt, which is the only way an item the matcher should never have attached comes off a release.

Re-resolve what a release shipped › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Re-resolve what a release shipped › Responses

200

The re-resolved shipped work, grouped by feature

​ReleaseShippedGroupDTO[] · required
​ReleaseCuratedItemDTO[] · required
​ReleaseItemProvenanceDTO[] · required
itemCount
​number · required
commitsTruncated
​boolean · required

Add work to a release

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/shipped/items

Put a task, bug report or session on a release by hand, for work the commit matcher did not find (a commit that named nothing, or a merge that predates the tracking). These rows carry derived: false, which is what makes them survive every re-prepare — the prepare job rebuilds only the rows it derived itself. A feature cannot be added: it appears automatically as the group header for whatever tasks and bug reports point at it. Items already on the release are silently skipped.

Add work to a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Add work to a release › Request Body

​object[] · minItems: 1 · required

The work to put on this release. An item already on the release is silently skipped, so this is safe to retry.

Add work to a release › Responses

The edges created — an item already on the release yields no row

​ReleaseShippedItemDTO[] · required

Remove hand-added work from a release

DELETE
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/shipped/items/{relationshipId}

Take a hand-added item back off a release. Only works on curated rows: an item DERIVED from the release's commits is rebuilt on the next prepare, so removing it would silently undo itself, and the request is refused with a 400 instead.

Remove hand-added work from a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

relationshipId
​string · required

The shipped-item id, as returned by curatedItems[].relationshipId on GET /shipped

Remove hand-added work from a release › Responses

200

Removed

No data returned

Add features to a release

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/items

Add one or more features to a release. Provide an array of feature IDs. Duplicate features are silently skipped.

Add features to a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Add features to a release › Request Body

featureIds
​string[] · minItems: 1 · required

Add features to a release › Responses

Created items

​ReleaseItemDTO[] · required

Remove a feature from a release

DELETE
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/items/{itemId}

Remove a specific feature from the release by item ID.

Remove a feature from a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

itemId
​string · required

Release Item UUID

Remove a feature from a release › Responses

200

Removed

No data returned

Update a release item

PATCH
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/items/{itemId}

Update a release item › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

itemId
​string · required

Release Item UUID

Update a release item › Request Body

Update a release item › Responses

200

Updated item

​ReleaseItemDTO · required

Reorder release items

PUT
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/items/reorder

Reorder release items › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Reorder release items › Request Body

itemIds
​string[] · minItems: 1 · required

Reorder release items › Responses

200

Reordered items

​ReleaseItemDTO[] · required

List deployments for a release

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/deployments

Returns all deployment records for a release, ordered by date (most recent first).

List deployments for a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

List deployments for a release › Responses

200

List of deployments

​ReleaseDeploymentDTO[] · required

Record a deployment for a release

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/deployments

Record a deployment event for a release. A production deployment recorded as 'deployed' moves the release to 'deployed'. On a release curated by hand (no applications) it also sets the release date and cascades its features to 'stable'. On a release with applications it waits until every application has merged, which makes the release 'released' and its features 'stable'; the release becomes 'deployed' once every merged application's production deployment completed, which a deployment recorded here at an application's merge commit reports.

Record a deployment for a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Record a deployment for a release › Request Body

environment
​string · minLength: 2 · maxLength: 16 · pattern: ^[a-z](?:-?[a-z0-9])… · required

The environment's key: development, production, or one of the workspace's own environments.

commitSha
​string
pullRequestUrl
​string
tagName
​string
deployedById
​string
deployedAt
​string
status
​string · enum
Enum values:
merged
pending
deployed
failed
skipped
rolled_back
buildUrl
​string
​object
notes
​string

Record a deployment for a release › Responses

Created deployment

​ReleaseDeploymentDTO · required

Update a release deployment

PATCH
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/deployments/{deploymentId}

Update a deployment's status, deployedAt timestamp, buildUrl, or notes. Transitioning to 'deployed' on production moves release.status to 'deployed': at once, with its features 'stable', for a release curated by hand; for a release with applications once every application has merged and every merged application's production deployment completed. Until then the deployment is updated and the release waits. Other transitions are presentation-only.

Update a release deployment › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

deploymentId
​string · required

Deployment UUID

Update a release deployment › Request Body

status
​string · enum
Enum values:
merged
pending
deployed
failed
skipped
rolled_back
​
​
​

Update a release deployment › Responses

200

Updated deployment

​ReleaseDeploymentDTO · required

Get the session lineage for a release

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/session-lineage

Reverse-lookup view of features that were emergently touched by sessions linked to this release. Sessions → their task items → tasks → features, grouped by feature with nested sessions and tasks. Informational only — it is independent from the curated release items used for artifact generation. Features may overlap with the release's explicit items.

Get the session lineage for a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Get the session lineage for a release › Responses

200

Session lineage grouped by feature

​ReleaseSessionLineageDTO · required

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/sessions

Assign one or more sessions to a release by setting each session's releaseId. Sessions already linked to this release are silently skipped; sessions linked to a different release will be re-assigned.

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

sessionIds
​string[] · minItems: 1 · required

Updated sessions now linked to the release

​SessionDTO[] · required

DELETE
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/sessions/{sessionId}

Clear the session's releaseId so it is no longer linked to this release. The session itself is not deleted.

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

sessionId
​string · required

Session UUID

200

Unlinked

No data returned

List artifacts for a release

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/artifacts

Returns all generated artifacts for a release, such as changelogs, release notes, marketing announcements, etc.

List artifacts for a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

List artifacts for a release › Responses

200

List of artifacts

​ReleaseArtifactDTO[] · required

Generate an artifact for a release

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/artifacts/generate

Generate an AI-powered artifact (e.g., changelog, release notes, marketing announcement) for a release. Uses the release's lineage data (features, tasks, customer feedback) as context. If an artifact of the specified type already exists, it will be overwritten.

Generate an artifact for a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Generate an artifact for a release › Request Body

type
​string · enum · required
Enum values:
technical_changelog
product_release_notes
marketing_announcement
customer_notification
decision_rationale
sales_enablement
customer_briefing_deck
stakeholder_update

Generate an artifact for a release › Responses

200

Generated artifact

​ReleaseArtifactDTO · required

Get a release artifact by ID

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/artifacts/{artifactId}

Retrieve a single release artifact with its content.

Get a release artifact by ID › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

artifactId
​string · required

Artifact UUID

Get a release artifact by ID › Responses

200

Artifact details

​ReleaseArtifactDTO · required

Delete a release artifact

DELETE
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/artifacts/{artifactId}

Delete a release artifact › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

artifactId
​string · required

Artifact UUID

Delete a release artifact › Responses

200

Deleted

No data returned

Update a release artifact

PATCH
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/artifacts/{artifactId}

Update the content or status (draft, reviewed, published) of a release artifact.

Update a release artifact › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

artifactId
​string · required

Artifact UUID

Update a release artifact › Request Body

​
status
​string · enum
Enum values:
draft
reviewed
published

Update a release artifact › Responses

200

Updated artifact

​ReleaseArtifactDTO · required

List the applications in a release

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/applications

Returns each application being released with its production-vs-development diff (commit count), its pull request, the CI check rollup, and blockReason: why it is not ready to ship, or null when it is. status is skipped for an application with no commits ahead: that is not an error, it simply has nothing to release. commitCount is the true total unless commitCountCapped is true. Then the provider counted only the commits it returned, and the count is a lower bound.

List the applications in a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

List the applications in a release › Responses

200

Applications in the release

​ReleaseApplicationDTO[] · required

Add applications to a release

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/applications

Attach applications to a release, snapshotting each one's repository and branch pair. Does NOT diff or open pull requests — call prepare-release for that. Rejects an application with no connected repository, and one already in another unshipped release.

Add applications to a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Add applications to a release › Request Body

applicationIds
​string[] · minItems: 1 · required

IDs of the Applications to include in this release. Each must have a connected git repository — an application with no repository is rejected.

Add applications to a release › Responses

Applications in the release

​ReleaseApplicationDTO[] · required

Remove an application from a release

DELETE
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/applications/{releaseApplicationId}

Detaches the application and discards its recorded commits. Any pull request already opened for it is left alone on the provider.

Remove an application from a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

releaseApplicationId
​string · required

Release-application UUID — the row linking one application to this release, NOT the Application's own id

Remove an application from a release › Responses

200

Removed

No data returned

List the commits an application is releasing

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/applications/{releaseApplicationId}/commits

The commits between the production and development branches for one application in the release, newest first, as recorded at prepare time. commitsTruncated means the list holds only the newest commits of the range: preparing a very large release stops reading at a time budget. commitCount is the true total unless commitCountCapped is true. Then the provider counted only the commits it returned, and the count is a lower bound.

List the commits an application is releasing › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

releaseApplicationId
​string · required

Release-application UUID — the row linking one application to this release, NOT the Application's own id

List the commits an application is releasing › Responses

200

The application with its commits

​ReleaseApplicationDTO · required

List the individual check runs on one application's pull request

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/applications/{releaseApplicationId}/checks

The live per-check detail for one application in the release — check names, workflow names, status/conclusion and details URLs — proxied straight from the provider (a cached response may be up to 20 s old) and never persisted. The persisted rollup the ship gate reads is refreshed by get-release-checks instead. unavailableReason is set when the provider refused the read, which is not the same as a pull request with no checks at all.

List the individual check runs on one application's pull request › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

releaseApplicationId
​string · required

Release-application UUID — the row linking one application to this release, NOT the Application's own id

List the individual check runs on one application's pull request › Responses

200

The pull request's individual check runs

​PullRequestChecksResultDTO · required

List the deployment jobs of one merged application

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/applications/{releaseApplicationId}/deployment-checks

The CI jobs that deploy one merged application of the release to production, as the Deployments list shows them for its merge: the jobs of the cloud deploy run at the merge commit when one exists (scope: run), else every check on the merge commit (scope: commit). Read live from the provider (a cached result may be up to 20 s old) and never persisted. A GET that writes: once every merged application's production deployment completed without a failure, the release moves from released to deployed. These jobs are shown, never counted in the pull request's checks or the release gate. Answers 404 for an application that is not on the release, and 400 for one that has not merged.

List the deployment jobs of one merged application › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

releaseApplicationId
​string · required

Release-application UUID — the row linking one application to this release, NOT the Application's own id

List the deployment jobs of one merged application › Responses

200

The merged application's deployment jobs

​MergeDeploymentChecksDTO · required

List the changed files of one application's pull request

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/applications/{releaseApplicationId}/files

The files one application's pull request changes, each with its unified diff (patch, null for a binary or very large file) and a risk rating from the application's risk rules, or the default rules when it has none. Read live from the provider (a cached response may be up to 5 s old) and never persisted. truncated is true when the provider returned only part of the list, and totalChangedFiles says how many files the pull request changes. Answers 400 for an application with no pull request.

List the changed files of one application's pull request › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

releaseApplicationId
​string · required

Release-application UUID — the row linking one application to this release, NOT the Application's own id

List the changed files of one application's pull request › Responses

200

The pull request's changed files

​PullRequestFilesResultDTO · required

Read the description of one application's pull request

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/applications/{releaseApplicationId}/description

The description (markdown) of one application's release pull request, read from the Git provider as it is now, never from a cache. editedAt and editedBy say when and by whom it was last saved in Productmind: while they are set, releasing keeps this description instead of writing the release notes into it. Answers 409 for an application with no pull request yet.

Read the description of one application's pull request › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

releaseApplicationId
​string · required

Release-application UUID — the row linking one application to this release, NOT the Application's own id

Read the description of one application's pull request › Responses

200

The pull request's description

​PullRequestDescriptionDTO · required

Edit the description of one application's pull request

PUT
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/applications/{releaseApplicationId}/description

Writes the description of one application's release pull request on the Git provider through the workspace's connection, and records who saved it: releasing then retitles the pull request but keeps this description, and the release notes stay on the release. baseBody is the description the edit started from. When the provider's description has changed since (line endings aside), nothing is written and the answer is a 409 with code pull_request_description_changed carrying the current description in errors.currentBody; saving again against it replaces it. A provider that refuses the edit is a 403 with code pull_request_description_edit_refused quoting the provider. A description over 65,536 characters is a 400; an application with no pull request yet is a 409. A session credential is refused with 403.

Edit the description of one application's pull request › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

releaseApplicationId
​string · required

Release-application UUID — the row linking one application to this release, NOT the Application's own id

Edit the description of one application's pull request › Request Body

body
​string · maxLength: 65536 · required

The new description (markdown). An empty string clears it.

baseBody
​string · maxLength: 1048576 · required

The description the edit started from, as it was read. When the pull request's description has changed since, nothing is written and the answer is a 409 carrying the current description.

Edit the description of one application's pull request › Responses

200

The description the provider now holds

​PullRequestDescriptionDTO · required

Diff, list commits and open the pull requests

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/prepare

For each application in the release: compares the production branch against the development branch, records the commits, and opens a pull request titled with the release id (REL-n — name) (adopting an existing one if the branch pair already has an open PR). A new pull request is opened as the calling person when they have connected their own GitHub, GitLab or Bitbucket account and it can push to the repository, and as the workspace's connection otherwise. Then derives which features are shipping and queues an AI draft of the release notes. Safe to re-run: this is also the refresh action, because the development branch keeps moving. An application whose own pull request was closed gets it re-opened where the provider allows it, and a new one otherwise; applications already merged are left alone. Failures are reported per application, not as a whole-request error. Refused with 409 when every pull request of the release is closed: re-opening the release is what brings them back.

Diff, list commits and open the pull requests › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Diff, list commits and open the pull requests › Request Body

Diff, list commits and open the pull requests › Responses

200

The prepared release

​ReleaseDTO · required

Close every open pull request of a release

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/close

Closes, without merging, the pull request of every application in the release whose pull request is open. Applications with no pull request (no changes, or not prepared yet) and merged ones are left alone. Each pull request is closed through the workspace's git connection and independently: a provider that refuses one does not stop the others, and the response names what closed and, with the provider's own message, what did not. A pull request the provider reports as already closed counts as closed. Nothing is merged or deleted, branches included, and the release keeps its status and its applications; re-open the release to bring the pull requests back. Checks already running keep running on the provider. Refused with 409 while the release is being prepared and when none of its pull requests is open. A person's own login only: a session credential, an MCP client and a service principal are refused with 403.

Close every open pull request of a release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Close every open pull request of a release › Request Body

Close every open pull request of a release › Responses

200

What closed and what did not

​CloseReleaseResult · required

Re-open a release's closed pull requests and refresh it

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/reopen

Brings back every closed pull request of the release, then refreshes the release as prepare-release does: compares the branches again, records the commits, derives the work that shipped and queues a new draft of the release notes. Each application's own pull request is re-opened when the provider allows it, keeping its number, its link and its history. Where it cannot be re-opened, a new pull request is opened from the same branches in its place and the response says which, and why: always on Bitbucket, which never re-opens a declined pull request, and on GitHub or GitLab when the head branch was deleted or rewritten, or another pull request is open for the same branches. Applications are handled independently and reported one by one. Refused with 409 while the release is being prepared and when none of its pull requests is closed. A person's own login only: a session credential, an MCP client and a service principal are refused with 403.

Re-open a release's closed pull requests and refresh it › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Re-open a release's closed pull requests and refresh it › Request Body

Re-open a release's closed pull requests and refresh it › Responses

200

What came back, what was replaced, and what failed

​ReopenReleaseResult · required

Refresh the CI check status of every pull request in the release

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/checks

Re-reads each open pull request's checks and mergeability from the provider, persists the rollup on each application row, and returns the updated applications. A GET that writes: it is the only thing that refills checksState / checksUpdatedAt.

Poll it while any application's checksState is pending, and call it once when a settled rollup has gone stale — a success or failure never changes on its own, so nothing else will ever re-read it.

Refresh the CI check status of every pull request in the release › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Refresh the CI check status of every pull request in the release › query Parameters

force
​boolean

Drop the 20 s cached provider response before reading. Omit it when polling — the cache exists to absorb the poll. Pass it for a human-triggered refresh or any read that gates a merge, where the caller already knows something changed and a 20 s old answer is simply wrong.

Refresh the CI check status of every pull request in the release › Responses

200

Applications with refreshed check rollups

​ReleaseApplicationDTO[] · required

Re-draft the release notes from the recorded commits

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/notes/generate

Queues an AI re-draft of the release notes built from the commits already recorded on the release, held as a reviewable proposal. On blank notes the draft auto-applies; otherwise a release:proposal:updated frame surfaces a diff to review. Never overwrites existing notes without an explicit apply.

Re-draft the release notes from the recorded commits › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Re-draft the release notes from the recorded commits › Request Body

Re-draft the release notes from the recorded commits › Responses

The queued release-notes proposal

​ReleaseNotesProposalDTO · required

List a release's notes proposals

GET
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/notes-proposal

Returns AI-drafted release-notes proposals for a release. Pass activeOnly=true for the single in-flight / awaiting-review proposal.

List a release's notes proposals › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

List a release's notes proposals › query Parameters

activeOnly
​boolean

List a release's notes proposals › Responses

200

Release-notes proposals

​ReleaseNotesProposalDTO[] · required

Apply a release-notes proposal

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/notes-proposal/{proposalId}/apply

Write the reviewer-composed markdown (accepted diff blocks) to the release notes and settle the proposal.

Apply a release-notes proposal › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

proposalId
​string · required

Release-notes proposal UUID

Apply a release-notes proposal › Request Body

description
​string · minLength: 1 · maxLength: 200000 · required

Apply a release-notes proposal › Responses

200

The applied proposal

No data returned

Dismiss a release-notes proposal

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/notes-proposal/{proposalId}/dismiss

Reject the drafted notes wholesale, leaving the current release notes unchanged.

Dismiss a release-notes proposal › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

proposalId
​string · required

Release-notes proposal UUID

Dismiss a release-notes proposal › Responses

200

The dismissed proposal

No data returned

Cancel an in-flight release-notes draft

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/notes-proposal/{proposalId}/cancel

Stop a queued or running draft run, releasing the one-active-proposal slot.

Cancel an in-flight release-notes draft › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

proposalId
​string · required

Release-notes proposal UUID

Cancel an in-flight release-notes draft › Responses

200

The cancelled proposal

No data returned

Release: update the pull request bodies, merge, and tag

POST
https://api.productmind.ai
/workspaces/{workspaceId}/releases/{id}/ship

Writes the release notes into every pull request (a pull request whose description a person edited in Productmind is only retitled: its description is kept), merges them, tags the merged commit with the release id (REL-n), and records a production deployment per application. With releaseApplicationId, only that application is released: its pull request alone is merged, tagged and recorded, so only its repository's CI/CD runs, and the other applications are left as they are; an application that is not on the release is a 404, one already released a 409, and one with no changes a 400. Each pull request is merged as the calling person when they have connected their own GitHub, GitLab or Bitbucket account and the provider lets that account merge it, and as the workspace's connection otherwise; each application records which identity merged it. Blocked unless every application released by the call is checks-green and mergeable, which force overrides. Refused with 409 while a pull request it would merge is closed, force or not: re-open the release first. Applications ship independently: a provider that refuses one merge does not stop the others, and the response reports exactly what merged, what failed and what is still to merge. The release becomes released, and its features stable, once no application is left to merge, whichever call merged the last one; it becomes deployed once every merged application's production deployment completed. A person's own login only: a session credential, an MCP client and a service principal are refused with 403.

Release: update the pull request bodies, merge, and tag › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Release UUID

Release: update the pull request bodies, merge, and tag › Request Body

force
​boolean

Merge every application whose pull request the provider will accept, even when checks are not green. Skips the CI gate but NOT the provider's own branch protection — a merge the provider refuses still fails and is reported per application.

releaseApplicationId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

Release this application only: the release-application id, as the release's applications list returns it. Only its pull request is merged and tagged, so only its repository's CI/CD runs, and the other applications are left as they are. The release stays in_progress until every application has merged. Omitted, every application not merged yet is released.

Release: update the pull request bodies, merge, and tag › Responses

200

What merged, what failed, and whether the release is now released

​ShipReleaseResult · required