Productmind API

CreateAgentContextBody

title
​string · minLength: 1 · required
type
​string · enum
Enum values:
context
skill
Default: context
​
​
​
​
sortOrder
​integer · min: 0 · max: 9007199254740991

UpdateAgentContextBody

type
​string · enum
Enum values:
context
skill
title
​string · minLength: 1
​
​
​
​
sortOrder
​integer · min: 0 · max: 9007199254740991

CreateAgentDefinitionBody

slug
​string · minLength: 2 · maxLength: 64 · pattern: ^[a-z0-9]+(-[a-z0-9]… · required

Unique per workspace. Immutable after creation — it IS the agent_id.

name
​string · minLength: 1 · maxLength: 200 · required
instructions
​string · minLength: 1 · maxLength: 32000 · required

The agent's SYSTEM PROMPT — who it is and how it works. Per-run data arrives as the invocation's input and context, never from here.

​
enabled
​boolean
Default: true
Default: {"tier":"quick"}
tools
​string[] · maxItems: 100

Tool registry keys. Validated against the live catalog on write.

Default: []
​AgentDefinitionMcpServer[] · maxItems: 10
Default: []
Default: {}
toolsRequiringApproval
​string[] · maxItems: 100
Default: []
​

AgentDefinitionModel

tier
​string · enum

Model capability class — quick, standard, top or ultra. Ignored when id is set.

Enum values:
quick
standard
top
ultra
id
​string · minLength: 1 · maxLength: 200

Explicit model id for the active LLM provider; a Bedrock-style id is normalized on the Anthropic API. Beats tier.

temperature
​number · min: 0 · max: 1
maxTokens
​integer · max: 200000
thinkingEnabled
​boolean
thinkingEffort
​string · enum
Enum values:
low
medium
high
max
xhigh
promptCaching
​boolean

AgentDefinitionMcpServer

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · kind="productmind" · requires: id
type = object · kind="integration" · requires: id, instanceId
type = object · kind="http" · requires: id, url
Properties for Variant 1:
id
​string · minLength: 1 · maxLength: 64 · required

Identifier for this server within the definition. Never used as a shared cache key.

kind
​string · const · required
Const value: productmind
allowedTools
​string[] · maxItems: 200

Tool-name globs to load from this server. Required for the asynchronous path — an absent list means 'everything this server exposes', which cannot be validated at publish time.

rejectedTools
​string[] · maxItems: 200

Tool-name globs to exclude, applied after allowedTools and on top of the global rejections.

ProductmindMcpServer

id
​string · minLength: 1 · maxLength: 64 · required

Identifier for this server within the definition. Never used as a shared cache key.

kind
​string · const · required
Const value: productmind
allowedTools
​string[] · maxItems: 200

Tool-name globs to load from this server. Required for the asynchronous path — an absent list means 'everything this server exposes', which cannot be validated at publish time.

rejectedTools
​string[] · maxItems: 200

Tool-name globs to exclude, applied after allowedTools and on top of the global rejections.

IntegrationMcpServer

id
​string · minLength: 1 · maxLength: 64 · required

Identifier for this server within the definition. Never used as a shared cache key.

kind
​string · const · required
Const value: integration
instanceId
​string · minLength: 1 · maxLength: 128 · required

Workforce instance id of an MCP integration already attached to this workspace.

allowedTools
​string[] · maxItems: 200

Tool-name globs to load from this server. Required for the asynchronous path — an absent list means 'everything this server exposes', which cannot be validated at publish time.

rejectedTools
​string[] · maxItems: 200

Tool-name globs to exclude, applied after allowedTools and on top of the global rejections.

HttpMcpServer

id
​string · minLength: 1 · maxLength: 64 · required

Identifier for this server within the definition. Never used as a shared cache key.

kind
​string · const · required
Const value: http
url
​string · uri · required

The MCP server endpoint. Our infrastructure connects outbound to it, unauthenticated.

allowedTools
​string[] · maxItems: 200

Tool-name globs to load from this server. Required for the asynchronous path — an absent list means 'everything this server exposes', which cannot be validated at publish time.

rejectedTools
​string[] · maxItems: 200

Tool-name globs to exclude, applied after allowedTools and on top of the global rejections.

transport
​string · const
Const value: http
Default: http

AgentDefinitionSettings

maxTurns
​integer · max: 50

Cap on agent-loop turns. The bound on how long a tool-using run can iterate.

maxTotalTokens
​integer · max: 2000000

Cap on tokens processed per run, including cache reads and writes; not cost-weighted.

AgentDefinitionKbFilters

includeTags
​string[] · maxItems: 50
excludeTags
​string[] · maxItems: 50

UpdateAgentDefinitionBody

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

The agent's SYSTEM PROMPT — who it is and how it works. Per-run data arrives as the invocation's input and context, never from here.

enabled
​boolean
tools
​string[] · maxItems: 100

Tool registry keys. Validated against the live catalog on write.

​AgentDefinitionMcpServer[] · maxItems: 10
toolsRequiringApproval
​string[] · maxItems: 100
​
version
​integer · max: 9007199254740991

ExecuteAgentDefinitionBody

input
​string · maxLength: 50000

The per-run instruction. Leads the user message. Omit it for an agent whose instructions already describe the whole job.

​AgentTrigger

What caused this run. Rendered after input. Defaults to a by-hand trigger.

AgentTrigger

anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: entityType, entityId, event
type = object · requires: kind
Properties for Variant 1:
entityType
​string · enum · required

Which entity the event happened to.

Enum values:
feature_request
bug_report
feature
task
application
knowledge_base_document
system_component
note
entityId
​string · minLength: 1 · required

The entity's id — never the entity itself.

event
​string · enum · required

Past tense: the fact that already happened.

Enum values:
created
created_bulk
updated
status_changed
assigned
promoted
deleted
kind
​string · const
Const value: entity
changedFields
​string[] · minItems: 1 · maxItems: 50

Which of the entity's fields this event changed, named as the API spells them.

AgentEntityTrigger

entityType
​string · enum · required

Which entity the event happened to.

Enum values:
feature_request
bug_report
feature
task
application
knowledge_base_document
system_component
note
entityId
​string · minLength: 1 · required

The entity's id — never the entity itself.

event
​string · enum · required

Past tense: the fact that already happened.

Enum values:
created
created_bulk
updated
status_changed
assigned
promoted
deleted
kind
​string · const
Const value: entity
changedFields
​string[] · minItems: 1 · maxItems: 50

Which of the entity's fields this event changed, named as the API spells them.

AgentWokenTrigger

​required

schedule for a cron tick, manual for a by-hand run. Neither carries an entity.

automation
​string · minLength: 1 · maxLength: 200

The rule's name, as prose for the model. Absent when no automation is behind the run.

cadence
​string · minLength: 1 · maxLength: 200

Plain-language schedule, e.g. Every day at 09:00 (UTC). Present whenever the rule has one, including a by-hand test of a scheduled rule.

CreateAutomationBody

name
​string · minLength: 1 · maxLength: 120 · required
​AutomationTrigger · required
​AutomationAction · required
​
Default: {}
runAsUserId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

Defaults to the calling user.

AutomationTrigger

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: type, eventType
type = object · requires: type, frequency, timezone
type = object · requires: type
Properties for Variant 1:
type
​string · const · required
Const value: event
eventType
​string · enum · required

A workspace event this automation reacts to, e.g. bug_report.created.

Enum values:
feature.created
feature.updated
feature.status_changed
feature_request.created
feature_request.updated
feature_request.status_changed
feature_request.promoted
bug_report.created

AutomationConditions

combinator
​string · enum · required
Enum values:
and
or
​AutomationConditionNode[] · maxItems: 10 · required

AutomationConditionNode

anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: field, operator
type = object · requires: combinator, children
Properties for Variant 1:
field
​string · minLength: 1 · maxLength: 100 · required

A field declared for this trigger's event by automationConditionFields.

operator
​string · enum · required
Enum values:
equals
notEquals
contains
in
isEmpty
isNotEmpty
changed
changedTo
​

AutomationCondition

field
​string · minLength: 1 · maxLength: 100 · required

A field declared for this trigger's event by automationConditionFields.

operator
​string · enum · required
Enum values:
equals
notEquals
contains
in
isEmpty
isNotEmpty
changed
changedTo
​

AutomationConditionGroup

combinator
​string · enum · required
Enum values:
and
or
​AutomationConditionNode[] · minItems: 1 · maxItems: 10 · required

AutomationAction

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: type, agentSlug, input
Properties for Variant 1:
type
​string · const · required
Const value: runAgent
agentSlug
​string · minLength: 2 · maxLength: 64 · pattern: ^[a-z0-9]+(-[a-z0-9]… · required

The agent definition to run. Must resolve, be enabled and be async-eligible.

input
​string · maxLength: 5000 · required

The per-run instruction, as a template over {{entity.id}}, {{entity.key}}, {{entity.title}}, {{entity.status}}, {{event}}, {{actor.name}} and {{changes.<field>.to}} / .from. Unknown placeholders render empty and are recorded as warnings on the run.

AutomationLimits

maxRunsPerHour
​integer · min: -9007199254740991 · max: 9007199254740991

Runs per hour for this automation, clamped to [1, 200]. Defaults to 50. Counted with an indexed query, and it FAILS CLOSED.

UpdateAutomationBody

name
​string · minLength: 1 · maxLength: 120
​
enabled
​boolean
runAsUserId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

RunAutomationBody

entityId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
entityType
​string · enum
Enum values:
feature
feature_request
bug_report
task
changedFields
​string[] · maxItems: 10
input
​string · maxLength: 5000
force
​boolean

CheckAutomationBody

entityId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
entityType
​string · enum
Enum values:
feature
feature_request
bug_report
task
changedFields
​string[] · maxItems: 10

BulkDeleteAutomationRunsBody

ids
​string[] · minItems: 1 · maxItems: 200 · required

CreateCommentBody

entity
​string · enum · required
Enum values:
feature
task
feature_request
bug_report
session
customer_research
release
knowledge_base_document
entityId
​string · minLength: 1 · required
content
​string · minLength: 1 · required
kind
​string · enum

Omit for a plain comment. A coding agent replying to a comment passes agent_response. agent_action and system are written by Productmind itself and refused here.

Enum values:
comment
agent_action
agent_response
system
​CommentAnchor
parentCommentId
​string
codeAccess
​boolean

App only - omit. On a comment that asks PM (@pm) on a feature or component specification: true has a read-only coding agent answer instead, from the feature's code, as a coding run.

CommentAnchor

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: type, startNodeKey, startOffset +3 more
type = object · requires: type, pullRequestUrl, pullRequestNumber +4 more
type = object · requires: type, port, pagePath +4 more
Properties for Variant 1:
type
​string · const · required
Const value: range
startNodeKey
​string · required
startOffset
​integer · min: 0 · max: 9007199254740991 · required
endNodeKey
​string · required
endOffset
​integer · min: 0 · max: 9007199254740991 · required
snippet
​string · required
prefix
​string
suffix
​string
textStart
​integer · min: 0 · max: 9007199254740991
textEnd
​integer · min: 0 · max: 9007199254740991

UpdateCommentBody

content
​string · minLength: 1
​

EditDocumentPassageBody

summary
​string · minLength: 1 · maxLength: 300 · required

One line on what you changed, shown with the edit in the thread.

​object[] · minItems: 1 · maxItems: 20

The change, as exact find-and-replace edits on the highlighted blocks' current text (the markdown your turn input shows under "The highlighted blocks"), applied in order, all or none. Each find is copied exactly (same characters, spacing and line breaks) from those blocks and occurs exactly once in them: include enough surrounding text to make it unique. replace is the new text. Only those blocks can change. Prefer this over content.

content
​string · minLength: 1 · maxLength: 40000

The highlighted blocks' WHOLE new markdown, only when the thread asks to rewrite all of them. It replaces those blocks, never anything else. Never send it with edits.

ResolveCommentBody

resolved
​boolean · required

CreateDecisionBody

entity
​string · enum · required
Enum values:
feature_request
feature
entityId
​string · minLength: 1 · required
decisionType
​string · enum · required
Enum values:
transition
general
outcome
​string · enum · required
Enum values:
approved
rejected
deferred
conditional
title
​string
rationale
​string
conditionalNotes
​string
decidedByUserId
​string
decidedByName
​string
supersedesId
​string
citedInterestIds
​string[]

RequestPolymorphicAttachmentUploadBody

entity
​string · enum · required
Enum values:
feature
task
feature_request
bug_report
session
customer_research
customer_interaction
release
entityId
​string · minLength: 1 · required
fileName
​string · minLength: 1 · required
contentType
​string · enum · required
Enum values:
image/jpeg
image/png
image/gif
image/webp
image/svg+xml
application/pdf
application/msword
application/vnd.openxmlformats-officedocument.wordprocessingml.document
fileSize
​number · required
description
​string · maxLength: 1000

UpdateAttachmentBody

​required

New description for the attachment. Pass null to clear it.

CreateWorkspaceInput

name
​string · minLength: 1 · required
description
​string · minLength: 1 · required

UpdateWorkspaceInput

name
​string · minLength: 1 · maxLength: 255
description
​string · minLength: 1

ProductConfigUpdate

​object

CreateFeatureBody

title
​string · minLength: 1 · required

A short sentence-case noun phrase in the vocabulary a product manager and a developer both use unchanged — the domain concept, plus the operation nominalised onto it where the concept alone does not name the capability. Password reset, not Resetting a forgotten password; Customer management, not Managing customers and not a bare Customer. No articles, possessives or imperatives, and no implementation words (service, handler, worker, API) unless the product's own user-facing wording uses them. The same register at every level: a parent names a broader concept, not a different kind of word.

parentFeatureId
​string
kind
​string · enum

component for a unit that owns code and therefore owns business rules — a screen, a service module, a background worker, or the shared code a domain's capabilities have in common. feature for the business capability above it, whose description is composed from its components. domain ONLY for a named collection that organises features: it is purely organisational, owns no code, composes nothing and is never scanned. A person makes one; a catalogue scan makes one only when its instructions say the workspace's catalogue shape is domains, features and capabilities. In every other case a scan must never mint one, and when cataloguing you should treat every container as a feature. A child may not be broader than its parent (nothing above a component, no domain under a feature). When in doubt, ask whether a deep read of this row alone would have specific files to open — if not, it is a feature.

Enum values:
domain
feature
component
description
​string

Markdown, at most 200,000 characters.

priority
​string · enum
Enum values:
low
high
critical
requestingAccountId
​string
requestingContactId
​string
ownerId
​string

Assign ONE user by UUID (legacy single-assignee field, historically the feature's 'owner'). Use assignees to assign several people or a team.

​AssignmentTargetInput[] · maxItems: 20

REPLACES the item's whole assignee set: every user and team listed becomes an assignee, everything not listed is unassigned. Pass [] to unassign everyone. When both this and the legacy single-user field (assigneeId / ownerId) are supplied, this wins. Find a team's id with list-teams and a person's with list-assignable-users.

estimatedEffort
​string · enum
Enum values:
__none__
xs
s
m
l
xl
targetDate
​string
sortOrder
​number
position
​string · enum

Where to place the feature among its siblings (same parent) when sortOrder is not supplied. end appends it below the last sibling, start puts it above the first. Ignored when an explicit sortOrder is given.

Enum values:
start
end
externalSource
​string
externalId
​string
externalSourceUrl
​string · uri

AssignmentTargetInput

entityType
​string · enum · required

user or team.

Enum values:
user
team
id
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required

The user's or the team's UUID.

FindFeaturesByCodePathsBody

​object[] · minItems: 1 · maxItems: 20 · required

One entry per repository you changed. One call covers every repository.

BulkCreateFeaturesBody

​CreateFeatureBody[] · minItems: 1 · maxItems: 200 · required

UpdateFeatureStatusInput

status
​string · enum · required
Enum values:
backlog
planned
in_development
stable
deprecated

InlineStatusDecision

outcome
​string · enum · required
Enum values:
approved
rejected
deferred
conditional
title
​string
rationale
​string
conditionalNotes
​string
supersedesId
​string
citedInterestIds
​string[]

ReorderFeatureInput

sortOrder
​number · required

Position among the new siblings, 0-based. The server re-indexes the rest of that sibling list around it, and re-indexes the old siblings too when the parent changes.

​

Where the feature lands: a feature id nests it under that parent, null promotes it to the top level, and omitting the key leaves the current parent alone. A move that would make a feature its own ancestor is rejected.

CreateFeatureLogBody

content
​string · minLength: 1 · required

UpdateFeatureLogBody

content
​string · minLength: 1 · required

UpdateFeatureInput

kind
​string · enum

component for a unit that owns code and therefore owns business rules — a screen, a service module, a background worker, or the shared code a domain's capabilities have in common. feature for the business capability above it, whose description is composed from its components. domain ONLY for a named collection that organises features: it is purely organisational, owns no code, composes nothing and is never scanned. A person makes one; a catalogue scan makes one only when its instructions say the workspace's catalogue shape is domains, features and capabilities. In every other case a scan must never mint one, and when cataloguing you should treat every container as a feature. A child may not be broader than its parent (nothing above a component, no domain under a feature). When in doubt, ask whether a deep read of this row alone would have specific files to open — if not, it is a feature.

Enum values:
domain
feature
component
​

Which plane a COMPONENT's code sits in. Derived from the node's FILES by a catalogue run — do not guess it: leave the field out unless you are mirroring a scan's own classification or a human's explicit choice. Null clears it, which is correct for a container that owns no code and for any feature (a feature spans layers and carries no layer, ever).

title
​string

A short sentence-case noun phrase in the vocabulary a product manager and a developer both use unchanged — the domain concept, plus the operation nominalised onto it where the concept alone does not name the capability. Password reset, not Resetting a forgotten password; Customer management, not Managing customers and not a bare Customer. No articles, possessives or imperatives, and no implementation words (service, handler, worker, API) unless the product's own user-facing wording uses them. The same register at every level: a parent names a broader concept, not a different kind of word.

description
​string

Markdown, at most 200,000 characters. Replaces the whole description: send it only with the complete new text. To change part of the description, send descriptionEdits instead.

​object[] · minItems: 1 · maxItems: 50

Change PART of the description without resending it: a list of exact find-and-replace edits the server applies to the stored description, in order, all or none. Each find must be copied exactly (same characters, spacing and line breaks) from the description as it stands, and must occur exactly once there at that point: include enough surrounding text to make it unique. replace is the new text (an empty string deletes the passage). Everything outside the passages is kept as it is. Prefer this over description for any change to a long description, and always when your read of the description was cut. Cannot be sent together with description.

priority
​string · enum
Enum values:
low
high
critical
status
​string · enum
Enum values:
backlog
planned
in_development
stable
deprecated
​
​
​
​

Set the single USER assignee (legacy 'owner' field): replaces the feature's user assignees with this one, null unassigns every user. Team assignees are left untouched — use assignees to change them.

​AssignmentTargetInput[] · maxItems: 20

REPLACES the item's whole assignee set: every user and team listed becomes an assignee, everything not listed is unassigned. Pass [] to unassign everyone. When both this and the legacy single-user field (assigneeId / ownerId) are supplied, this wins. Find a team's id with list-teams and a person's with list-assignable-users.

​
​
sortOrder
​number

RenameFeatureVersionBody

​required

LinkFeatureApplicationBody

applicationId
​string · minLength: 1 · required
codePaths
​string[] · maxItems: 200

Repository-relative paths that implement this feature, most important first: entry-point files, service/domain logic, validators and guards, the constants holding literal values, the data model, UI surfaces and the tests that pin the behaviour. A directory is fine when the whole directory implements the capability; narrow a shared file with a symbol (src/routes/api.ts#createBooking). Five to forty entries is normal — src/ alone is worse than useless. Passing this key REPLACES the stored list; omitting it leaves the stored list untouched.

entryPoints
​string[] · maxItems: 200

Exactly the entry points attributed to this feature, one per array entry, each as " — path:line" (POST /bookings — src/booking/booking.routes.ts:42, cron: reap-previews — src/jobs/reaper.ts:18). A path is not an entry point: the deep dive checks that every entry point listed here appears as its own contract block in the spec it writes. Passing this key REPLACES the stored list.

layer
​string · enum

Which layer this feature occupies IN THIS application — frontend, backend, data or external. Set by the workspace feature map, which is the only pass that sees several repositories at once and can therefore say a feature starts in a web app and ends in a database. Passing this key REPLACES the stored value; omitting it leaves it untouched, so a plain UI link can never blank it.

Enum values:
frontend
backend
data
external
capabilityNotes
​string · maxLength: 2000

One to three sentences the deep-dive agent reads before it starts: whether this is a domain parent and which cross-cutting concerns it owns, where the rule-dense code is, which feature it is easily confused with, and anything surprising noticed but not pursued. A handover note, not a summary — do not repeat the description here.

FeatureApplicationManualSurfaceBody

manualCodePaths
​string[] · maxItems: 200
manualEntryPoints
​string[] · maxItems: 200
hiddenCodePaths
​string[] · maxItems: 200
manualSystemComponentIds
​string[] · maxItems: 50
hiddenSystemComponentIds
​string[] · maxItems: 50

LinkFeatureDependencyBody

targetFeatureId
​string · minLength: 1 · required

The feature this one builds on — the direction is <this feature> uses <target>: it calls the target's API, consumes a queue the target fills, or reads data the target owns. Mutual coupling is two separate calls, one in each direction. Linking an already-linked pair is safe and REPLACES the stored rationale/evidence.

rationale
​string · maxLength: 500

One sentence naming the MECHANISM of the dependency ("reads the bookings table BookingLedger owns", "calls POST /payments on checkout") — never a restatement that the two are related. Rendered to humans curating the map.

evidence
​string[] · maxItems: 20

Code locations proving the edge, each as "/:" — repo-prefixed because the two features usually live in different repositories.

SubmitBusinessRulesBody

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

A UUID you mint for this submit wave and reuse on a retry. Re-sending the same batch replaces it rather than doubling it, which is what makes a lost response safe to repeat.

​object[] · minItems: 1 · maxItems: 40 · required

Up to 40 rules. Submit in waves as you write them, checking each wave's evidence while the files are still open, rather than accumulating the whole set for one call.

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

The scan session producing these rules, when there is one.

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

The description proposal these rules accompany, when there is one.

final
​boolean

True on the last wave. Promotes every wave of this batch to the component's applied rule set in one step, so a partial submit never half-replaces what is live.

FeatureBusinessRuleCitationDTO

label
​string · required
repoName
​string · required
sha
​string · required
path
​string · required
​required
​required

PromoteBusinessRulesBody

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

The batch to make this component's applied rule set.

ProposeFeatureDescriptionBody

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

The FULL replacement description markdown for the feature. Code citations are link tokens — path/to/file.ext:line @ — never wrapped in backticks; the sha is the HEAD of the clone you read.

summary
​string · maxLength: 8000

One-paragraph summary of what changed and why

sessionId
​string

The scan session id (from the Context section of your instructions)

​

REQUIRED by the deep-read instructions: either the Knowledge Base document ids you created for this feature's technical architecture (API contracts, data layers, databases, queues, execution models, state managers), or an explicit reason none was needed.

commentId
​string

When you answer a comment thread on this feature's document (your turn input names it): the thread's id, exactly as given. The suggestion is then linked to the thread, and applying it resolves the thread. Only the thread you were asked to answer, while you answer it; omit it otherwise.

ApplyFeatureDescriptionProposalBody

description
​string · minLength: 1 · maxLength: 200000 · required
draftVersion
​integer · min: 0 · max: 9007199254740991

ApproveFeatureDescriptionProposalBody

description
​string · minLength: 1 · maxLength: 200000 · required
draftVersion
​integer · min: 0 · max: 9007199254740991

ProposeFeatureStructureBody

parentTitle
​string · minLength: 1 · maxLength: 300

New title for THIS feature, retitled as a high-level domain parent (e.g. 'Finance'). Omit to keep the current title. A short sentence-case noun phrase in the vocabulary a product manager and a developer both use unchanged — the domain concept, plus the operation nominalised onto it where the concept alone does not name the capability. Password reset, not Resetting a forgotten password; Customer management, not Managing customers and not a bare Customer. No articles, possessives or imperatives, and no implementation words (service, handler, worker, API) unless the product's own user-facing wording uses them. The same register at every level: a parent names a broader concept, not a different kind of word.

parentDescriptionMarkdown
​string · maxLength: 200000

New HIGH-LEVEL description for THIS feature as the domain parent — what the domain does and the sub-capabilities it contains. Omit to keep the current description.

​object[] · maxItems: 20

Ordered NEW subfeatures to create under this feature, each with its own full detailed spec.

Default: []
​

Optionally re-parent THIS feature. Pass an existing feature id to move it under that parent, or null to promote it to a ROOT feature (use this for a domain wrongly filed under an era/technology bucket). Omit the key entirely to leave it where it is — null and omitted mean different things.

summary
​string · maxLength: 8000

One-paragraph summary of the proposed restructure and why.

sessionId
​string

The scan session id (from the Context section of your instructions).

ApplyFeatureStructureProposalBody

parentTitle
​string · minLength: 1 · maxLength: 300
parentDescriptionMarkdown
​string · maxLength: 200000
​object[] · maxItems: 20
Default: []
​

CreateFeatureRequestBody

title
​string · minLength: 1 · required
description
​string · minLength: 1 · required

Markdown, at most 200,000 characters.

source
​string · enum · required

What KIND of request this is, e.g. customer_feedback for something customers ask for. It does not record WHO asked: pass the people in interests.

Enum values:
internal_stakeholders
customer_feedback
market_signal
strategic_directive
support_pattern
competitive_intelligence
priority
​string · enum
Enum values:
low
high
critical
estimatedEffort
​string · enum
Enum values:
__none__
xs
s
m
l
xl
sortOrder
​number
​CreateManualInterestBody[] · maxItems: 20

Optional. Who asked for this request, recorded as interest in the same call: each entry is exactly the body add-feature-request-interest takes. A customer is { requestingContactId } (find the contact with list-contacts, or add someone not on file yet with create-contact; their account comes with them). This is what counts the demand on the request and files it under the customer's account: a name written into the description counts nothing. Every entry is checked before anything is written, so an unknown contact rejects the whole call and creates nothing. Needs permission to update feature requests. At most 20.

CreateManualInterestBody

source
​string · enum

Who this interest speaks for. Defaults to customer_feedback, which needs requestingContactId. internal_stakeholders is a teammate (set stakeholderRole). competitive_intelligence, market_signal, strategic_directive and support_pattern are other input: no contact, and you are recorded as who added it. Ignored when stakeholderRole is set.

Enum values:
internal_stakeholders
customer_feedback
market_signal
strategic_directive
support_pattern
competitive_intelligence
description
​string · maxLength: 2000

What they want or said, in their words where you have them, e.g. "Needs SSO before the Q3 rollout."

sentiment
​string · enum

How the person feels about the request, when known.

Enum values:
negative
neutral
positive
requestingContactId
​string

The UUID of the customer contact who asked (find it with list-contacts; each row's id is this value). Someone who is not on file yet is added with create-contact, whose id is this value too. Required for a customer interest. The contact's account is attached automatically, so there is no account field. A contact outside this workspace's organization is rejected.

position
​string · enum

Their stance: supporting, neutral, opposing, or conditional (then say the condition in conditionalNotes). Mostly for teammates and other input.

Enum values:
supporting
opposing
neutral
conditional
conditionalNotes
​string · maxLength: 2000

The condition behind a conditional position, e.g. "Only if it ships with SSO."

stakeholderRole
​string · enum

Set this to record a TEAMMATE's interest instead of a customer's: the interest becomes internal_stakeholders, whatever source says. Name the teammate with stakeholderUserId or stakeholderName; with neither, it is recorded as yours.

Enum values:
marketing
leadership
engineering
design
sales
customer_support
customer_engineering
finance
stakeholderUserId
​string

The workspace member the teammate interest is from (a user UUID). Takes precedence over stakeholderName.

stakeholderName
​string · maxLength: 200

The teammate's name as free text, for someone who is not a workspace member.

weight
​number

Optional relative weight of this interest. Leave it unset unless the user gives one.

UpdateFeatureRequestStatusInput

status
​string · enum · required
Enum values:
new
in_review
rejected
merged
promoted

MergeFeatureRequestsBody

sourceIds
​string[] · minItems: 1 · required
targetId
​string · minLength: 1 · required

BulkPromoteFeatureRequestsBody

ids
​string[] · minItems: 1 · required
featureId
​string · minLength: 1 · required

PromoteFeatureRequestBody

featureId
​string · minLength: 1 · required

BulkPromoteFeatureRequestsToTaskBody

ids
​string[] · minItems: 1 · required

Feature request UUIDs

featureId
​string

Optional parent Feature UUID applied to every created task.

PromoteFeatureRequestToTaskBody

title
​string

Task title. Defaults to the feature request's title.

description
​string

Task description, markdown. Defaults to the feature request's description.

featureId
​string

Optional parent Feature UUID. Omit to create a workspace-level task with no feature.

LinkInteractionInterestBody

interactionId
​string · minLength: 1 · required

The UUID of the customer meeting or conversation to record as interest (find it with list-customer-interactions). Its contact, account, sentiment and summary are copied onto the interest.

UpdateFeatureRequestInterestBody

description
​string · maxLength: 2000
sentiment
​string · enum
Enum values:
negative
neutral
positive
position
​string · enum
Enum values:
supporting
opposing
neutral
conditional
conditionalNotes
​string · maxLength: 2000
weight
​number

CreateFeatureRequestLogBody

content
​string · minLength: 1 · required

UpdateFeatureRequestLogBody

content
​string · minLength: 1 · required

CreateFeatureRequestRelationshipBody

targetType
​string · enum · required
Enum values:
application
feature
targetId
​string · minLength: 1 · required
relationshipType
​string

UpdateFeatureRequestInput

title
​string
description
​string

Markdown, at most 200,000 characters. Replaces the whole description: send it only with the complete new text. To change part of the description, send descriptionEdits instead.

​object[] · minItems: 1 · maxItems: 50

Change PART of the description without resending it: a list of exact find-and-replace edits the server applies to the stored description, in order, all or none. Each find must be copied exactly (same characters, spacing and line breaks) from the description as it stands, and must occur exactly once there at that point: include enough surrounding text to make it unique. replace is the new text (an empty string deletes the passage). Everything outside the passages is kept as it is. Prefer this over description for any change to a long description, and always when your read of the description was cut. Cannot be sent together with description.

priority
​string · enum
Enum values:
low
high
critical
status
​string · enum
Enum values:
new
in_review
rejected
merged
promoted
​
sortOrder
​number
​

Set the single USER assignee (legacy-shaped field): replaces the request's user assignees with this one, null unassigns every user. Team assignees are left untouched — use assignees to change them.

​AssignmentTargetInput[] · maxItems: 20

REPLACES the item's whole assignee set: every user and team listed becomes an assignee, everything not listed is unassigned. Pass [] to unassign everyone. When both this and the legacy single-user field (assigneeId / ownerId) are supplied, this wins. Find a team's id with list-teams and a person's with list-assignable-users.

DescribeFeatureRequestBody

source
​string · enum

How the run was triggered (auto on image upload / manual button)

Enum values:
auto
manual

ApplyFeatureRequestDescriptionProposalBody

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

CreateBugReportBody

title
​string · minLength: 1 · required
description
​string

Markdown, at most 200,000 characters.

priority
​string · enum
Enum values:
low
high
critical
severity
​string · enum
Enum values:
minor
major
critical
blocker
reporterType
​string · enum
Enum values:
workspace_member
contact
reporterId
​string
reporterDetails
​string
assigneeId
​string

Assign ONE user by UUID (the legacy single-assignee field). Use assignees to assign several people or a team.

​AssignmentTargetInput[] · maxItems: 20

REPLACES the item's whole assignee set: every user and team listed becomes an assignee, everything not listed is unassigned. Pass [] to unassign everyone. When both this and the legacy single-user field (assigneeId / ownerId) are supplied, this wins. Find a team's id with list-teams and a person's with list-assignable-users.

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

The Conversation id from your context. Pass it when you are creating this from a conversation so the images the user attached travel onto the item.

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

Optional. UUID of the Feature this bug affects (resolve a FEAT-n with search-entities). Links the new report to it in the same call, exactly as create-bug-report-relationship would: the report lands on that feature's bug list, and if it is created with no assignee it is handed to the feature's owners. An id that is not a feature in this workspace rejects the whole call and creates nothing.

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

Optional. UUID of the Application where the bug was observed (resolve an APP-n with search-entities). Linked in the same call. An application link never assigns anyone. An unknown id rejects the whole call and creates nothing.

BulkDeleteBugReportsBody

ids
​string[] · minItems: 1 · required

MergeBugReportsBody

sourceIds
​string[] · minItems: 1 · required
targetId
​string · minLength: 1 · required

CreateBugReportReporterBody

reporterType
​string · enum
Enum values:
workspace_member
contact
reporterId
​string
details
​string · maxLength: 2000

UpdateBugReportReporterBody

details
​string · maxLength: 2000

ConvertBugReportBody

targetType
​string · enum · required

What to convert this bug report into. task for tracked engineering work, feature for a roadmap item the defect revealed as a gap, feature_request for a customer demand signal. The report is closed on success, gains a system comment naming the new entity, and the new entity links back to it.

Enum values:
task
feature
feature_request
title
​string

Override the new entity's title. Defaults to the bug report's title.

description
​string

Override the new entity's description (markdown). Defaults to the bug report's description; for a feature_request with a blank description the title is used, because that field is required there.

priority
​string · enum

Override the new entity's priority. Defaults to the bug report's priority.

Enum values:
low
high
critical

CreateBugReportRelationshipBody

targetType
​string · enum · required

What targetId names. feature: the product area the bug affects. This is the usual link: the report then shows on that feature's bug list and lineage, and an unassigned report is handed to the feature's owners. application: where the bug was observed. task: related engineering work.

Enum values:
application
feature
task
targetId
​string · minLength: 1 · required

UUID of that feature, application or task in this workspace. Resolve a FEAT-n / COMP-n / APP-n / TASK-n handle with search-entities first.

relationshipType
​string

Ignored: every link made here is stored as related_to. Omit it.

UpdateBugReportInput

title
​string
description
​string

Markdown, at most 200,000 characters. Replaces the whole description: send it only with the complete new text. To change part of the description, send descriptionEdits instead.

​object[] · minItems: 1 · maxItems: 50

Change PART of the description without resending it: a list of exact find-and-replace edits the server applies to the stored description, in order, all or none. Each find must be copied exactly (same characters, spacing and line breaks) from the description as it stands, and must occur exactly once there at that point: include enough surrounding text to make it unique. replace is the new text (an empty string deletes the passage). Everything outside the passages is kept as it is. Prefer this over description for any change to a long description, and always when your read of the description was cut. Cannot be sent together with description.

priority
​string · enum
Enum values:
low
high
critical
severity
​string · enum
Enum values:
minor
major
critical
blocker
status
​string · enum
Enum values:
open
in_review
confirmed
in_progress
resolved
closed
merged
​

Set the single USER assignee (legacy field): replaces the report's user assignees with this one, null unassigns every user. Team assignees are left untouched — use assignees to change them.

​AssignmentTargetInput[] · maxItems: 20

REPLACES the item's whole assignee set: every user and team listed becomes an assignee, everything not listed is unassigned. Pass [] to unassign everyone. When both this and the legacy single-user field (assigneeId / ownerId) are supplied, this wins. Find a team's id with list-teams and a person's with list-assignable-users.

tags
​string[]
sortOrder
​number

DescribeBugReportBody

source
​string · enum

How the run was triggered (auto on image upload / manual button)

Enum values:
auto
manual

ApplyBugReportDescriptionProposalBody

description
​string · minLength: 1 · maxLength: 200000 · required
​object[] · maxItems: 8

StartTaskWorkBody

taskIds
​string[] · minItems: 1

Every task ID to start work on. If omitted, only the path :taskId is started. All taskIds must belong to the same session as the path :taskId.

SaveTaskWorkPlanBody

overallPlan
​string · minLength: 1 · required

Markdown plan covering all tasks in the session. Stored as a session log entry, a message in the session conversation; it does NOT change the session description. Publish an approved plan there with update-session-description.

​object[]

Per-task plan details. Each entry is stored as a task log on the corresponding task.

taskIds
​string[] · minItems: 1

Task IDs in the session. When provided, the server validates that taskPlans covers every id in this set (and only ids in this set). Pass the same taskIds you used for start-task-work.

ReportTaskProgressBody

content
​string · minLength: 1 · required

Progress note, in markdown: what changed and where, anything unexpected, what comes next. Saved as a task log entry and, when the task is in a session, posted to the session's conversation.

attachmentIds
​string[]

IDs of screenshots you uploaded to this session with request-attachment-upload (entity session). They show with this note in the session's conversation and in its snippets strip. Images uploaded to a task are not shown there.

SaveTaskVerificationBody

summary
​string · minLength: 1 · required

Verification summary written as a session log entry. Should describe what was verified and any uploaded screenshots.

attachmentIds
​string[]

IDs of attachments you uploaded with request-attachment-upload. Images uploaded to this session (entity session) show with the summary in the session's conversation and in its snippets strip; images uploaded to a task are only listed by id in the task logs.

taskIds
​string[] · minItems: 1

Task IDs in the session. When provided, the verification summary is also written as a task log on each task in the set, in addition to the session log.

CompleteTaskWorkBody

pullRequestUrl
​string · minLength: 1 · required

URL of the pull request that contains the implementation.

taskIds
​string[]

Optional list of task IDs to mark complete. If omitted, all tasks linked to the same session as the path :taskId are used.

CreateTaskRequestBody

title
​string · minLength: 1 · required
description
​string

Markdown, at most 200,000 characters.

status
​string · enum
Enum values:
todo
in_planning
in_progress
in_testing
in_review
done
type
​string · enum
Enum values:
task
subtask
priority
​string · enum
Enum values:
low
high
critical
assigneeId
​string

Assign ONE user by UUID (the legacy single-assignee field). Use assignees to assign several people or a team.

​AssignmentTargetInput[] · maxItems: 20

REPLACES the item's whole assignee set: every user and team listed becomes an assignee, everything not listed is unassigned. Pass [] to unassign everyone. When both this and the legacy single-user field (assigneeId / ownerId) are supplied, this wins. Find a team's id with list-teams and a person's with list-assignable-users.

creatorId
​string

Creator user UUID (required for service/agent callers)

featureId
​string

Deprecated alias for parentEntityType:'feature' + parentEntityId — kept for existing agents. Supplying it alongside the parentEntityType/parentEntityId pair is a 400.

parentEntityType
​string · enum

The structural parent's entity type (feature | application | session). Pair with parentEntityId — both or neither. NOTE: parentId is the parent TASK (subtask nesting), an unrelated axis.

Enum values:
feature
application
session
parentEntityId
​string

The structural parent's UUID. Pair with parentEntityType — both or neither.

parentId
​string

Parent TASK UUID (subtask nesting) — NOT the structural parent; see parentEntityType.

startAt
​string
dueAt
​string
sortOrder
​number
position
​string · enum

Where to place the task among its siblings (same structural parent and same parent task) when sortOrder is not supplied. end appends it below the last sibling, start puts it above the first. Ignored when an explicit sortOrder is given.

Enum values:
start
end
externalSource
​string
externalId
​string
externalSourceUrl
​string · uri
tags
​string[]

Layer tags for the task (e.g. backend, frontend, agent, test, docs, infra).

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

The Conversation id from your context. Pass it when you are creating this from a conversation so the images the user attached travel onto the item.

CreateTaskLogBody

content
​string · minLength: 1 · required

UpdateTaskLogBody

content
​string · minLength: 1 · required

UpdateTaskBody

title
​string
​

Markdown, at most 200,000 characters. Replaces the whole description: send it only with the complete new text. To change part of the description, send descriptionEdits instead.

​object[] · minItems: 1 · maxItems: 50

Change PART of the description without resending it: a list of exact find-and-replace edits the server applies to the stored description, in order, all or none. Each find must be copied exactly (same characters, spacing and line breaks) from the description as it stands, and must occur exactly once there at that point: include enough surrounding text to make it unique. replace is the new text (an empty string deletes the passage). Everything outside the passages is kept as it is. Prefer this over description for any change to a long description, and always when your read of the description was cut. Cannot be sent together with description.

status
​string · enum
Enum values:
todo
in_planning
in_progress
in_testing
in_review
done
type
​string · enum
Enum values:
task
subtask
priority
​string · enum
Enum values:
low
high
critical
​

Set the single USER assignee (legacy field): replaces the task's user assignees with this one, null unassigns every user. Team assignees are left untouched — use assignees to change them.

​AssignmentTargetInput[] · maxItems: 20

REPLACES the item's whole assignee set: every user and team listed becomes an assignee, everything not listed is unassigned. Pass [] to unassign everyone. When both this and the legacy single-user field (assigneeId / ownerId) are supplied, this wins. Find a team's id with list-teams and a person's with list-assignable-users.

​

Deprecated alias for parentEntityType:'feature' + parentEntityId (null clears the parent). Supplying it alongside the pair is a 400.

​

The structural parent's entity type. Pair with parentEntityId — both set, or both null to detach.

​

The structural parent's UUID. Pair with parentEntityType — both set, or both null to detach.

​

Parent TASK UUID (subtask nesting) — NOT the structural parent.

​
​
sortOrder
​number

DescribeTaskBody

source
​string · enum

How the run was triggered (auto on image upload / manual button)

Enum values:
auto
manual

ApplyTaskDescriptionProposalBody

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

CreateAccountInput

name
​string · minLength: 1 · maxLength: 100 · required

The company or organization's name, e.g. "Acme Corp". 1 to 100 characters.

accountType
​string · enum · required

What the company is to you: customer, partner, internal (your own company) or other.

Enum values:
internal
customer
partner
other
​

The company's website, as a full URL such as "https://www.example.com".

notes
​string · maxLength: 2000

Free-text notes about the account, up to 2000 characters.

sourceType
​string · enum

How the record came to exist: manual, feedback_stream, research_interview or crm_import. Set when importing records; leave it out when adding one by hand.

Enum values:
manual
feedback_stream
research_interview
crm_import
sourceId
​string

The UUID of the Productmind record this one was created from, such as a feedback stream. Leave it out when adding one by hand.

externalSource
​string · enum

Which CRM this record was imported from.

Enum values:
google_contacts
hubspot
salesforce
externalId
​string · minLength: 1 · maxLength: 255

The CRM's own id for this record — people/c123…, 701.

externalSourceUrl
​string · uri

Deep link back to the record in the CRM.

isStrategic
​boolean

Whether this is a strategic account: one that matters especially to you, shown with a star.

estimatedArr
​number · min: 0

The account's estimated annual recurring revenue: a non-negative number with no currency symbol, e.g. 120000.

lifecycleState
​string · enum

Where the account is in its relationship with you: prospect, trial, customer, expansion, at_risk or churned.

Enum values:
prospect
trial
customer
expansion
at_risk
churned

UpdateAccountInput

name
​string · minLength: 1 · maxLength: 100

The company or organization's name, e.g. "Acme Corp". 1 to 100 characters.

accountType
​string · enum

What the company is to you: customer, partner, internal (your own company) or other.

Enum values:
internal
customer
partner
other
​

The company's website, as a full URL such as "https://www.example.com". Send "" to clear it.

notes
​string · maxLength: 2000

Free-text notes about the account, up to 2000 characters. Replaces the whole text: read the current notes with get-account first and send the combined text.

isStrategic
​boolean

Whether this is a strategic account: one that matters especially to you, shown with a star.

​

The account's estimated annual recurring revenue: a non-negative number with no currency symbol, e.g. 120000.

lifecycleState
​string · enum

Where the account is in its relationship with you: prospect, trial, customer, expansion, at_risk or churned.

Enum values:
prospect
trial
customer
expansion
at_risk
churned
externalSource
​string · enum

Which CRM this record was imported from.

Enum values:
google_contacts
hubspot
salesforce
externalId
​string · minLength: 1 · maxLength: 255

The CRM's own id for this record — people/c123…, 701.

externalSourceUrl
​string · uri

Deep link back to the record in the CRM.

CreateContactInput

name
​string · minLength: 1 · maxLength: 100 · required

The person's full name, e.g. "Jane Doe". 1 to 100 characters.

​

The person's email address, e.g. "jane.doe@example.com". It identifies the person: when a contact already has this address (in any letter case), that contact is returned instead and nothing is created. Leave it out when you don't know it.

title
​string · maxLength: 100

The person's job title or role, e.g. "Head of Operations". Up to 100 characters.

phone
​string · maxLength: 50

The person's phone number, as written, e.g. "+1 555 0100". Up to 50 characters.

accountId
​string

The UUID of the account (company) the person belongs to: an account's id from list-accounts, or from create-account for a company you just added. Leave it out only when nobody knows the company: the contact is then filed under the "Unknown" account.

isPrimary
​boolean

Whether this person is the account's primary contact: the main person there, listed first and shown with a star. Marking one contact primary does not unmark another.

sourceType
​string · enum

How the record came to exist: manual, feedback_stream, research_interview or crm_import. Set when importing records; leave it out when adding one by hand.

Enum values:
manual
feedback_stream
research_interview
crm_import
sourceId
​string

The UUID of the Productmind record this one was created from, such as a feedback stream. Leave it out when adding one by hand.

externalSource
​string · enum

Which CRM this record was imported from.

Enum values:
google_contacts
hubspot
salesforce
externalId
​string · minLength: 1 · maxLength: 255

The CRM's own id for this record — people/c123…, 701.

externalSourceUrl
​string · uri

Deep link back to the record in the CRM.

UpdateContactInput

name
​string · minLength: 1 · maxLength: 100

The person's full name, e.g. "Jane Doe". 1 to 100 characters.

​

The person's email address, e.g. "jane.doe@example.com"; "" clears it. A new address is not checked against other contacts here: search list-contacts for it first, because another contact may already have it.

title
​string · maxLength: 100

The person's job title or role, e.g. "Head of Operations". Up to 100 characters.

phone
​string · maxLength: 50

The person's phone number, as written, e.g. "+1 555 0100". Up to 50 characters.

accountId
​string

Moves the contact to another account: that account's id, from list-accounts or create-account. Every contact belongs to one account, so it cannot be cleared.

isPrimary
​boolean

Whether this person is the account's primary contact: the main person there, listed first and shown with a star. Marking one contact primary does not unmark another.

externalSource
​string · enum

Which CRM this record was imported from.

Enum values:
google_contacts
hubspot
salesforce
externalId
​string · minLength: 1 · maxLength: 255

The CRM's own id for this record — people/c123…, 701.

externalSourceUrl
​string · uri

Deep link back to the record in the CRM.

releaseUpdatesOptOut
​boolean

true stops the release update emails to this person; false sends them again.

MatchContactsInput

emails
​string[] · maxItems: 200 · required

Attendee email addresses to match against existing contacts

CreateNoteBody

title
​string
rawContent
​string
contactId
​string
tags
​string[]
pinned
​boolean
​

UpdateNoteBody

​
rawContent
​string
​
tags
​string[]
pinned
​boolean
​

PromoteNoteBody

targetType
​string · enum · required

What to convert this note into. feature_request for a demand signal, feature for a roadmap item, task for engineering follow-up, bug_report for an observed defect. The note is archived on success and the new entity links back to it.

Enum values:
feature_request
feature
task
bug_report
featureId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

Task conversions only: the UUID of the feature the new task belongs to, in this workspace. Omit it for a task with no feature. Sending it with any other targetType is a 400. Ignored when the note was already converted: the call returns the item it became.

CreateCustomerInteractionInput

type
​string · enum · required
Enum values:
notes
interview_manual
agentic_voice
agentic_email
agentic_slack
feedback_stream
support
title
​string · minLength: 1 · maxLength: 200

Human name for the interaction. Stored in the summary blob; an AI summarization may later replace it.

customerResearchId
​string
workspaceId
​string
contactId
​string
tags
​string[]
rawContent
​string
guideline
​string
scheduledAt
​string
endsAt
​string

When the meeting ends. Only meaningful paired with scheduledAt, and must be strictly after it. Leave it out when the duration is unknown — the UI renders an unset end as one hour.

meetingUrl
​string
voiceEnabled
​boolean
recordingEnabled
​boolean
transcriptionEnabled
​boolean
​object[] · maxItems: 100

People on the meeting invitation. The server normalizes these and stores them as read-only participants; blank or malformed addresses are dropped rather than rejected.

externalSource
​string · enum

Which external system this interaction was imported from.

Enum values:
google_calendar
freshdesk
zendesk
intercom
externalId
​string · minLength: 1 · maxLength: 255

The external system's own id for this record — half of the dedup key.

externalSourceUrl
​string · uri

Deep link back to the record in the external system.

UpdateCustomerInteractionInput

​
​
tags
​string[]
rawContent
​string
guideline
​string
​
​
meetingUrl
​string
recordingEnabled
​boolean
transcriptionEnabled
​boolean
​object
​object[] · maxItems: 100

The conversation's whole participant roster, replaced. The server normalizes the addresses, keeps the role it already recorded for anyone already on the roster, and drops blank or malformed entries. Send an empty array to clear it.

UpdateCustomerInteractionStatusInput

status
​string · enum · required
Enum values:
draft
scheduled
invited
in_progress
processing
completed
cancelled
invalid
​

Why the interaction is being cancelled, shown beside its cancelled status. Kept only with status cancelled; any other status clears it.

​

A machine-readable code for the cancel reason, such as insufficient_credit or spending_paused for an interview the AI credit check refused. Kept only with status cancelled.

UpdateCustomerInteractionProgressInput

​object
​object[]

DescribeCustomerInteractionBody

source
​string · enum

How the run was triggered. Only manual is wired today.

Enum values:
auto
manual

ApplyCustomerInteractionDescriptionProposalBody

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

CreateCustomerInteractionMessageInput

content
​string · minLength: 1 · required
isFromAgent
​boolean

Set by Productmind's interviewer only; refused from any other caller.

​object[]

Set by Productmind's interviewer only; refused from any other caller.

userId
​string

Set by Productmind's interviewer only; refused from any other caller.

organizationId
​string

Set by Productmind's interviewer only; refused from any other caller, and never read.

CreateInternalMeetingInput

title
​string · minLength: 1 · maxLength: 500 · required

What the meeting is about — a real column here, unlike CustomerInteraction where the name hides inside the summary blob.

agenda
​string

What the meeting intends to cover. Fed to the summarizer as steering context, so it shapes the summary as well as the invitation.

notes
​string

Meeting notes, pasted. The Recall notetaker writes a transcript into this same field.

tags
​string[]
scheduledAt
​string
endsAt
​string

When the meeting ends. Only meaningful paired with scheduledAt, and must be strictly after it. Leave it out when the duration is unknown — the UI renders an unset end as one hour.

meetingUrl
​string

Google Meet / Zoom / Teams link the notetaker joins.

recordingEnabled
​boolean

Send the Recall notetaker to this meeting.

transcriptionEnabled
​boolean
​object[] · maxItems: 100

People on the meeting invitation. The server normalizes these into participants and resolves platform users among them; blank or malformed addresses are dropped rather than rejected.

externalSource
​string · enum

Which external system this meeting was imported from.

Enum values:
google_calendar
externalId
​string · minLength: 1 · maxLength: 255

The external system's own id for this event — half of the dedup key.

externalSourceUrl
​string · uri

Deep link back to the event in the external system.

UpdateInternalMeetingInput

title
​string · minLength: 1 · maxLength: 500
agenda
​string
notes
​string
tags
​string[]
​
​
meetingUrl
​string
recordingEnabled
​boolean
transcriptionEnabled
​boolean
​object
​object[] · maxItems: 100

The meeting's whole participant roster, replaced. The server normalizes the addresses, resolves platform users among them, keeps the role it already recorded for anyone already on the roster, and drops blank or malformed entries. Send an empty array to clear it.

InternalMeetingActionPoint

description
​string · required
assigneeUserId
​string
assigneeEmail
​string
done
​boolean
Default: false

UpdateInternalMeetingStatusInput

status
​string · enum · required
Enum values:
draft
scheduled
in_progress
processing
completed
cancelled
failed

CreateInternalMeetingRelationshipBody

targetType
​string · required

feature, feature_request or task.

targetId
​string · required

UUID of the entity to link.

SupportImportPreviewBody

​SupportTicketIngest[] · minItems: 1 · maxItems: 100 · required

SupportTicketIngest

platform
​string · enum · required

Support platform the ticket came from

Enum values:
freshdesk
zendesk
intercom
externalId
​string · minLength: 1 · required

Platform ticket id — half of the dedup key

externalSourceUrl
​string · uri

Deep link back to the ticket

subject
​string

Ticket subject line

requesterEmail
​string

Requester email — what contact matching keys on

requesterName
​string

Requester display name

status
​string

Platform status name (resolved, closed, open, …)

Default:
tags
​string[]

Ticket tags, used by the automation filters

Default: []
groupId
​string

Platform group / team id

createdAt
​string

ISO 8601 ticket creation timestamp

resolvedAt
​string

ISO 8601 resolution timestamp

description
​string

The requester's opening message

​object[]

Public reply thread, oldest first. Internal notes are excluded by the connector.

​object[]

Files from the description and the public replies. Internal notes' files are excluded by the connector. Each carries a short-lived downloadUrl the API fetches during ingest; unparseable entries are dropped.

Default: []
interactionType
​string · enum

Override the interaction type; defaults to support

Enum values:
support
notes
interview_manual
contactId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

Link to this contact instead of the one matched from requesterEmail

SupportImportBody

​SupportTicketIngest[] · minItems: 1 · maxItems: 100 · required
instanceId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
summarize
​boolean

Summarize each imported conversation with AI (default: true)

UpdateSupportIngestionConfigBody

statuses
​string[]
tags
​string[]
tagMatchMode
​string · enum
Enum values:
any
all
groupIds
​string[]
​
defaultInteractionType
​string · enum
Enum values:
support
notes
interview_manual

CreateSupportRequestScreenshots

conversationAttachmentIds
​string[] · maxItems: 10
​SupportScreenshotClaim[] · maxItems: 10

SupportScreenshotClaim

uploadId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required
fileName
​string · minLength: 1 · maxLength: 255 · pattern: ^[^/\\\p{Cc}\p{Cf}\p… · required

CreateCustomerResearchBody

title
​string · minLength: 1 · required
objectives
​string[] · minItems: 1 · required
questions
​string[] · minItems: 1 · required
description
​string
widgetWelcomeMessage
​string

UpdateCustomerResearchInput

title
​string · minLength: 1
description
​string
objectives
​string[]
questions
​string[]
guideline
​string
interviewWelcomeMessage
​string
widgetWelcomeMessage
​string

CreateKnowledgeBaseDocumentBody

title
​string · minLength: 1 · maxLength: 255 · required
description
​string · maxLength: 2000
content
​string · maxLength: 300000

Optional initial markdown body. When set, the server derives the editable Lexical/Y.Doc state, snapshots version 1, and marks the document as generated.

parentDocumentId
​string

Optional parent KB document id — creates this document as a child node in the document tree. System documents cannot be parents or children.

applicationId
​string

Optional application id to auto-link this document to (kb_document documents application).

availableToAgents
​boolean

Share the document with agents (chunk + embed) once content is saved. Defaults to false; only meaningful together with content.

tags
​string[] · maxItems: 20

Optional content-domain tags — product (specs, overviews, personas, UX), engineering (technical documentation), research (interviews, competitor/market research). Agents filter KB search on this axis. When omitted, a document created with content defaults to ["engineering"]; providing the field (even an empty array) is honored exactly.

Enum values:
product
engineering
research

BulkDeleteKnowledgeBaseDocumentsBody

ids
​string[] · minItems: 1 · required

ReorderKnowledgeBaseDocumentBody

sortOrder
​integer · min: 0 · max: 9007199254740991 · required
​

LinkKbDocumentBody

entityType
​string · enum · required

Target entity type

Enum values:
application
feature
entityId
​string · minLength: 1 · required

Target entity UUID (application or feature id)

ProposeKbDocumentContentBody

proposedContentMarkdown
​string · minLength: 1 · maxLength: 300000 · required

The FULL replacement markdown for the document. Code citations are link tokens — path/to/file.ext:line @ — never wrapped in backticks; the sha is the HEAD of the clone you read.

summary
​string · maxLength: 4096

One-paragraph summary of what changed and why

sessionId
​string

The session id (from the Context section of your instructions)

commentId
​string

When you answer a comment thread on this document (your turn input names it): the thread's id, exactly as given. The suggestion is then linked to the thread, and applying it resolves the thread. Only the thread you were asked to answer, while you answer it; omit it otherwise.

ApproveKbDocumentProposalBody

content
​string · minLength: 1 · maxLength: 300000 · required
draftVersion
​integer · min: 0 · max: 9007199254740991

ApplyKbDocumentProposalBody

content
​string · minLength: 1 · maxLength: 300000 · required
draftVersion
​integer · min: 0 · max: 9007199254740991

ProposeKbDocumentCreationBody

title
​string · minLength: 1 · maxLength: 255 · required

The title the document will be created with. The root of an application's technical documentation is " — Technical Docs"; a child is its section name ("Architecture Overview", "Setup Guide").

proposedContentMarkdown
​string · minLength: 1 · maxLength: 300000 · required

The FULL markdown of the new document. Code citations are link tokens — path/to/file.ext:line @ — never wrapped in backticks; the sha is the HEAD of the clone you read.

applicationId
​string · minLength: 1 · required

The Application this document documents (its id from the Context). The created document is linked to it.

parentDocumentId
​string

An EXISTING document to nest the new one under. Omit for a root document. Use parentProposalId instead when the parent is another creation you proposed in this same session.

parentProposalId
​string

The id returned by an earlier propose-kb-document-creation call in this session whose document the new one nests under — how a child is attached beneath a root that does not exist yet. Resolved when both are applied; a dismissed parent puts the child at root.

summary
​string · maxLength: 4096

One paragraph: why this document is needed and which changed files motivated it

sessionId
​string

The session id (from the Context section of your instructions)

KnowledgeBaseUpdateDocumentInput

title
​string · minLength: 1 · maxLength: 255

Rename the document. Trimmed, then 1 to 255 characters. Refused with 409: on a system document (Overview, Personas, User experience, Competitors keep their names; kb_document_title_fixed), when another document in the workspace already has exactly this title (kb_document_title_taken), and on a document synced from a repository (change its title in the repository; kb_document_repository_synced).

tags
​string[] · maxItems: 20
description
​string · maxLength: 2000

KnowledgeBaseSaveDocumentContentBody

content
​string · required

KnowledgeBaseSearchInput

query
​string · minLength: 1 · required
mode
​string · enum
Enum values:
semantic
hybrid
lexical
Default: hybrid
limit
​number · min: 1 · max: 50
Default: 3
​
tags
​string[]
excludeTags
​string[]

KnowledgeBaseRagInput

question
​string · minLength: 1 · maxLength: 2000 · required
promptTemplate
​string · minLength: 1 · maxLength: 10000 · required
mode
​string · enum
Enum values:
semantic
hybrid
lexical
Default: hybrid
limit
​number · min: 1 · max: 20
Default: 5
tags
​string[]

IngestConnectorItemsBody

connectorInstanceId
​string · minLength: 1 · required
provider
​string · enum · required
Enum values:
google-docs
notion-pages
confluence-pages
​object[] · minItems: 1 · maxItems: 50 · required

IngestTextDocumentBody

name
​string · minLength: 1 · required
content
​string · minLength: 1 · required
​KnowledgeBaseConnectorRef · required
chunkingStrategy
​string · enum
Enum values:
standard
contextual
userId
​string

Ignored. The document is attributed to the person the request acts as, never to a person this field names.

KnowledgeBaseConnectorRef

provider
​string · enum · required
Enum values:
google-docs
notion-pages
confluence-pages
externalId
​string · required
externalUrl
​string

RenameKnowledgeBaseDocumentVersionBody

​required

StopChatRunBody

requestId
​string · maxLength: 128

DetachChatSessionBody

CreateChatBody

title
​string
initialMessage
​string · minLength: 1
agentId
​string
​object
clientChatId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

An id the client minted for this conversation before creating it. The chat is stored under chatIdFor(workspaceId, userId, clientChatId), so the client knows its id at once, and a repeated create returns the conversation already made.

CreateReleaseBody

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.

UpdateReleaseBody

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
​

AddReleaseShippedItemsBody

​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.

AddReleaseItemsBody

featureIds
​string[] · minItems: 1 · required

UpdateReleaseItemBody

​

ReorderReleaseItemsBody

itemIds
​string[] · minItems: 1 · required

CreateReleaseDeploymentBody

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

UpdateReleaseDeploymentBody

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

AddReleaseSessionsBody

sessionIds
​string[] · minItems: 1 · required

GenerateReleaseArtifactBody

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

UpdateReleaseArtifactBody

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

AddReleaseApplicationsBody

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.

UpdateReleaseApplicationDescriptionBody

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.

PrepareReleaseBody

CloseReleaseBody

ReopenReleaseBody

ApplyReleaseNotesProposalBody

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

ShipReleaseBody

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.

CreateMarketingReleaseBody

title
​string · minLength: 1 · maxLength: 200 · required
​MarketingReleaseSourceRef[] · maxItems: 50

Sources to attach at once; none is needed.

MarketingReleaseSourceRef

type
​string · enum · required

release, feature, feature_request or customer_interaction (customer feedback).

Enum values:
release
feature
feature_request
customer_interaction
id
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required

The source's id, in this workspace.

UpdateMarketingReleaseBody

title
​string · minLength: 1 · maxLength: 200
status
​string · enum
Enum values:
planned
in_progress
announced
archived

AttachMarketingReleaseSourcesBody

​MarketingReleaseSourceRef[] · minItems: 1 · maxItems: 50 · required

RequestMarketingMediaUploadsBody

​MarketingMediaUploadFile[] · minItems: 1 · maxItems: 100 · required

The files to make a place for, at most 100 a call. Each gets its own upload link in the answer.

​object

The campaign these files were rendered from. Give it for a rendered campaign: its files then replace the ones delivered before under the same names. Leave it out for a single file of your own.

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

The coding session that rendered the files, when one did: its own session id.

MarketingMediaUploadFile

fileName
​string · maxLength: 200 · pattern: ^(?![./])(?!.*(?:^|\… · required

The file's name: its path inside the campaign's output folder, exactly as the manifest lists it (homepage-wide.mp4, banners/homepage-launch-open-graph.png), or a plain name for a single upload. With campaign, a file of the same name delivered before is replaced.

contentType
​string · enum · required

The file's media type. A clip is video/mp4 (or video/webm); a loop image/webp; a poster or banner image/png, image/webp or image/jpeg; captions application/x-subrip (.srt) or text/vtt.

Enum values:
video/mp4
video/webm
image/webp
image/gif
image/png
image/jpeg
application/x-subrip
text/vtt
bytes
​integer · min: 1 · max: 9007199254740991 · required

The file's exact size in bytes. The upload link takes that many bytes and no others.

sha256
​string · pattern: ^[0-9a-f]{64}$ · required

The file's sha256, as 64 lower-case hex digits (sha256sum <file>). It is recorded with the file, which is known by it afterwards.

kind
​string · enum · required

What the file is: clip (a video), loop (a short animated image), poster (a clip's still frame), banner (one still at a channel's exact pixels) or captions (a narrated clip's captions file).

Enum values:
clip
loop
poster
banner
captions

Which cut of the campaign the file is.

width
​integer · min: 1 · max: 20000

The picture's width in pixels.

height
​integer · min: 1 · max: 20000

The picture's height in pixels.

durationMs
​integer · min: 1 · max: 3600000

A clip's or a loop's length in milliseconds.

label
​string · minLength: 1 · maxLength: 200

A short name a person will recognize it by. Optional.

MarketingMediaVariant

format
​string · minLength: 1 · maxLength: 40

A clip's or a poster's format: wide, portrait or square.

theme
​string · enum

light or dark.

Enum values:
light
dark
target
​string · minLength: 1 · maxLength: 60

A banner's target, as the marketing studio names it: linkedin-card, open-graph.

narrated
​boolean

True for a clip with its narration under it.

captioned
​boolean

True for a clip with its captions drawn into the picture.

scale
​integer · min: 1 · max: 4

2 for a poster drawn at twice its size.

ConfirmMarketingMediaBody

mediaIds
​string[] · minItems: 1 · maxItems: 100 · required

The ids of the files that were uploaded, from request-marketing-media-uploads. Each is looked for in storage.

UpdateMarketingMediaBody

​

What a person calls the file; null or empty clears it.

CreateMarketingNotesBody

generate
​boolean

Write a first draft from the sources in the background.

acknowledgeInternalOnly
​boolean

With generate: the person chose Generate anyway on sources that hold no customer-facing feature.

SaveMarketingNotesBody

headline
​string · maxLength: 1200 · required
summary
​string · maxLength: 4000 · required
body
​string · maxLength: 100000 · required

GenerateMarketingNotesBody

confirmOverwrite
​boolean

Required when the document has text: the person confirmed replacing it.

acknowledgeInternalOnly
​boolean

The person chose Generate anyway on sources that hold no customer-facing feature.

PublishMarketingNotesBody

expectedUpdatedAt
​string · required

The draft's updatedAt the person reviewed; a newer draft refuses the publish.

quotesReviewed
​boolean

The person confirmed every customer quote is anonymized. Required when the notes quote customers.

UnpublishMarketingNotesBody

version
​integer · min: 1 · max: 9007199254740991 · required

The newest published version the person confirmed unpublishing.

RepublishMarketingNotesBody

version
​integer · min: 1 · max: 9007199254740991 · required

The newest published version the person confirmed making live again. No new version is created.

CreateBlogPostBody

​BlogPostScopeInput · required
​BlogPostGuidance
acknowledgeMissingSpecifications
​boolean

The person chose Generate anyway with a feature in scope that has no specification.

BlogPostScopeInput

featureIds
​string[] · maxItems: 10

Customer-facing features of the Marketing release's sources that the post is about.

Default: []
​

The published notes document the passages were picked from. Required with passages.

​

The published customer notes version the passages were picked from. Required with passages.

​object[] · maxItems: 12

Whole sections (0 is the summary) or highlighted excerpts of the published customer notes.

Default: []

BlogPostGuidance

tone
​string · enum
Enum values:
friendly
professional
enthusiastic
Default: friendly
length
​string · enum
Enum values:
short
standard
long
Default: standard
angle
​string · maxLength: 500

A free-text angle for the post, e.g. who it is for or what to lead with.

Default:

GenerateBlogPostBody

A new scope; the post's own when omitted.

​BlogPostGuidance
confirmOverwrite
​boolean

Required when the post has text: the person confirmed replacing it.

acknowledgeMissingSpecifications
​boolean

The person chose Generate anyway with a feature in scope that has no specification.

UpdateBlogPostScopeBody

​BlogPostScopeInput · required

ApproveBlogPostBody

expectedUpdatedAt
​string · required

The post's updatedAt the person reviewed; a newer post refuses the approval.

quotesReviewed
​boolean

The person confirmed every customer quote is anonymized. Required when the post quotes customers.

PublishBlogPostBody

summary
​string · minLength: 1 · maxLength: 160 · required

What the blog's index and link previews say of the post.

expectedUpdatedAt
​string · required

The post's updatedAt the person reviewed; a newer post refuses the publish.

slug
​string

The post's address on the blog. Required on its first publish, then fixed: a later publish may leave it out or send the same one.

​

A ready image, loop or clip of the post's Marketing release's media shown at the top of the post; none when left out.

​

Who the post is by, as the blog shows it; none when left out or empty.

UnpublishBlogPostBody

RetryBlogDeployBody

GenerateCustomerEmailsBody

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

A live notes document of the Marketing release; the most recently published one when omitted.

SaveCustomerEmailDraftBody

subject
​string · maxLength: 1500 · required

SendCustomerEmailsBody

​object[] · minItems: 1 · maxItems: 50 · required
namesReviewed
​boolean

The person confirmed no draft identifies another customer. Required when a draft may name one.

ProposeMarketingDocumentContentBody

summary
​string · minLength: 1 · maxLength: 500 · required

One line on what the suggestion changes, shown above the review.

commentId
​string · minLength: 1 · required

The id of the comment thread you are answering, exactly as your turn input names it. Required: a suggestion is only taken from the thread you were asked to answer, while you answer it. Applying it resolves the thread.

​object[] · minItems: 1 · maxItems: 20

The change, as exact find-and-replace edits on the document's current text, applied in order, all or none. Each find is copied exactly (same characters, spacing and line breaks) from the text get-marketing-document returns, and occurs exactly once there: include enough surrounding text to make it unique. replace is the new text. Change only the passage the thread is about; every other passage stays as it is. Prefer this over content.

content
​string · minLength: 1 · maxLength: 200000

The WHOLE new document, only when the thread asks to rewrite all of it. Never send it with edits.

InsertMarketingMediaImageBody

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

The media file to put into the document: a ready loop, poster or banner of the same Marketing release.

ApplyMarketingDocumentProposalBody

content
​string · maxLength: 200000 · required

The document's new text, as composed in the review.

CreateSandboxBody

name
​string · minLength: 1 · maxLength: 200 · required
description
​string
​
​
size
​SandboxSize · enum

Sandbox size: small (2 vCPU, 8 GB), medium (4 vCPU, 16 GB) or large (8 vCPU, 32 GB)

Enum values:
small
medium
large
​SidecarEnv[] · maxItems: 50
​WorkspaceEnvVar[] · maxItems: 100
isDefault
​boolean

SandboxSize

string · enum
Enum values:
small
medium
large

Sandbox size: small (2 vCPU, 8 GB), medium (4 vCPU, 16 GB) or large (8 vCPU, 32 GB)

SidecarEnv

key
​string · minLength: 1 · maxLength: 256 · pattern: ^[A-Za-z_][A-Za-z0-9… · required
command
​string · minLength: 1 · maxLength: 4096 · required

WorkspaceEnvVar

key
​string · minLength: 1 · maxLength: 256 · pattern: ^[A-Za-z_][A-Za-z0-9… · required
value
​string · maxLength: 32768
Default:
secret
​boolean
Default: false

UpdateSandboxBody

name
​string · minLength: 1 · maxLength: 200
​
​
​
size
​SandboxSize · enum

Sandbox size: small (2 vCPU, 8 GB), medium (4 vCPU, 16 GB) or large (8 vCPU, 32 GB)

Enum values:
small
medium
large
​SidecarEnv[] · maxItems: 50
​WorkspaceEnvVar[] · maxItems: 100
isDefault
​boolean

SetSandboxApplicationsBody

applicationIds
​string[] · maxItems: 50 · required

Every application the sandbox runs, by id (from list-applications), in startup order: the first starts first. Replaces the whole list, so send the ones to keep too; [] detaches them all. New sessions on the sandbox take these applications' repositories, and the first one's base branch is what their pull requests merge into. At most 50.

UpdateSandboxSizeBody

size
​string · enum · required

small (2 vCPU, 8 GB), medium (4 vCPU, 16 GB) or large (8 vCPU, 32 GB). Applies from the sandbox's next hosted run, which starts on a new machine and continues from the work the coding agent pushed: a run already going keeps its size. Sandbox time is billed at the size's own hourly rate.

Enum values:
small
medium
large

WorkspaceEnvVarPatchBody

​WorkspaceEnvVarPatchEntry[] · maxItems: 100

Variables to add, or to replace by key, each { key, value?, secret? }. A key already stored is replaced in place; a new one is added at the end. Every key once.

remove
​string[] · maxItems: 100

Keys to delete. A key that is not set is ignored. A key cannot be in both set and remove.

WorkspaceEnvVarPatchEntry

key
​string · minLength: 1 · maxLength: 256 · pattern: ^[A-Za-z_][A-Za-z0-9… · required

The variable's name: letters, digits and _, not starting with a digit. Case-sensitive.

value
​string · maxLength: 32768

The value. On a secret, leave it out (or send "") to keep the value already stored. On a plain variable, leaving it out keeps its current value, and a new variable gets "".

secret
​boolean

true stores the value encrypted: it is never shown again, by any tool or in the app. Leave it out to keep the variable's current kind; a new variable is plain unless this is true.

CreateApplicationBody

name
​string · minLength: 1 · maxLength: 200 · required
description
​string
​
​
​
​
requireDependencyInstall
​boolean
readOnly
​boolean
​
​PreviewPort[] · maxItems: 20
​WorkspaceEnvVar[] · maxItems: 100
llmAssistedPreviewSetup
​boolean
​
​
​
​

ApplicationRepo

workforceConnectorId
​string · minLength: 1 · maxLength: 1024 · required
externalRepoId
​string · minLength: 1 · maxLength: 1024 · required
repoName
​string · minLength: 1 · maxLength: 1024 · required
repoUrl
​string · minLength: 1 · maxLength: 1024 · required
provider
​string · minLength: 1 · maxLength: 1024 · required
baseBranch
​string · minLength: 1 · maxLength: 256 · required
​
​

PreviewPort

port
​integer · min: 1 · max: 65535 · required
name
​string · minLength: 1 · maxLength: 64 · required
protocol
​string · enum
Enum values:
http
https
tcp
Default: http
isMain
​boolean

ApplicationService

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

The service's name, e.g. web or api

type
​string · enum · required

What kind of unit the service is

Enum values:
webservice
monorepo
cli
worker
mobile
library
desktop
infrastructure
port
​integer · min: 1 · max: 65535

The port it serves on in a live preview; leave it out for a service with nothing to preview

protocol
​string · enum

How the port is reached: http (the default) or https

Enum values:
http
https
tcp
Default: http
isMain
​boolean

Whether this port is the one a live preview opens first

​

The service's OpenAPI or Swagger file, a path in the repository such as services/api/openapi.json. Leave it out to keep the stored one; null clears it, so the file is found automatically again

MonorepoService

name
​string · minLength: 1 · maxLength: 200 · required
type
​string · enum · required
Enum values:
webservice
monorepo
cli
worker
mobile
library
desktop
infrastructure

CreateApplicationFromTemplateBody

templateId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required
name
​string · minLength: 1 · maxLength: 200

ApplicationRepairedCommandsBody

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

The live preview whose repaired commands to save

ApplicationEnvironmentBranchBody

​required

The branch whose merges deploy to this custom environment, or null to unmap it.

UpdateApplicationBody

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

The whole risk profile, replacing the stored one; null resets it to the defaults

​
​
​
requireDependencyInstall
​boolean
readOnly
​boolean
​
​PreviewPort[] · maxItems: 20
​WorkspaceEnvVar[] · maxItems: 100
llmAssistedPreviewSetup
​boolean
​
​
​
​
​

ApplicationRiskRule

id
​string · minLength: 1 · maxLength: 64 · required

Unique within the profile

name
​string · minLength: 1 · maxLength: 60 · required

Shown as the reason a file is flagged

tier
​string · enum · required

high and medium flag a file; a file matching any low rule is never flagged

Enum values:
high
medium
low
pathPatterns
​string[] · maxItems: 50 · required

Globs over the repository-relative path (*, **, ?, {a,b}), case-insensitive. A pattern with no / matches the file name in any folder

nameWords
​string[] · maxItems: 100 · required

Whole words of a folder or file name, case-insensitive. Names split on punctuation and camelCase, and two adjacent pieces also match joined

lineTexts
​string[] · maxItems: 50 · required

Text an added or removed line contains as whole words, case-insensitive, with any run of spaces between words

​required

Matches when additions plus deletions reach this; null for no threshold

StartDiscoveryBody

objective
​string · enum
Enum values:
features

StartDetectionBody

​object[] · minItems: 1 · maxItems: 50 · required

UpdateApplicationCommandsBody

​

The shell command that installs dependencies, run in the working directory before the dev command, e.g. bun install. null clears it; leave it out to keep it.

​

The shell command that starts the application for a live preview, e.g. bun run dev. null clears it; leave it out to keep it.

​

The directory both commands run in, relative to the repository root, e.g. services/web. null runs them at the root; leave it out to keep it.

requireDependencyInstall
​boolean

Require dependencies to install: true makes a plan, a build or a scan of this application stop before the AI starts when its install command fails, times out or cannot run; false lets the run continue without it, as by default. true needs an install command, the stored one or installCommand in this call; clearing the install command turns it off. Leave it out to keep it.

UpdateApplicationServicesBody

​ApplicationService[] · maxItems: 50 · required

Every runnable unit of the application, replacing the stored list: send the services to keep too, [] removes them all. Each is { name, type, port?, protocol?, isMain? }. A service with a port is a preview port: ports are unique, and at most 20 services have one. isMain marks the port a live preview opens first: one service at most, and only one with a port; when none is marked, the first service with a port is the main one. At most 50 services.

UpdateApplicationRiskRulesBody

​required

The rules pull request reviews rate each changed file with, replacing the whole profile, or null to put the application back on Productmind's default rules. An array is the complete profile: a rule left out is no longer applied, the defaults included. get-application answers riskRules: null while the application is on the defaults. Each rule is { id, name, tier, pathPatterns, nameWords, lineTexts, minChangedLines }, every key present (empty lists and null where unused), with at least one condition.

UpdateApplicationBranchesBody

baseBranch
​string · minLength: 1 · maxLength: 256

The branch coding sessions branch from and open their pull requests against.

​

The branch whose merges deploy this application to Development. null falls back to the workspace's Git workflow default.

​

The branch whose merges deploy this application to Production, and what a release merges into. null falls back to the workspace's Git workflow default.

​ApplicationEnvironmentBranchEntry[] · maxItems: 50

Custom environments' branches, each { environmentId, branch }. Every environment once.

readOnly
​boolean

Read-only: true makes coding sessions read this application's repository for context and never push to it or open pull requests on it, in every session, the open ones included; false lets sessions push their working branch again, as by default. Leave it out to keep it.

ApplicationEnvironmentBranchEntry

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

A custom environment's id, from list-application-environments. Not Development or Production: they take developmentBranch and productionBranch.

​required

The branch whose merges deploy this application to the environment, or null to unmap it.

CreateEnvironmentBody

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

The environment's key, which never changes.

name
​string · minLength: 1 · maxLength: 100 · required

The environment's display name.

tier
​string · enum · required

The environment's tier: production or non_production.

Enum values:
production
non_production

UpdateEnvironmentBody

name
​string · minLength: 1 · maxLength: 100

The environment's display name.

tier
​string · enum

A custom environment's new tier. Development and Production keep theirs.

Enum values:
production
non_production

StartArchitectureScanBody

applicationIds
​string[] · maxItems: 60
​object[] · maxItems: 60

DecideFeatureMapDeltasBody

​object[] · minItems: 1 · maxItems: 1000 · required

TagFeatureMapDeltasBody

deltaIds
​string[] · minItems: 1 · maxItems: 1000 · required

The changes to tag. A tag passes to the changes under each of them; merges and removals take none.

add
​string[] · maxItems: 20

Tags to put on the changes, spelled the standard way (lowercase-with-hyphens) when saved.

Default: []
remove
​string[] · maxItems: 20

Tags to take off the changes, and so off the changes under them.

Default: []

AssignFeatureMapDeltasBody

deltaIds
​string[] · minItems: 1 · maxItems: 1000 · required

The changes to assign. The changes under each of them follow it, unless a person assigned them.

​required

The people and teams to assign, replacing who the changes are assigned to. [] assigns nobody; null puts the changes back to automatic (their features' owners).

ApplyFeatureMapProposalBody

DiscardFeatureMapProposalBody

StartFeatureMapBody

applicationIds
​string[] · maxItems: 60
​object[] · maxItems: 60
kbDocumentIds
​string[] · maxItems: 10

Knowledge-base documents (at most 10) whose content reaches the prompts that group the code into domains and features, in the order they should be read. Omit it to use the workspace's default documents (Settings > Feature discovery); send [] to use none for this run. Each listed document must be in the workspace and neither a system document nor being deleted, and the caller must be able to read the knowledge base.

StartFeatureDeepScanBody

featureIds
​string[] · minItems: 1 · maxItems: 1000 · required

CreateSessionWithTasksBody

taskIds
​string[] · minItems: 1 · required

Tasks to attach to the new session. A task held by a session that is still open (anything but a draft in planning, or a finished session: completed, rolled back, failed or cancelled) is refused with a 409 naming both. The first id also names the working branch (task/<slug-of-its-title>-<timestamp>).

name
​string · minLength: 1 · maxLength: 200

Human-readable session name (e.g. 'Ticket dashboard v1'). Omit to have it derived from the task titles. The branch name is derived server-side either way; do not pass a branch name.

description
​string

The session's description, in markdown: the plan document a person opening the session reads, and the brief a coding agent drafts its plan from. Nothing fills it in for you: it is not copied from the conversation or derived from the tasks, so a session created without it has an empty description. When a plan or approach was agreed, pass it here in full (goal, approach, decisions, constraints, how to tell it is done), opening with a one-line summary. With originChatId this is the only way to hand it over, because the plan is drafted during this call.

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

The assistant conversation this session is being created FROM — pass the Conversation id from your context whenever you propose a session inside a conversation. Links the session to it (the conversation becomes the coding agent's context and is latched to the session) and drafts the plan immediately.

applicationIds
​string[] · maxItems: 20

Applications whose repositories this session should work in, added on top of the ones the sandbox and the tasks already reach. Pass the ids the user pinned in the conversation when check-session-scope said the session would otherwise reach no repository. An application with no connected repository contributes nothing. Each one named here also runs in the session's sandbox, even when another sandbox lists it.

readOnlyApplicationIds
​string[] · maxItems: 20

Applications whose repositories this session should READ for context only: each is attached like applicationIds, but read-only in this session, so the coding agent reads its code and nothing is ever committed, pushed or opened as a pull request on it. A repository an application already makes read-only (its Read-only setting) stays read-only in every session, whether or not it is named here. An application in both lists is read-only.

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

The sandbox (the container the session runs in) to bind. Omit to use the workspace default - only pass one when check-session-scope reported no default and the user chose.

With originChatId only: where the plan drafted in this call runs, as the person chose it on the hand-off card. Omit it to let the server pick: the person's online Productmind agent, else the cloud.

SessionTransportChoice

mode
​string · enum · required

cloud, or codeflow_local for a Productmind agent on the person's machine

Enum values:
cloud
codeflow_local
codeflowInstanceId
​string

The Productmind agent it runs on, required with mode set to codeflow_local

CreateBugFixSessionBody

bugReportIds
​string[] · minItems: 1 · required

Bug reports to attach to the new bug-fix session. Their related Applications' repos are auto-added on top of the default sandbox's. The first id also names the working branch (bugfix/<slug-of-its-title>-<timestamp>).

​

Sandbox to bind the session to. Omit to use the workspace default - only pass one when check-session-scope reported no default and the user chose.

App only - omit. Explicit repos to attach at create. When provided (even empty) it is honored exactly, overriding BOTH the sandbox-derived repos and the bug-related-Application layering; omit to derive them server-side.

description
​string

The session's description, in markdown: the plan document a person opening the session reads, and the brief a coding agent drafts its plan from. Nothing fills it in for you: it is not copied from the conversation or derived from the tasks, so a session created without it has an empty description. When a plan or approach was agreed, pass it here in full (goal, approach, decisions, constraints, how to tell it is done), opening with a one-line summary. With originChatId this is the only way to hand it over, because the plan is drafted during this call.

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

The assistant conversation this session is being created FROM - pass the Conversation id from your context whenever you propose a bug-fix session inside a conversation. Links the session to it (the conversation becomes the coding agent's context and is latched to the session) and drafts the fix plan immediately.

applicationIds
​string[] · maxItems: 20

Applications whose repositories this session should work in, added on top of the ones the sandbox and the bug reports already reach. Pass the ids the user pinned in the conversation when check-session-scope said the session would otherwise reach no repository. Each one named here also runs in the session's sandbox, even when another sandbox lists it.

readOnlyApplicationIds
​string[] · maxItems: 20

Applications whose repositories this session should READ for context only: each is attached like applicationIds, but read-only in this session, so the coding agent reads its code and nothing is ever committed, pushed or opened as a pull request on it. A repository an application already makes read-only (its Read-only setting) stays read-only in every session, whether or not it is named here. An application in both lists is read-only.

With originChatId only: where the plan drafted in this call runs, as the person chose it on the hand-off card. Omit it to let the server pick: the person's online Productmind agent, else the cloud.

AutonomousSessionRepoInput

workforceConnectorId
​string · minLength: 1 · required

Workforce connector-instance id that owns the repo

externalRepoId
​string · minLength: 1 · required

Vendor-side repo id (GitHub/GitLab/Bitbucket)

repoName
​string · minLength: 1 · required

Display name (typically owner/name)

repoUrl
​string · minLength: 1 · required

Canonical HTTPS URL to the repository

provider
​string

Provider name (github, gitlab, bitbucket, …)

baseBranch
​string · minLength: 1

Branch to clone and base the working branch on

Default: main
workingBranch
​string · maxLength: 256

Working branch name; auto-derived from the session id when omitted

readOnly
​boolean

true attaches the repository for context only: the coding agent reads it, and nothing is ever committed, pushed or opened as a pull request on it. Leave it out to inherit: a repository is read-only anyway when an application on it is.

StartCodeChatBody

message
​string · minLength: 1 · maxLength: 20000 · required

The first message the coding agent answers, written to stand on its own: what the person wants to understand or decide about the code, in their terms (for example 'How does refund approval work in the code, and could it be split out of checkout?'). The agent also reads the conversation passed as originChatId.

applicationIds
​string[] · maxItems: 20

The applications whose code the chat reads: their repositories are checked out read-only. Pass your best choice from the conversation (check-session-scope lists the workspace's applications; one whose repoName is null has no repository and cannot help): the person confirms or changes them on the hand-off card. With sandboxId, the sandbox's own applications are read too. At least one application read must have a repository.

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

The sandbox the chat runs in, and the plan it may become: its own applications' code is read too. Omit it unless the person chose one; a plan drafted from the chat then runs in the workspace's default sandbox.

Where the coding agent runs, as the person chose it: omit it unless they did. The server then picks: their online Productmind agent, else the cloud.

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

The feature or component the discussion is about, when it is about one: the chat is linked to it, its linked applications' code is checked out too, and the agent may propose corrections to its document. Omit it for a question about the code in general.

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

The conversation this chat continues: the Conversation id in your context. The coding agent is handed that conversation as context, and the conversation carries on with the coding agent. It stays private to the person. Only the conversation's owner may pass it.

attachmentIds
​string[] · maxItems: 10

App only - omit. Images uploaded by the composer against draftChatId, moved onto the new chat.

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

App only - omit. The composer's draft conversation the attachmentIds were uploaded against.

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

App only - omit. An id the app minted for the new chat: the session is stored under an id derived from it, and a repeat with the same value answers the chat already started.

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

App only - omit. An id the app minted for the first message: its transcript row is stored under an id derived from it.

CreateSessionWithFeatureRequestsBody

featureRequestIds
​string[] · minItems: 1 · required

Feature requests to launch the session from, in order. Each New or In Review request is promoted to a task; a request already promoted to a task reuses that task. The first request's task names the working branch.

The decision recorded for promoting the requests, when the workspace requires one for that transition. One decision is recorded for each request this call promotes; a request that reuses its task records none.

CreateSessionBody

name
​string · minLength: 1 · maxLength: 200
category
​string · enum
Enum values:
plan
live
scan
bugfix
scanObjective
​string · enum
Enum values:
application_detection
application_agentic_readiness
application_technical_documentation
application_architecture
feature_discovery
feature_discovery_deterministic
feature_deep_read
component_deep_read
description
​string

The session's description, in markdown: the plan document a person opening the session reads, and the brief a coding agent drafts its plan from. Nothing fills it in for you: it is not copied from the conversation or derived from the tasks, so a session created without it has an empty description. When a plan or approach was agreed, pass it here in full (goal, approach, decisions, constraints, how to tell it is done), opening with a one-line summary. With originChatId this is the only way to hand it over, because the plan is drafted during this call.

assigneeId
​string

Assign ONE user by UUID (the legacy single-assignee field; defaults to the creator). Use assignees to assign several people or a team.

​AssignmentTargetInput[] · maxItems: 20

REPLACES the item's whole assignee set: every user and team listed becomes an assignee, everything not listed is unassigned. Pass [] to unassign everyone. When both this and the legacy single-user field (assigneeId / ownerId) are supplied, this wins. Find a team's id with list-teams and a person's with list-assignable-users.

branchName
​string · maxLength: 256
tagName
​string
plannedDate
​string
relatedSessionId
​string
releaseId
​string
​
repositoryUrl
​string
originChatId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

The assistant conversation this session is being created FROM (the Conversation id in your context). Links the session to that conversation: its transcript becomes the coding agent's context, the conversation becomes team-visible and is latched to the session, and the session starts at once - a plan session drafts its plan, a live one starts its preview and sends firstMessage when it is up. Only the conversation's owner may pass it. Because the session starts at once, the create is refused (409, coding.local_agent_required) before anything is written when cloud sessions are turned off for the workspace and the person has no Productmind agent online: check-session-scope reports that first as the no_local_agent blocker.

Explicit repos to attach at create (from the quick-create repo picker). When provided (even empty) it is honored exactly and overrides the sandbox-derived repos; omit to derive repos from the sandbox.

applicationIds
​string[] · maxItems: 20

Applications whose repositories this session should work in, added on top of the ones the sandbox already reaches. Pass the ids the user pinned in the conversation when check-session-scope said the session would otherwise reach no repository. An application with no connected repository contributes nothing. Each one named here also runs in the session's sandbox, even when another sandbox lists it.

readOnlyApplicationIds
​string[] · maxItems: 20

Applications whose repositories this session should READ for context only: each is attached like applicationIds, but read-only in this session, so the coding agent reads its code and nothing is ever committed, pushed or opened as a pull request on it. A repository an application already makes read-only (its Read-only setting) stays read-only in every session, whether or not it is named here. An application in both lists is read-only.

featureIds
​string[] · maxItems: 20

Features this session builds directly, when no task or bug report scopes it: the feature the user is viewing, or one they named. Links the session to each: it appears on the feature's Sessions tab and in its lineage, and the coding agent is given the feature's specification. Each must be a feature in this workspace. Omit it for a session scoped by tasks or bug reports; it reaches their features through them.

firstMessage
​string · minLength: 1

Category live only. The first instruction for the coding agent: what to build or change first, in the user's terms. The session's preview starts at once, and this message is sent to the agent as its first live edit the moment the preview is ready, together with this conversation as context. Required for a Live handoff; refused on any other category. Like originChatId, it starts work in this request, so the create is refused (409, coding.local_agent_required) when cloud sessions are turned off for the workspace and the person has no Productmind agent online.

startPreview
​boolean

App only, omit. Category live only. Starts the session's preview in this request with no firstMessage; held to the same checks as firstMessage.

firstMessageAttachmentIds
​string[] · maxItems: 10

App only - omit. Images for firstMessage, uploaded by the composer against its draft conversation (draftChatId) and moved onto the session.

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

App only - omit. The composer's draft conversation the firstMessageAttachmentIds were uploaded against. They are moved onto the session when it holds no message, and copied otherwise.

​object

App only - omit. Where a Live session's preview runs, as the composer resolved it. Omitted, the server picks: an online local agent, else the cloud. cloud is refused (409) while cloud sessions are turned off for the workspace.

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

App only - omit. An id the app minted for the new session: the session is stored under an id derived from it, and a repeat with the same value answers the session already made.

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

App only - omit. Category live with firstMessage only. An id the app minted for the first message: it is delivered under an id derived from it.

deferPreviewStart
​boolean

App only - omit. Category live only. Hold the first message but leave the preview to a preview/start call the app makes next.

BulkDeleteSessionsBody

ids
​string[] · minItems: 1 · required

UpdateSessionBody

name
​string · minLength: 1 · maxLength: 200
category
​string · enum
Enum values:
plan
live
scan
bugfix
​

Set the single USER assignee (legacy field): replaces the session's user assignees with this one, null unassigns every user. Team assignees are left untouched — use assignees to change them.

​AssignmentTargetInput[] · maxItems: 20

REPLACES the item's whole assignee set: every user and team listed becomes an assignee, everything not listed is unassigned. Pass [] to unassign everyone. When both this and the legacy single-user field (assigneeId / ownerId) are supplied, this wins. Find a team's id with list-teams and a person's with list-assignable-users.

​

Rename the session's working branch. Every attached repository's working branch moves with it, so the next turn pushes the new name (use it when the git host's branch rules refused the old one). Refused (409) once a repository has a pull request or a pushed branch, while a run is in flight, and when clearing it while repositories are attached.

​
pullRequestUrls
​string[]
​
​
​
​
​

AddSessionItemsBody

​object[] · minItems: 1 · required
exclusive
​boolean

When true, each item is first detached from every other session it belongs to (same item type) before being attached here - i.e. 'move' instead of 'add'. Without it, a task another started session holds is refused with 409 task_in_active_session (a task works in one session at a time): pass true to move it here, after asking the person.

CancelSessionBody

discardPlan
​boolean

Snapshot the drafted plan into Document history, then clear the session description

DraftSessionPlanBody

mode
​string · enum

Build mode to lock in before dispatch (cloud | codeflow_local)

Enum values:
cloud
local
codeflow_local
codeflowInstanceId
​string

Target local Productmind agent instance id (required when mode = codeflow_local)

DraftPlanFromChatBody

RetrySessionRunBody

mode
​string · enum

Build mode to lock in before dispatch (cloud | codeflow_local)

Enum values:
cloud
local
codeflow_local
codeflowInstanceId
​string

Target local Productmind agent instance id (required when mode = codeflow_local)

RestartSessionRunBody

ResumeSessionBody

mode
​string · enum

Build mode to lock in before dispatch (cloud | codeflow_local)

Enum values:
cloud
local
codeflow_local
codeflowInstanceId
​string

Target local Productmind agent instance id (required when mode = codeflow_local)

ClaimSessionBody

RequestSessionTranscriptUploadBody

client
​string · enum

The coding agent you are running in: claude_code (Claude Code), codex (Codex CLI or IDE extension) or copilot (GitHub Copilot CLI, or Copilot Chat agent mode in VS Code). Narrows where the command looks for your transcript; omit it when unsure and every supported location is searched.

Enum values:
claude_code
codex
copilot
shell
​string · enum

The shell your command tool runs: posix (the default: macOS, Linux, WSL, and the Git Bash Claude Code uses on Windows) or powershell (Windows PowerShell or PowerShell 7).

Enum values:
posix
powershell

ImportSessionTranscriptBody

SessionInteractionOption

value
​string · minLength: 1 · maxLength: 120 · required
label
​string · minLength: 1 · maxLength: 200 · required
description
​string · maxLength: 2000
recommended
​boolean

Set true on the option you recommend (put it first). The app labels it Recommended and picks it in advance, so the user can accept it with one click. Omit it when you have no recommendation; on a single-choice question flag at most one.

RespondToSessionInteractionBody

selected
​string[]
customText
​string · maxLength: 4000
​object
decision
​string · enum
Enum values:
approve
request_changes
decline
readOnly
​boolean
note
​string · maxLength: 2000

SessionInteractionAnswer

selected
​string[] · required
customText
​string · maxLength: 4000

AnswerPlanQuestionsBody

commentIds
​string[] · maxItems: 50

PromotePlanQuestionBody

AnswerPrQuestionsBody

commentIds
​string[] · maxItems: 50

PromotePrQuestionBody

QueuePrReviewChangeBody

content
​string · minLength: 1 · maxLength: 4000 · required

Your reply in the thread, plain text (no markdown): one to three short lines saying what you will change. It is posted as your answer, and the thread joins the review queue that Apply code revisions sends.

SessionRunErrorBugFixBody

RespondToCiChangeBody

decision
​string · enum · required

approve commits every open entry onto its branch; decline leaves the pull request without them

Enum values:
approve
decline

AttachSessionRepoBody

workforceConnectorId
​string · minLength: 1 · required
externalRepoId
​string · minLength: 1 · required
repoName
​string · minLength: 1 · required
repoUrl
​string · minLength: 1 · required
provider
​string
baseBranch
​string · minLength: 1
workingBranch
​string · maxLength: 256
readOnly
​boolean

true attaches the repository for context only: read-only in this session, never committed, pushed or opened as a pull request on. Leave it out to inherit: a repository is read-only anyway when an application on it is.

AttachSessionApplicationsBody

applicationIds
​string[] · minItems: 1 · maxItems: 20 · required

Applications in this workspace whose repositories the session should work in. Each must have a repository connected; a repository the session already has is skipped. Each one also runs in the session's sandbox, even when another sandbox lists it.

readOnly
​boolean

true attaches these repositories for context only: read-only in this session, never committed, pushed or opened as a pull request on. Leave it out to inherit each application's own Read-only setting.

UpdateSessionRepoBody

baseBranch
​string · minLength: 1
​
​

The session's own read-only mark: true makes the repository read-only in this session, false makes it writable again, null clears the mark. A repository an application on it makes read-only stays read-only: false is refused there.

SessionDepartingRepositoryActionBody

UpdateSessionPullRequestDescriptionBody

url
​string · uri · required

HTML URL of the pull request whose description to write

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.

SessionApprovePullRequestBody

url
​string · uri · required

HTML URL of the pull request to act on

force
​boolean

Merge even when the pull request's checks are not green. Skips the CI gate but NOT the provider's own branch protection — a merge the provider refuses still fails.

headSha
​string · pattern: ^[0-9a-f]{7,40}$

The head commit SHA of the pull request as you reviewed it. When given, the merge is refused (409) if the pull request's head has moved since, and the provider is asked to merge exactly that commit. Required for Productmind support access.

SessionPullRequestActionBody

url
​string · uri · required

HTML URL of the pull request to act on

SessionPullRequestCheckRerunBody

url
​string · uri · required

HTML URL of the pull request to act on

externalId
​string · pattern: ^\d{1,20}$ · required

The check to re-run: the externalId of a row from the pull request's checks list (a GitHub check-run id or a GitLab pipeline id).

SessionPullRequestMergeTargetBody

url
​string · uri · required

HTML URL of the pull request to act on

resolveConflicts
​boolean · required

true: if merging the target branch in conflicts, the agent resolves the conflicts in a new turn and pushes a merge commit. false: a conflict ends the turn with nothing pushed and the conflicted files listed.

OpenPullRequestBody

repoName
​string · minLength: 1 · required

Repository name (matches a session repo)

title
​string · minLength: 1 · required

Pull request title

body
​string

Pull request body (markdown)

MergeSessionDocProposalsBody

​object[] · maxItems: 100

MergeSessionFeatureProposalsBody

​object[] · maxItems: 100

DeploySessionBody

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

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

deployedBy
​string
buildUrl
​string
notes
​string

CreateSessionDeploymentBody

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
tagName
​string
deployedBy
​string
deployedAt
​string
status
​string · enum
Enum values:
merged
pending
deployed
failed
skipped
rolled_back
buildUrl
​string
pullRequestUrl
​string
notes
​string

UpdateSessionDeploymentBody

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

StartSessionPreviewBody

sandboxId
​string
ttlSeconds
​integer · min: 300 · max: 28800
idleTimeoutSeconds
​integer · min: 0 · max: 28800
mode
​string · enum
Enum values:
cloud
local
codeflow_local
codeflowInstanceId
​string

SetSettingBody

value
​

CreateTagBody

entity
​string · enum · required
Enum values:
account
feature_request
bug_report
feature
task
session
release
customer_interaction
entityId
​string · minLength: 1 · required
name
​string · minLength: 1 · maxLength: 40 · required

The tag's name. Saved lowercase-with-hyphens: lowercased, every run of characters that is not a letter or digit becomes one hyphen, trimmed of hyphens and capped at 40 characters (Billing & Payments is saved as billing-payments). A name the entity already carries in any spelling (Billing for billing) reuses that tag. A name with no letter or digit is refused.

TagGenerateBody

entity
​string · enum · required
Enum values:
account
feature_request
bug_report
feature
task
session
release
customer_interaction
entityIds
​string[] · minItems: 1 · maxItems: 50 · required

TagSuggestionsAcceptBody

entity
​string · enum · required
Enum values:
account
feature_request
bug_report
feature
task
session
release
customer_interaction
entityIds
​string[] · minItems: 1 · maxItems: 200 · required
includeNewNames
​boolean
Default: false

TagSuggestionNameBody

entity
​string · enum · required
Enum values:
account
feature_request
bug_report
feature
task
session
release
customer_interaction
name
​string · minLength: 1 · maxLength: 40 · required

The proposed name exactly as listed by the new-names read: matched as stored, so a suggestion staged before the lowercase-with-hyphens rule stays reviewable.

GitConnectionWebhooksEnsureBody

GitConnectorRebindBody

SetEmailPreferencesBody

optedOut
​boolean · required

AgentContextDTO

id
​string · required
workspaceId
​string · required
type
​string · enum · required
Enum values:
context
skill
title
​string · required
sortOrder
​number · required
​
​
​
​
isStandard
​boolean
isCustomized
​boolean
createdAt
​string
updatedAt
​string

AgentDefinitionDTO

id
​string · required
workspaceId
​string · required
slug
​string · required
name
​string · required
instructions
​string · required
version
​number · required
enabled
​boolean · required
​AgentDefinitionModelOutput · required
tools
​string[] · required
​AgentDefinitionMcpServerOutput[] · required
​AgentDefinitionSettingsOutput · required
toolsRequiringApproval
​string[] · required
origin
​string · enum · required
Enum values:
standard
customized
custom
asyncEligible
​boolean · required
​
​
createdAt
​string
updatedAt
​string

AgentToolCatalogEntry

name
​string · required
source
​string · enum · required
Enum values:
builtin
mcp
mutating
​boolean · required
asyncEligible
​boolean · required
description
​string

WorkspaceModelClassesDTO

platformRuntime
​string · enum · required
Enum values:
claude-api
bedrock
codex
canEdit
​boolean · required
​WorkspaceModelClassModelDTO[] · required
platformCodexModelIds
​string[] · required
​WorkspaceModelClassTierDTO[] · required

WorkspaceModelClassModelDTO

modelId
​string · required
displayName
​string · required
​required
isActive
​boolean · required

WorkspaceModelClassTierDTO

modelClass
​string · enum · required
Enum values:
quick
standard
top
ultra
​WorkspaceModelClassCellDTO[] · required

WorkspaceModelClassCellDTO

runtime
​string · enum · required
Enum values:
claude-api
codex
customized
​boolean · required
​required
​required
​WorkspaceModelClassEntryDTO[] · required
​WorkspaceModelClassPlatformEntryDTO[] · required

WorkspaceModelClassEntryDTO

modelId
​string · required
rank
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​required
​required
maxEffortCustomized
​boolean · required
available
​boolean · required
​required

WorkspaceModelClassPlatformEntryDTO

modelId
​string · required
​required

AutomationDTO

id
​string · required
workspaceId
​string · required
name
​string · required
enabled
​boolean · required
​AutomationTriggerOutput · required
​AutomationConditionsOutput · required
​AutomationActionOutput · required
​AutomationLimitsOutput · required
runAsUserId
​string · required
consecutiveFailures
​number · required
​
​
​
​
​
​
​
createdAt
​string
updatedAt
​string

AutomationRunSummary

id
​string · required
status
​string · enum · required
Enum values:
queued
running
succeeded
failed
skipped
createdAt
​string · required
​
​

AutomationRunResult

status
​string · required
runId
​string
reason
​string
reasonCode
​string

ConditionVerdict

matched
​boolean · required

Whether the rule would fire. Un-checkable leaves count as a pass

unevaluable
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​ConditionLeafVerdict[] · required

ConditionLeafVerdict

index
​integer · min: -9007199254740991 · max: 9007199254740991 · required

Depth-first position among the rule's condition leaves

field
​string · required
operator
​string · enum · required
Enum values:
equals
notEquals
contains
in
isEmpty
isNotEmpty
changed
changedTo
outcome
​string · enum · required
Enum values:
matched
unmatched
unevaluable
actual
​string

What the entity actually held

reason
​string

Why the condition could not be answered

AutomationCheckResult

​ConditionVerdict · required
entityType
​string · enum
Enum values:
feature
feature_request
bug_report
task

AutomationTestEntity

id
​string · required
title
​string · required
key
​string
status
​string
​object

AutomationRunDTO

id
​string · required
workspaceId
​string · required
agentSlug
​string · required
triggerType
​string · enum · required
Enum values:
event
schedule
manual
status
​string · enum · required
Enum values:
queued
running
succeeded
failed
skipped
runAsUserId
​string · required
depth
​number · required
​
​
​
​
​
​
​
​
​
​
outputTruncated
​boolean
​
​
​
​
​
​
​
​
createdAt
​string
updatedAt
​string

CommentDTO

id
​string · required
entity
​string · enum · required
Enum values:
feature
task
feature_request
bug_report
session
customer_research
release
knowledge_base_document
entityId
​string · required
content
​string · required
​object · required
kind
​string · enum · required
Enum values:
comment
agent_action
agent_response
system
parentCommentId
​string
resolvedAt
​string
​object
authorKind
​string · enum
Enum values:
productmind_engineer
addressedTo
​string · enum
Enum values:
session_agent
pm_agent
​CommentAgentTurn
​CommentExternalAuthorDTO
createdAt
​string
updatedAt
​string

CommentAgentTurn

status
​string · enum · required
Enum values:
pending
running
answered
failed
stopped
mode
​string · enum · required
Enum values:
pm
code
requestedByUserId
​string · required
requestedAt
​string · required
startedAt
​string
finishedAt
​string
requestId
​string
chatId
​string
sessionId
​string
sessionDisplayId
​number
proposalId
​string
​object
answeredThroughAt
​string
​object
error
​string

CommentExternalAuthorDTO

source
​string · enum · required
Enum values:
preview_share
feedback_assistant
shareId
​string · required
viewerId
​string
name
​string
email
​string
interactionId
​string

DocumentPassageEditDTO

​object · required

The edit as the thread records it: Undo puts before back.

blocks
​string · required

The highlighted blocks as they read now, in markdown.

DecisionDTO

id
​string · required
entity
​string · enum · required
Enum values:
feature_request
feature
entityId
​string · required
decisionType
​string · enum · required
Enum values:
transition
general
outcome
​string · enum · required
Enum values:
approved
rejected
deferred
conditional
decidedAt
​string · required
isSuperseded
​boolean · required
isCurrent
​boolean · required
​object[] · required
title
​string
toStatus
​string
rationale
​string
conditionalNotes
​string
decidedByUserId
​string
decidedByName
​string
decidedByUserName
​string
supersedesId
​string
createdAt
​string
updatedAt
​string

PolymorphicAttachmentDTO

id
​string · required
fileName
​string · required
url
​string · required
contentType
​string · required
fileSize
​number · required
​object · required
entity
​string · enum · required
Enum values:
feature
task
feature_request
bug_report
session
customer_research
customer_interaction
release
entityId
​string · required
​
​
createdAt
​string
updatedAt
​string
origin
​string · enum
Enum values:
user
agent
visibility
​string · enum
Enum values:
workspace
public
​

WorkspaceDTO

id
​string · required
name
​string · required
description
​string · required
status
​string · enum · required
Enum values:
active
deleted
​

The workspace's logo image URL, or null when it has none

organizationId
​string
​
​
​
​
​
​ProductConfig
​

Your own role on this workspace: owner, admin or member

OnboardingSteps

introduction
​boolean
verification
​boolean
application
​boolean
plan
​boolean
productContext
​boolean
tasks
​boolean
code
​boolean
codingAgents
​boolean
slack
​boolean
payment
​boolean
review
​boolean

OnboardingProfile

buildIntent
​string · enum
Enum values:
template
existing
teamSize
​string · enum
Enum values:
1-10
11-50
51+
​
​
​object[] · maxItems: 50

ProductConfig

​object · required

FeatureListItemDTO

id
​string · required
displayId
​number · required
workspaceId
​string · required
kind
​string · enum · required
Enum values:
domain
feature
component
title
​string · required
priority
​string · enum · required
Enum values:
low
high
critical
status
​string · enum · required
Enum values:
backlog
planned
in_development
stable
deprecated
sortOrder
​number · required
parentFeatureId
​string
layer
​string · enum
Enum values:
frontend
backend
data
description
​string
requestingAccountId
​string
requestingContactId
​string
ownerId
​string
​object
​AssigneeRefDTO[]
estimatedEffort
​string · enum
Enum values:
__none__
xs
s
m
l
xl
targetDate
​string
externalSource
​string
externalId
​string
externalSourceUrl
​string
descriptionEnrichmentStatus
​string · enum
Enum values:
pending
enriched
subFeatureCount
​number
​LinkedApplicationDTO[]
​CreatedFromNoteDTO
​CreatedFromBugReportDTO
​FeatureViewerAccess
restricted
​boolean

True on a placeholder for a private feature the caller cannot see: its title is withheld and nothing of its content is included.

createdAt
​string
updatedAt
​string
​FeatureBreadcrumbDTO
tags
​string[]
suggestedTagCount
​integer · min: -9007199254740991 · max: 9007199254740991
specificationState
​string · enum

Where the feature's specification stands: 'queued' (a deep dive is dispatched, no agent has picked it up yet), 'scanning' (an agent is reading the code now), 'awaiting_review' (a proposed rewrite is waiting on a human), 'pending' (created by the repository map pass, no specification written yet). Absent when there is nothing to say. Populated by the list endpoint only.

Enum values:
queued
scanning
awaiting_review
pending
failed
specificationProposalId
​string

Id of the in-flight FeatureDescriptionProposal behind specificationState. Present only while that state is 'queued' or 'scanning' — it is what a Stop affordance cancels. Populated by the list endpoint only.

specificationSource
​string · enum

Which flow produced the in-flight proposal behind specificationState: a scan of the code ('refresh', 'deep_dive', 'composition', 'discovery') or a revision from review comments ('review'). Present only while specificationState is 'queued' or 'scanning'. Populated by the list endpoint only.

Enum values:
discovery
refresh
deep_dive
composition
session
review
chat
comment
specificationError
​string

Why the last run failed. Present only when specificationState is 'failed' — it is what lets a list row say what broke instead of only that something did. Populated by the list endpoint only.

specificationStartedById
​string

Id of the user who started the in-flight scan. Present only while specificationState is 'queued' or 'scanning', and only when the scan recorded who started it. Populated by the list endpoint only.

​object

The user who started the in-flight scan (name and avatar). Present only while specificationState is 'queued' or 'scanning'. Populated by the list endpoint only.

​FeatureScanRunnerDTO

Where the in-flight scan runs: its scan session's build mode, status and local agent name. Present only while specificationState is 'queued' or 'scanning'. Populated by the list endpoint only.

​FeatureCompletedScanDTO

The scan of the code that finished last and where it ran: its proposal id and its scan session's build mode, status and local agent name. Present for 24 hours after the run ended, while the latest proposal is that scan with its result waiting for review or applied; absent after a scan that failed, was stopped or was dismissed, after a later change that is not a scan, and while a new scan is queued or running. Populated by the list endpoint only.

deepScanStatus
​string · enum

Whether a scan of the code has written this feature's specification: 'scanned' (it has), 'awaiting_review' (a scan's draft is waiting for review, even when an earlier scan already wrote one), or 'not_scanned' (no scan has written one yet). The value the deepScan filter matches. Populated by the list endpoint only.

Enum values:
scanned
awaiting_review
not_scanned

AssigneeRefDTO

entityType
​string · enum · required
Enum values:
user
team
id
​string · required
​object

TeamBaseDTO

id
​string · required
name
​string · required

LinkedApplicationDTO

id
​string · required
name
​string · required
​
​
​
​
​
​
​
codePathCount
​integer · min: -9007199254740991 · max: 9007199254740991
entryPointCount
​integer · min: -9007199254740991 · max: 9007199254740991

LinkedServiceDTO

id
​string · required
name
​string · required
kind
​string · enum · required
Enum values:
service
database
object_store
search_index
queue
cache
third_party_api
other
layer
​string · enum · required
Enum values:
frontend
backend
data
external
​required
​required
source
​string · enum · required
Enum values:
manual
folder
​required

CreatedFromNoteDTO

id
​string · required
title
​string
​

CreatedFromBugReportDTO

id
​string · required
title
​string · required
displayId
​number

FeatureViewerAccess

isPrivate
​boolean · required

True when the feature is private: it, or a feature above it, lists the teams that may see it.

canEdit
​boolean · required

The caller may edit the feature: fields, document, status, links, business rules, and reviewing proposals.

canDelete
​boolean · required

The caller may delete the feature.

canAddSubFeature
​boolean · required

The caller may create a sub-feature under it.

canManageAccess
​boolean · required

The caller may change which teams can see and edit the feature.

FeatureBreadcrumbDTO

id
​string · required
displayId
​number · required
title
​string · required
kind
​string · enum
Enum values:
domain
feature
component
parentFeatureId
​string
restricted
​boolean
​FeatureBreadcrumbDTO

FeatureScanRunnerDTO

status
​string · enum · required
Enum values:
in_planning
planning
awaiting_user_input
awaiting_plan_approval
plan_approved
building
in_progress
paused
​
​
​

FeatureCompletedScanDTO

proposalId
​string · required
​FeatureScanRunnerDTO · required

FeatureDTO

id
​string · required
displayId
​number · required
workspaceId
​string · required
kind
​string · enum · required
Enum values:
domain
feature
component
title
​string · required
priority
​string · enum · required
Enum values:
low
high
critical
status
​string · enum · required
Enum values:
backlog
planned
in_development
stable
deprecated
sortOrder
​number · required
parentFeatureId
​string
layer
​string · enum
Enum values:
frontend
backend
data
description
​string
requestingAccountId
​string
requestingContactId
​string
ownerId
​string
​object
​AssigneeRefDTO[]
estimatedEffort
​string · enum
Enum values:
__none__
xs
s
m
l
xl
targetDate
​string
externalSource
​string
externalId
​string
externalSourceUrl
​string
descriptionEnrichmentStatus
​string · enum
Enum values:
pending
enriched
subFeatureCount
​number
​LinkedApplicationDTO[]
​CreatedFromNoteDTO
​CreatedFromBugReportDTO
​FeatureViewerAccess
restricted
​boolean

True on a placeholder for a private feature the caller cannot see: its title is withheld and nothing of its content is included.

createdAt
​string
updatedAt
​string
descriptionLexical
​
descriptionUpdatedAt
​string
descriptionVersion
​number
mentionedUserIds
​string[]
​FeatureBreadcrumbDTO
​FeatureListItemDTO[]
​AccountDTO
​ContactDTO
tags
​string[]
suggestedTagCount
​integer · min: -9007199254740991 · max: 9007199254740991

AccountDTO

id
​string · required
organizationId
​string · required
name
​string · required
accountType
​string · enum · required
Enum values:
internal
customer
partner
other
website
​string
notes
​string
sourceType
​string · enum
Enum values:
manual
feedback_stream
research_interview
crm_import
sourceId
​string
externalSource
​string

Which external system this record was imported from.

externalId
​string · minLength: 1 · maxLength: 255

The CRM's own id for this record — people/c123…, 701.

externalSourceUrl
​string · uri

Deep link back to the record in the CRM.

isStrategic
​boolean
estimatedArr
​number
lifecycleState
​string · enum
Enum values:
prospect
trial
customer
expansion
at_risk
churned
tags
​string[]
suggestedTagCount
​integer · min: -9007199254740991 · max: 9007199254740991
​ContactDTO[]
contactCount
​number
createdAt
​string
updatedAt
​string

ContactDTO

id
​string · required
accountId
​string · required
name
​string · required
isPrimary
​boolean · required
accountName
​string
email
​string
title
​string
phone
​string
sourceType
​string · enum
Enum values:
manual
feedback_stream
research_interview
crm_import
sourceId
​string
externalSource
​string

Which external system this record was imported from.

externalId
​string · minLength: 1 · maxLength: 255

The CRM's own id for this record — people/c123…, 701.

externalSourceUrl
​string · uri

Deep link back to the record in the CRM.

lastContactedAt
​string
​
​
​
createdAt
​string
updatedAt
​string

FindFeaturesByCodePathsResult

​FeatureCodePathMatch[] · required
​object[] · required
unknownRepos
​string[] · required

FeatureCodePathMatch

​object · required
​object[] · required

FeatureDeleteImpactDTO

subFeatureCount
​integer · min: 0 · max: 9007199254740991 · required

Sub-features deleted with the feature, at any depth. The feature itself is not counted.

taskCount
​integer · min: 0 · max: 9007199254740991 · required

Distinct tasks deleted with the feature and its sub-features, subtasks included.

FeatureRequestDTO

id
​string · required
displayId
​number · required
workspaceId
​string · required
title
​string · required
description
​string · required
priority
​string · enum · required
Enum values:
low
high
critical
status
​string · enum · required
Enum values:
new
in_review
rejected
merged
promoted
source
​string · enum · required
Enum values:
internal_stakeholders
customer_feedback
market_signal
strategic_directive
support_pattern
competitive_intelligence
sortOrder
​number · required
interestCount
​number
tags
​string[]
suggestedTagCount
​integer · min: -9007199254740991 · max: 9007199254740991
estimatedEffort
​string · enum
Enum values:
__none__
xs
s
m
l
xl
assigneeId
​string
​object
​AssigneeRefDTO[]
​CreatedFromNoteDTO
​CreatedFromBugReportDTO
createdAt
​string
updatedAt
​string

FeatureRequestInterestDTO

id
​string · required
source
​string · enum · required
Enum values:
internal_stakeholders
customer_feedback
market_signal
strategic_directive
support_pattern
competitive_intelligence
hasSourceUpdates
​boolean · required
sourceEntityId
​string
sourceItemId
​string
sourceTimestampAtImport
​string
sourceName
​string
sourceDescription
​string
sourceNavigationUrl
​string
description
​string
sentiment
​string · enum
Enum values:
negative
neutral
positive
requestingAccountId
​string
​AccountDTO
requestingContactId
​string
​ContactDTO
position
​string · enum
Enum values:
supporting
opposing
neutral
conditional
conditionalNotes
​string
stakeholderRole
​string · enum
Enum values:
marketing
leadership
engineering
design
sales
customer_support
customer_engineering
finance
stakeholderUserId
​string
stakeholderName
​string
weight
​number
createdAt
​string

FeatureRequestLinkedEntity

id
​string · required
displayId
​number · required
title
​string · required
entityType
​string · required
relationshipType
​string · required
restricted
​boolean
kind
​string · enum
Enum values:
domain
feature
component
layer
​string · enum
Enum values:
frontend
backend
data
externalSource
​string
taskType
​string · enum
Enum values:
task
subtask
source
​string · enum
Enum values:
internal_stakeholders
customer_feedback
market_signal
strategic_directive
support_pattern
competitive_intelligence

BugReportSessionSummaryDTO

id
​string · required
name
​string · required
category
​string · enum · required
Enum values:
plan
live
scan
bugfix
code_chat
status
​string · enum · required
Enum values:
in_planning
planning
awaiting_user_input
awaiting_plan_approval
plan_approved
building
in_progress
paused
displayId
​number

FeatureRequestRelationshipDTO

id
​string · required
targetType
​string · required
targetId
​string · required
relationshipType
​string · required
displayId
​number
title
​string
targetKind
​string
restricted
​boolean

FeatureRequestAccountDTO

id
​string · required
name
​string · required

FeatureRequestAccountInterestDTO

count
​number · required
latestAt
​string
dominantSentiment
​string · enum
Enum values:
negative
neutral
positive

FeatureLogDTO

id
​string · required
content
​string · required
​object · required
createdAt
​string
updatedAt
​string

FeatureAccessDTO

featureId
​string · required
restricted
​boolean · required

True when the feature is private, through its own list or a list on a feature above it.

​required

The nearest feature above this one whose list governs it, when this feature has no list of its own.

​FeatureAccessGrantDTO[] · required

This feature's own list. Empty when it has none.

​FeatureAccessGrantDTO[] · required

The list of the feature named in inheritedFrom. Empty when the feature has a list of its own or is open.

​FeatureViewerAccess · required
​object · required

The sub-features below this feature that do not simply follow its list. A change to this feature's list can make the changeable ones follow it (subFeatures: follow).

FeatureAccessSource

id
​string · required
displayId
​number · required
title
​string · required
kind
​string · enum · required
Enum values:
domain
feature
component

FeatureAccessGrantDTO

teamId
​string · required
level
​string · enum · required
Enum values:
view
edit
​required

The team, or null when it has been deleted. A grant to a deleted team keeps the feature private until it is removed.

FeatureAccessTeamRef

id
​string · required
name
​string · required
memberCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required

GenerateTasksResponse

​GeneratedTask[] · required

GeneratedTask

type
​string · enum · required
Enum values:
task
subtask
title
​string · required
priority
​string · enum · required
Enum values:
low
high
critical
description
​string · required
tags
​string[]

Layer tags for the task (e.g. backend, frontend, agent, test, docs, infra).

GeneratedFeatureDescription

​required

FeatureSearchResult

​FeatureListItemDTO · required
score
​number · required
​object[] · required
matchType
​string · enum · required

Which search path produced this hit: fulltext (PostgreSQL tsvector / SQLite LIKE — exact keyword), or semantic from the KB fallback (LanceDB — semantic-only for entity titles; score is absolute semantic similarity, comparable across queries; sub-floor hits are filtered server-side, so an empty list means no match).

Enum values:
fulltext
lexical
semantic
hybrid

FeatureVersionDTO

id
​string · required
featureId
​string · required
versionNumber
​number · required
title
​string · required
authorIds
​string[] · required
descriptionMarkdown
​string
​object[]
onBehalfOfUserId
​string

The person an agent author of this version worked for: who started its session, or who the integration acted for. Absent when a person saved it themselves.

​object

The person in onBehalfOfUserId. Absent when they no longer have an account.

summary
​string
createdAt
​string

FeatureVersionDetailDTO

id
​string · required
featureId
​string · required
versionNumber
​number · required
title
​string · required
authorIds
​string[] · required
descriptionMarkdown
​string
​object[]
onBehalfOfUserId
​string

The person an agent author of this version worked for: who started its session, or who the integration acted for. Absent when a person saved it themselves.

​object

The person in onBehalfOfUserId. Absent when they no longer have an account.

summary
​string
createdAt
​string
descriptionLexical
​

LinkedDocumentDTO

id
​string · required
title
​string · required
sourceType
​string · enum · required
Enum values:
system
upload
website
manual
connector
generated
repository
status
​string · enum · required
Enum values:
draft
scraping
processing
indexing
ready
error
deleting
​
​
sortOrder
​number
​
​

Where a repository-synced document comes from; null for every other document

LinkFeatureApplicationResult

​LinkedCodeSurfaceEcho[] · required
​object · required
storedSurfaceNote
​string · required

LinkedCodeSurfaceEcho

applicationId
​string · required
name
​string · required
codePaths
​string[] · required
entryPoints
​string[] · required
manualCodePaths
​string[] · required
manualEntryPoints
​string[] · required
codePathCount
​number · required
entryPointCount
​number · required
​
​
​
​

FeatureCodeSurfaceDTO

applicationId
​string · required
name
​string · required
codePaths
​string[] · required
entryPoints
​string[] · required
manualCodePaths
​string[] · required
manualEntryPoints
​string[] · required
hiddenCodePaths
​string[] · required
​LinkedServiceDTO[] · required
manualSystemComponentIds
​string[] · required
hiddenSystemComponentIds
​string[] · required
​ArchitectureServiceDTO[] · required
​
​
​
​

ArchitectureServiceDTO

id
​string · required
name
​string · required
kind
​string · enum · required
Enum values:
service
database
object_store
search_index
queue
cache
third_party_api
other
layer
​string · enum · required
Enum values:
frontend
backend
data
external
​required
​required

FeatureDependencyLinkDTO

direction
​string · enum · required
Enum values:
uses
used_by
​object · required
​
​

FeatureBusinessRuleDTO

id
​string · required
featureId
​string · required
batchId
​string · required
​required
provenance
​string · enum · required
Enum values:
parsed
authored
inferred
ruleKey
​string · required
ruleNumber
​integer · min: -9007199254740991 · max: 9007199254740991 · required
sortOrder
​integer · min: -9007199254740991 · max: 9007199254740991 · required
title
​string · required
ruleText
​string · required
​required
​required
​required
enforcedAt
​string[] · required
​required
​required
​required
​FeatureBusinessRuleCitationDTOOutput[] · required
sourceDecisionIds
​string[] · required
verificationStatus
​string · enum · required
Enum values:
unverified
evidence_verified
verified
corrected
inferred
refuted
current
​boolean · required
createdAt
​string · required
updatedAt
​string · required
featureDisplayId
​integer · min: -9007199254740991 · max: 9007199254740991
featureTitle
​string
featureKind
​string · enum
Enum values:
domain
feature
component

SubmitBusinessRulesResult

batchId
​string · required
written
​integer · min: -9007199254740991 · max: 9007199254740991 · required
batchTotal
​integer · min: -9007199254740991 · max: 9007199254740991 · required
promoted
​boolean · required
skippedForLimit
​integer · min: -9007199254740991 · max: 9007199254740991 · required

FeatureRefreshDispatchDTO

​required
dispatchedComponentIds
​string[] · required
​object[] · required

FeatureDescriptionProposalDTO

id
​string · required
workspaceId
​string · required
featureId
​string · required
source
​string · enum · required
Enum values:
discovery
refresh
deep_dive
composition
session
review
chat
comment
kind
​string · enum · required
Enum values:
description
structure
status
​string · enum · required
Enum values:
queued
running
awaiting_review
approved
applied
dismissed
failed
​
​
​
​
​
​
​
​
​
​
draftStale
​boolean
​
​
​
​
​
​
​
​
​
​
​
​
​
​
createdAt
​string
updatedAt
​string

SpecAuditResultDTO

​object · required
​object[] · required
​object · required

ProposalUsageTotalsDTO

inputTokens
​number · required
outputTokens
​number · required
cacheReadTokens
​number · required
cacheWriteTokens
​number · required

FeatureReviewRevisionDTO

​FeatureDescriptionProposalDTO · required

FeatureRefreshStatusDTO

status
​string · enum · required
Enum values:
new_commits
up_to_date
unknown
newCommitCount
​integer · min: 0 · max: 9007199254740991 · required
capped
​boolean · required
​object[] · required

FeatureDescriptionProposalReceipt

id
​string · required
featureId
​string · required
source
​string · enum · required
Enum values:
discovery
refresh
deep_dive
composition
session
review
chat
comment
kind
​string · enum · required
Enum values:
description
structure
status
​string · enum · required
Enum values:
queued
running
awaiting_review
approved
applied
dismissed
failed
characters
​integer · min: -9007199254740991 · max: 9007199254740991 · required
guidance
​string · required
​
​
​
parksAutoApplyCodes
​string[]

FeatureRequestSearchResult

id
​string · required

Feature request UUID

title
​string · required
score
​number · required

Absolute semantic similarity (cosine-derived). Higher is better and scores ARE comparable across queries. Results below the server-side noise floor are filtered out.

matchType
​string · enum · required

Always "semantic" for KB-backed hits — entity title search runs semantic-only. Sub-floor hits are dropped server-side, so an empty list means no match.

Enum values:
lexical
semantic
hybrid

TaskParentDTO

entityType
​string · enum · required
Enum values:
feature
application
session
id
​string · required
title
​string · required
displayId
​number
kind
​string · enum
Enum values:
domain
feature
component
layer
​string · enum
Enum values:
frontend
backend
data
externalSource
​string
ownerId
​string
​object
​object
applicationType
​string
restricted
​boolean

FeatureRequestSourceSummaryDTO

source
​string · enum · required
Enum values:
internal_stakeholders
customer_feedback
market_signal
strategic_directive
support_pattern
competitive_intelligence
sourceEntityId
​string · required
sourceItemId
​string · required
sourceName
​string · required
navigationUrl
​string · required
isSourceAvailable
​boolean · required
importedAt
​string
sourceDescription
​string
​object

FeatureRequestLogDTO

id
​string · required
content
​string · required
​object · required
createdAt
​string
updatedAt
​string

FeatureRequestDescriptionProposalDTO

id
​string · required
workspaceId
​string · required
featureRequestId
​string · required
source
​string · enum · required
Enum values:
auto
manual
status
​string · enum · required
Enum values:
queued
running
awaiting_review
applied
dismissed
failed
​
​
​
​
​

Why the run declined to write anything, when it settled failed with sufficientContext false and the AI named a reason. Null otherwise.

​
​
​
​
​
createdAt
​string
updatedAt
​string

BugReportDTO

id
​string · required
displayId
​number · required
workspaceId
​string · required
title
​string · required
priority
​string · enum · required
Enum values:
low
high
critical
severity
​string · enum · required
Enum values:
minor
major
critical
blocker
status
​string · enum · required
Enum values:
open
in_review
confirmed
in_progress
resolved
closed
merged
sortOrder
​number · required
description
​string
reporterCount
​number
assigneeId
​string
​object
​AssigneeRefDTO[]
tags
​string[]
suggestedTagCount
​integer · min: -9007199254740991 · max: 9007199254740991
​BugReportConvertedEntityDTO
​CreatedFromNoteDTO
​BugReportLinkedEntity
createdAt
​string
updatedAt
​string

BugReportReporterDTO

id
​string · required
type
​string · enum · required
Enum values:
workspace_member
contact
reporterId
​string · required
name
​string · required
email
​string
avatarUrl
​string
initials
​string
details
​string
createdAt
​string

BugReportRelationshipDTO

id
​string · required
targetType
​string · required
targetId
​string · required
relationshipType
​string · required
displayId
​number
title
​string
targetKind
​string

BugReportConvertedEntityDTO

entityType
​string · enum · required
Enum values:
task
feature
feature_request
id
​string · required
title
​string · required
displayId
​number
status
​string
restricted
​boolean

BugReportLinkedEntity

id
​string · required
title
​string · required
entityType
​string · required
relationshipType
​string · required
displayId
​number

InterestDTO

id
​string · required
entity
​string · enum · required
Enum values:
bug_report
entityId
​string · required
source
​string · enum · required
Enum values:
internal_stakeholders
customer_feedback
market_signal
strategic_directive
support_pattern
competitive_intelligence
hasSourceUpdates
​boolean · required
sourceEntityId
​string
sourceItemId
​string
sourceTimestampAtImport
​string
sourceName
​string
sourceDescription
​string
sourceNavigationUrl
​string
description
​string
sentiment
​string · enum
Enum values:
negative
neutral
positive
requestingAccountId
​string
​AccountDTO
requestingContactId
​string
​ContactDTO
stakeholderRole
​string · enum
Enum values:
marketing
leadership
engineering
design
sales
customer_support
customer_engineering
finance
stakeholderUserId
​string
stakeholderName
​string
createdAt
​string

ConvertBugReportResponse

entityType
​string · enum · required
Enum values:
task
feature
feature_request
​BugReportConvertedEntityDTO · required
​BugReportDTO · required
created
​boolean · required

BugReportDescriptionProposalDTO

id
​string · required
workspaceId
​string · required
bugReportId
​string · required
source
​string · enum · required
Enum values:
auto
manual
status
​string · enum · required
Enum values:
queued
running
awaiting_review
applied
dismissed
failed
​
​
​
​
​

Why the run declined to write anything, when it settled failed with sufficientContext false and the AI named a reason. Null otherwise.

​
​
​
​
​
​
createdAt
​string
updatedAt
​string

StartTaskWorkResponse

​__schema0[] · required
​FeatureDTO
​SessionDTO

SessionDTO

id
​string · required
workspaceId
​string · required
name
​string · required
category
​string · enum · required
Enum values:
plan
live
scan
bugfix
code_chat
status
​string · enum · required
Enum values:
in_planning
planning
awaiting_user_input
awaiting_plan_approval
plan_approved
building
in_progress
paused
autonomous
​boolean · required
Default: false
pullRequestUrls
​string[] · required
Default: []
chatId
​string
displayId
​number
releaseId
​string
​
description
​string
descriptionLexical
​
descriptionUpdatedAt
​string
descriptionVersion
​number
mentionedUserIds
​string[]
​
​
​
​
​
​
​object
​
​
​
assigneeId
​string
​object
​AssigneeRefDTO[]
branchName
​string
tagName
​string
repositoryUrl
​string
hasCommits
​boolean
​SessionPullRequestFailure[]
interruptSeq
​number
​
interruptReason
​string · enum
Enum values:
user
insufficient_credit
usage_limit
restart
preview_stop
​
​
​
​
​
dispatchRunKind
​string
retryContinuesBuild
​boolean
retryContinuesRevision
​boolean
retryContinuesPlanRevision
​boolean
​
​
​
transportPinned
​boolean
​
​
​
​
​
​object
phase
​string · enum
Enum values:
plan_starting
plan_drafting
plan_awaiting_input
plan_finalizing
build_starting
build_provisioning
build_pulling_image
build_cloning
claudeSessionId
​string
planApprovedAt
​string
planApprovedById
​string
planApprovedMatchesDescription
​boolean
planUnchangedSinceApproval
​boolean
​
plannedDate
​string
relatedSessionId
​string
createdBy
​string
updatedBy
​string
scopeSeq
​integer · min: 0 · max: 9007199254740991
​SessionDepartingRepositoryDTO[]
​
tags
​string[]
suggestedTagCount
​integer · min: -9007199254740991 · max: 9007199254740991
createdAt
​string
updatedAt
​string
​

SessionSandboxSummary

id
​string · required
name
​string · required
​

SessionScanSubject

kind
​string · enum · required
Enum values:
feature
applications
feature_map
​
​
​
​
​
​
repositories
​string[]
rescan
​boolean
​

SessionScanAccess

log
​boolean · required
instructions
​boolean · required
stop
​boolean · required
​

SessionPullRequestFailure

repoName
​string · required
step
​string · enum · required
Enum values:
commit
push
open_pull_request
error
​string · required
pullRequestOwed
​boolean · required
at
​string · required
code
​string · enum
Enum values:
workflows_permission
ci_change_report_failed
ci_change_too_large
ci_change_unsupported
credit_stopped
awaiting_answer
run_failed
preview_stopped
paths
​string[]

SessionPublishFailureKept

head
​string · pattern: ^(?:[0-9a-f]{40}|[0-… · required
commits
​integer · min: 1 · max: 9007199254740991 · required
stored
​boolean · required

SessionCreditStop

at
​string · required
balanceCents
​integer · min: -9007199254740991 · max: 9007199254740991 · required
thresholdCents
​integer · min: -9007199254740991 · max: 9007199254740991 · required
currency
​string · required

SessionUsageLimitStop

at
​string · required
​object · required
message
​string · required
​required

SessionBillingRefusal

code
​string · enum · required
Enum values:
billing.insufficient_credit
billing.payg_activation_required
billing.spending_paused
billing.usage_limit_reached
at
​string · required

SessionGitAccessFailure

code
​string · enum · required
Enum values:
github_installation_not_found
github_installation_suspended
at
​string · required

SessionRunFailure

​required
code
​string · required
stage
​string · required
title
​string · required
message
​string · required
​required
occurredAt
​string · required

SessionTargetMerge

pullRequestUrl
​string · required
repoName
​string · required
targetBranch
​string · required
resolveConflicts
​boolean · required
requestedAt
​string · required
​

SessionPlanQuestion

state
​string · enum · required
Enum values:
running
failed
commentIds
​string[] · required
startedAt
​string · required
target
​string · enum
Enum values:
plan
pull_request
​
​
​

SessionPreviewReview

commentIds
​string[] · required
startedAt
​string · required

SessionCodeflowExecutor

status
​string · enum · required
Enum values:
queued
launching
running
​required

SessionSpendingPause

state
​string · enum · required
Enum values:
not_started
running
pausedAt
​string · required

SessionCiAutofixSummary

enabled
​boolean · required
attempts
​integer · min: -9007199254740991 · max: 9007199254740991 · required
maxAttempts
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​required
​required
​
​
​

SessionRunTimeSummary

agentMs
​integer · min: 0 · max: 9007199254740991 · required
turnCount
​integer · min: 0 · max: 9007199254740991 · required
complete
​boolean · required
​required
​required
​required
​required

SessionInteractionDTO

id
​string · required
sessionId
​string · required
phase
​string · enum · required
Enum values:
plan
build
scan
kind
​string · enum · required
Enum values:
question
plan_approval
ci_change_approval
repository_request
question
​string · required
multiSelect
​boolean · required
Default: false
status
​string · enum · required
Enum values:
pending
answered
cancelled
superseded
claudeSessionId
​string
​SessionRepositoryRequest
​object
respondedById
​string
​object
respondedAt
​string
createdAt
​string
updatedAt
​string
awaitsViewer
​boolean

SessionInteractionQuestion

key
​string · minLength: 1 · maxLength: 20 · required
question
​string · minLength: 1 · maxLength: 4000 · required
​SessionInteractionOptionOutput[] · minItems: 2 · maxItems: 8 · required
multiSelect
​boolean · required
Default: false

SessionCiChangeOptions

version
​number · const · required
Const value: 1
​SessionCiChangeEntry[] · required
​required
​required
​required
contentsOmitted
​boolean

SessionCiChangeEntry

repoName
​string · required
sessionGitRepositoryId
​string · required
owner
​string · required
repo
​string · required
workingBranch
​string · required
referenceRef
​string · required
referenceSha
​string · required
originalHeadSha
​string · required
sanitizedHeadSha
​string · required
reportedAt
​string · required
status
​string · enum · required
Enum values:
pending
applied
declined
failed
cancelled
​required
​required
​SessionCiChangeFile[] · required
​
​
reportedHeadShas
​string[]

SessionCiChangeApplyError

code
​string · required
message
​string · required
at
​string · required

SessionCiChangeFile

path
​string · required
​required
​required
​required
afterSizeBytes
​integer · min: 0 · max: 9007199254740991 · required
​required

SessionRepositoryRequest

repoName
​string · minLength: 1 · maxLength: 500 · required
applicationIds
​string[] · maxItems: 20 · required
applicationNames
​string[] · maxItems: 20 · required
reason
​string · minLength: 1 · maxLength: 2000 · required
suggestedReadOnly
​boolean · required
lockedReadOnly
​boolean · required
departingId
​string

SessionItemDTO

id
​string · required
sessionId
​string · required
itemType
​string · enum · required
Enum values:
task
bug_report
itemId
​string · required
itemName
​string
itemStatus
​string
displayId
​string
taskType
​string · enum
Enum values:
task
subtask
featureId
​string
featureName
​string
featureRestricted
​boolean
addedBy
​string
notes
​string
​
createdAt
​string

SessionDeploymentDTO

id
​string · required
sessionId
​string · required
environment
​string · required

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

status
​string · enum · required
Enum values:
merged
pending
deployed
failed
skipped
rolled_back
commitSha
​string
tagName
​string
deployedAt
​string
deployedBy
​string
buildUrl
​string
pullRequestUrl
​string
notes
​string
createdAt
​string
updatedAt
​string
​

For an environment that deploys to a cloud account: the newest deploy run of this commit there, as GitHub ran it and Productmind recorded it, beside this row's own status. Null when none is recorded.

DeploymentRunSummaryDTO

deploymentId
​string · required
kind
​string · enum · required

deploy: a run of the repository's deploy workflow; destroy: a run of its destroy workflow.

Enum values:
deploy
destroy
status
​string · enum · required

Where the run is: queued (waiting for its turn or a runner), in_progress, or completed.

Enum values:
queued
in_progress
completed
​required
runNumber
​integer · min: -9007199254740991 · max: 9007199254740991 · required
runAttempt
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​required
​required

SessionGitRepositoryDTO

id
​string · required
workforceConnectorId
​string · required
externalRepoId
​string · required
repoName
​string · required
repoUrl
​string · required
baseBranch
​string · required
workingBranch
​string · required
modified
​boolean · required
​
pullRequestUrl
​string
readOnly
​boolean
​
​
​

SessionDepartingRepositoryDTO

id
​string · required
repositoryId
​string · required
repoName
​string · required
repoUrl
​string · required
baseBranch
​string · required
workingBranch
​string · required
readOnly
​boolean · required
state
​string · enum · required
Enum values:
pending
saved
deferred
failed
discard
removedAt
​string · required
​
​
​
​
​

SessionPendingScopeNoticeDTO

id
​string · required
kind
​string · enum · required
Enum values:
repository_added
repository_removed
task_added
task_removed
bug_report_added
bug_report_removed
subjectId
​string · required

SessionPreviewDTO

id
​string · required
sessionId
​string · required
workspaceId
​string · required
status
​string · enum · required
Enum values:
provisioning
pulling
starting
running
stopping
stopped
error
mode
​string · enum · required
Enum values:
cloud
local
codeflow_local
ttlSeconds
​integer · min: -9007199254740991 · max: 9007199254740991 · required
idleTimeoutSeconds
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​
​PreviewPortOutput[]
​SessionPreviewUrl[]
​SessionPreviewApp[]
​
​
​
​
​
​
unsavedWork
​boolean
​
​
​
​
​
​
​PreviewViewerAccess
createdAt
​string
updatedAt
​string

SessionPreviewUrl

port
​integer · min: -9007199254740991 · max: 9007199254740991 · required
name
​string · required
url
​string · required

SessionPreviewApp

applicationId
​string · required
name
​string · required
workingDirectory
​string
installCommand
​string
devCommand
​string
​PreviewPortOutput[]

SessionPreviewAppAiRepair

configuredInstallCommand
​string · required

The install command the application held when the repair was offered

configuredDevCommand
​string · required

The run command the application held when the repair was offered

installCommand
​string · required

The install command the repair got working

devCommand
​string · required

The run command the repair got working

savedAt
​string

When the repaired commands were saved on the application (ISO 8601)

savedBy
​string

Who saved them: a user id

SessionPreviewAiSetup

admitted
​boolean · required

Whether the AI-assisted setup turns may run

reason
​string

Why they will not: the coding check's sentence

PreviewViewerAccess

​required

The edge's viewer handshake URL; null when the preview needs none

CompleteTaskWorkResponse

​__schema0[] · required
​SessionDTO

TaskLogDTO

id
​string · required
content
​string · required
​object · required
createdAt
​string
updatedAt
​string

TaskDescriptionProposalDTO

id
​string · required
workspaceId
​string · required
taskId
​string · required
source
​string · enum · required
Enum values:
auto
manual
status
​string · enum · required
Enum values:
queued
running
awaiting_review
applied
dismissed
failed
​
​
​
​
​

Why the run declined to write anything, when it settled failed with sufficientContext false and the AI named a reason. Null otherwise.

​
​
​
​
​
createdAt
​string
updatedAt
​string

CreateContactResult

id
​string · required
accountId
​string · required
name
​string · required
isPrimary
​boolean · required
matchedExisting
​boolean · required

true when a contact with this email address was already on file: this is that contact, returned unchanged, and nothing was created. false when this call created the contact.

accountName
​string
email
​string
title
​string
phone
​string
sourceType
​string · enum
Enum values:
manual
feedback_stream
research_interview
crm_import
sourceId
​string
externalSource
​string

Which external system this record was imported from.

externalId
​string · minLength: 1 · maxLength: 255

The CRM's own id for this record — people/c123…, 701.

externalSourceUrl
​string · uri

Deep link back to the record in the CRM.

lastContactedAt
​string
​
​
​
createdAt
​string
updatedAt
​string

MatchContactsResult

​object[] · required
unmatched
​string[] · required
internal
​string[] · required

NoteDTO

id
​string · required
workspaceId
​string · required
title
​string
contactId
​string
​object
rawContent
​string
tags
​string[]
suggestedTagCount
​integer · min: -9007199254740991 · max: 9007199254740991
pinned
​boolean
​
​object
​
createdAt
​string
updatedAt
​string

NotePromotedEntityDTO

entityType
​string · enum · required
Enum values:
feature_request
feature
task
bug_report
id
​string · required
title
​string · required
displayId
​number
status
​string
restricted
​boolean

PromoteNoteResponse

entityType
​string · enum · required
Enum values:
feature_request
feature
task
bug_report
​NotePromotedEntityDTO · required
​NoteDTO · required
created
​boolean · required

NotificationDTO

id
​string · required
type
​string · enum · required
Enum values:
mention.feature_doc
mention.comment
mention.description
mention.document
mention.session_doc
session.interaction_pending
session.ci_autofix_started
session.pull_request_opened
emailSkipped
​boolean · required
​object
organizationId
​string
workspaceId
​string
subjectType
​string
subjectId
​string
​object
readAt
​string
emailSentAt
​string
directMessageSentAt
​string
directMessageProvider
​string
directMessageStatus
​string · enum
Enum values:
sent
skipped_no_workspace
skipped_no_provider
skipped_no_link
skipped_no_scope
skipped_lookup_failed
skipped_disabled
failed
createdAt
​string
updatedAt
​string

UnreadNotificationsCountDTO

unread
​integer · min: 0 · max: 9007199254740991 · required

CustomerInteractionDTO

workspaceId
​string · required
type
​string · enum · required
Enum values:
notes
interview_manual
agentic_voice
agentic_email
agentic_slack
feedback_stream
support
id
​string
customerResearchId
​string
contactId
​string
​object
status
​string · enum
Enum values:
draft
scheduled
invited
in_progress
processing
completed
cancelled
invalid
​
​
​object
tags
​string[]
suggestedTagCount
​integer · min: -9007199254740991 · max: 9007199254740991
rawContent
​string
guideline
​string
​object
scheduledAt
​string
endsAt
​string
meetingUrl
​string
meetingProvider
​string · enum
Enum values:
google_meet
zoom
teams
voiceEnabled
​boolean
recordingEnabled
​boolean
transcriptionEnabled
​boolean
​object
externalSource
​string
externalId
​string
externalSourceUrl
​string
​object
​object[]
agentInterviewLink
​string
​InteractionSupportConversation
createdAt
​string
updatedAt
​string

InteractionParticipant

email
​string · required
name
​string
role
​string · enum
Enum values:
attendee
requester
agent

CustomerInteractionMessageDTO

content
​string · required
id
​string
type
​string · enum
Enum values:
text
file
image
systemNotification
agentResponse
isFromAgent
​boolean
interactionId
​string
createdAt
​string
updatedAt
​string

ChatMessageAttachment

attachmentId
​string · required
fileName
​string · required
contentType
​string · required

InteractionSupportRequestRef

id
​string · required
displayId
​string · required
type
​string · enum · required
Enum values:
code_review
question
bug_report
feature_request
status
​string · enum · required
Enum values:
open
assigned
in_progress
awaiting_customer
resolved
cancelled
expired
createdAt
​string · required

InteractionSupportConversation

organizationId
​string · required
​required

CustomerInteractionDescriptionProposalDTO

id
​string · required
workspaceId
​string · required
interactionId
​string · required
source
​string · enum · required
Enum values:
auto
manual
status
​string · enum · required
Enum values:
queued
running
awaiting_review
applied
dismissed
failed
​
​
​
​
​

Why the run declined to write anything, when it settled failed with sufficientContext false and the AI named a reason. Null otherwise.

​
​
​
​
​
createdAt
​string
updatedAt
​string

InternalMeetingDTO

workspaceId
​string · required
title
​string · required
status
​string · enum · required
Enum values:
draft
scheduled
in_progress
processing
completed
cancelled
failed
id
​string
agenda
​string
notes
​string
​object
tags
​string[]
suggestedTagCount
​integer · min: -9007199254740991 · max: 9007199254740991
scheduledAt
​string
endsAt
​string
meetingUrl
​string
meetingProvider
​string · enum
Enum values:
google_meet
zoom
teams
recordingEnabled
​boolean
transcriptionEnabled
​boolean
​object
externalSource
​string
externalId
​string
externalSourceUrl
​string
createdAt
​string
updatedAt
​string

InternalMeetingParticipant

email
​string · required
name
​string
userId
​string
role
​string · enum
Enum values:
organizer
attendee

InternalMeetingSummary

title
​string · required
summary
​string · required
keyPoints
​string[] · required
Default: []
decisions
​string[] · required
Default: []
​InternalMeetingActionPointOutput[] · required
Default: []

InternalMeetingRelationshipDTO

id
​string · required
targetType
​string · required
targetId
​string · required
relationshipType
​string · required
displayId
​number
title
​string
targetKind
​string

SupportImportPreviewItem

externalId
​string · required
isNewImport
​boolean · required
contactId
​string
contactName
​string
accountId
​string
accountName
​string
existingInteractionId
​string
existingInteractionType
​string · enum
Enum values:
notes
interview_manual
agentic_voice
agentic_email
agentic_slack
feedback_stream
support
existingContactId
​string
existingContactName
​string
existingAccountName
​string
defaultInteractionType
​string · enum
Enum values:
support
notes
interview_manual
ambiguousContactMatch
​boolean
otherHelpdeskAccount
​boolean

SupportImportResult

​SupportImportResultItem[] · required
createdCount
​number · required
updatedCount
​number · required
filteredCount
​number · required
errorCount
​number · required

SupportImportResultItem

externalId
​string · required
outcome
​string · enum · required
Enum values:
created
updated
filtered
error
interactionId
​string
interactionType
​string · enum
Enum values:
notes
interview_manual
agentic_voice
agentic_email
agentic_slack
feedback_stream
support
contactId
​string
accountId
​string
message
​string

SupportIngestionConfigDTO

platform
​string · enum · required
Enum values:
freshdesk
zendesk
intercom
statuses
​string[] · required
tags
​string[] · required
tagMatchMode
​string · enum · required
Enum values:
any
all
groupIds
​string[] · required
defaultInteractionType
​string · enum · required
Enum values:
support
notes
interview_manual
id
​string
​object
lastWebhookAt
​string
createdAt
​string
updatedAt
​string

SupportIngestionEventDTO

id
​string · required
platform
​string · enum · required
Enum values:
freshdesk
zendesk
intercom
outcome
​string · enum · required
Enum values:
created
updated
filtered
error
source
​string · enum · required
Enum values:
manual
webhook
externalId
​string
message
​string
interactionId
​string
createdAt
​string

SupportRequestListResponse

​SupportRequestListItemDTO[] · required
​required

Pass back as cursor for the next page; null on the last page.

SupportRequestListItemDTO

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · tier="full" · requires: id, displayId, sequenceNumber +12 more
type = object · tier="billing" · requires: id, displayId, sequenceNumber +10 more
Properties for Variant 1:
tier
​string · const · required
Const value: full
id
​string · required
displayId
​string · required
sequenceNumber
​integer · min: -9007199254740991 · max: 9007199254740991 · required
type
​string · enum · required
Enum values:
code_review
question
bug_report
feature_request
status
​string · enum · required
Enum values:
open
assigned
in_progress
awaiting_customer
resolved
cancelled
expired
​required
​required
title
​string · required
​required
​SupportPersonDTO · required
​required
lastActivityAt
​string · required
createdAt
​string · required
​required
unread
​boolean · required

SupportRequestFullListItemDTO

tier
​string · const · required
Const value: full
id
​string · required
displayId
​string · required
sequenceNumber
​integer · min: -9007199254740991 · max: 9007199254740991 · required
type
​string · enum · required
Enum values:
code_review
question
bug_report
feature_request
status
​string · enum · required
Enum values:
open
assigned
in_progress
awaiting_customer
resolved
cancelled
expired
​required
​required
title
​string · required
​required
​SupportPersonDTO · required
​required
lastActivityAt
​string · required
createdAt
​string · required
​required
unread
​boolean · required

SupportPersonDTO

​required
displayName
​string · required
​required
side
​string · enum · required
Enum values:
customer
productmind

SupportRequestBillingListItemDTO

tier
​string · const · required
Const value: billing
id
​string · required
displayId
​string · required
sequenceNumber
​integer · min: -9007199254740991 · max: 9007199254740991 · required
type
​string · enum · required
Enum values:
code_review
question
bug_report
feature_request
status
​string · enum · required
Enum values:
open
assigned
in_progress
awaiting_customer
resolved
cancelled
expired
​required
​required
title
​string · required
​required
​SupportPersonDTO · required
​required
lastActivityAt
​string · required
createdAt
​string · required

SupportRequestDTO

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · tier="full" · requires: id, displayId, sequenceNumber +26 more
type = object · tier="billing" · requires: id, displayId, sequenceNumber +19 more
Properties for Variant 1:
tier
​string · const · required
Const value: full
id
​string · required
displayId
​string · required
sequenceNumber
​integer · min: -9007199254740991 · max: 9007199254740991 · required
type
​string · enum · required
Enum values:
code_review
question
bug_report
feature_request
status
​string · enum · required
Enum values:
open
assigned
in_progress
awaiting_customer
resolved
cancelled
expired
​required
​required
statusChangedAt
​string · required
organizationId
​string · required
​required
title
​string · required
​SupportPersonDTO · required
​required
​required
​required
​required
lastActivityAt
​string · required
createdAt
​string · required
updatedAt
​string · required
​required
priority
​string · enum · required
Enum values:
low
normal
high
urgent
​object · required
​required
​required
​required
​required
​SupportScreenshotDTO[] · required
unread
​boolean · required
​SupportRequestViewerDTO · required

SupportRequestFullDTO

tier
​string · const · required
Const value: full
id
​string · required
displayId
​string · required
sequenceNumber
​integer · min: -9007199254740991 · max: 9007199254740991 · required
type
​string · enum · required
Enum values:
code_review
question
bug_report
feature_request
status
​string · enum · required
Enum values:
open
assigned
in_progress
awaiting_customer
resolved
cancelled
expired
​required
​required
statusChangedAt
​string · required
organizationId
​string · required
​required
title
​string · required
​SupportPersonDTO · required
​required
​required
​required
​required
lastActivityAt
​string · required
createdAt
​string · required
updatedAt
​string · required
​required
priority
​string · enum · required
Enum values:
low
normal
high
urgent
​object · required
​required
​required
​required
​required
​SupportScreenshotDTO[] · required
unread
​boolean · required
​SupportRequestViewerDTO · required

SupportRequestSubjectDTO

type
​string · enum · required
Enum values:
session
support_conversation
id
​string · required
​required
​required
​required
​required

SupportRequestSubjectLiveDTO

available
​boolean · required
​required
​required
​required

SupportRequestBillingDTO

currency
​string · required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required

SupportQuoteDTO

id
​string · required
supportRequestId
​string · required
kind
​string · enum · required
Enum values:
initial
extension
status
​string · enum · required
Enum values:
pending
approved
rejected
expired
superseded
​SupportPersonDTO · required
capMinutes
​integer · min: -9007199254740991 · max: 9007199254740991 · required
rateCentsPerHour
​integer · min: 0 · max: 9007199254740991 · required
​required
​required
maxAmountCents
​integer · min: 0 · max: 9007199254740991 · required
submittedAt
​string · required
expiresAt
​string · required
​required
​required

SupportRequestAccessSummaryDTO

​required
​required
allowMerge
​boolean · required
​required
​required
​required
​required
everIssued
​boolean · required

SupportScreenshotDTO

id
​string · required
fileName
​string · required
contentType
​string · required
fileSize
​integer · min: -9007199254740991 · max: 9007199254740991 · required
side
​string · enum · required
Enum values:
customer
productmind
url
​string · required
createdAt
​string · required

SupportRequestViewerDTO

tier
​string · enum · required
Enum values:
full
billing
isRequester
​boolean · required
canPostMessage
​boolean · required
canCancel
​boolean · required
canDecideQuotes
​boolean · required
canRevokeAccess
​boolean · required

SupportRequestBillingTierDTO

tier
​string · const · required
Const value: billing
id
​string · required
displayId
​string · required
sequenceNumber
​integer · min: -9007199254740991 · max: 9007199254740991 · required
type
​string · enum · required
Enum values:
code_review
question
bug_report
feature_request
status
​string · enum · required
Enum values:
open
assigned
in_progress
awaiting_customer
resolved
cancelled
expired
​required
​required
statusChangedAt
​string · required
organizationId
​string · required
​required
title
​string · required
​SupportPersonDTO · required
​required
​required
​required
​required
lastActivityAt
​string · required
createdAt
​string · required
updatedAt
​string · required
​SupportRequestBillingDTO · required
​SupportQuoteDTO[] · required
​SupportRequestViewerDTO · required

SupportRequestUnreadCountDTO

count
​integer · min: 0 · max: 9007199254740991 · required
awaitingCount
​integer · min: 0 · max: 9007199254740991 · required

SupportRequestMessageListResponse

​SupportRequestMessageDTO[] · required
​required

Pass back as cursor for the next page; null on the last page.

SupportRequestMessageDTO

id
​string · required
supportRequestId
​string · required
kind
​string · enum · required
Enum values:
message
event
authorSide
​string · enum · required
Enum values:
customer
productmind
system
​required
​required
​required
​required
​SupportScreenshotDTO[] · required
​required
​required
createdAt
​string · required
canEdit
​boolean · required

SupportRequestScopePreviewDTO

​SupportRequestScopeSessionDTO · required
​SupportRequestSharedFeatureDTO[] · required
​SupportRequestSharedTaskDTO[] · required
​SupportRequestSharedBugReportDTO[] · required
​SupportRequestSharedUnavailableDTO[] · required
hiddenCount
​integer · min: 0 · max: 9007199254740991 · required

SupportRequestScopeSessionDTO

id
​string · required
​required
name
​string · required
status
​string · enum · required
Enum values:
in_planning
planning
awaiting_user_input
awaiting_plan_approval
plan_approved
building
in_progress
paused

SupportRequestSharedFeatureDTO

​FeatureListItemDTO · required
source
​string · enum · required
Enum values:
session
shared
removable
​boolean · required

SupportRequestSharedTaskDTO

​__schema0 · required
source
​string · enum · required
Enum values:
session
shared
removable
​boolean · required

SupportRequestSharedBugReportDTO

​BugReportDTO · required
source
​string · enum · required
Enum values:
session
shared
removable
​boolean · required

SupportRequestSharedUnavailableDTO

type
​string · enum · required
Enum values:
feature
task
bug_report
id
​string · required
source
​string · enum · required
Enum values:
session
shared
removable
​boolean · required

SupportRequestSharedEntitiesDTO

accessScopeVersion
​integer · min: -9007199254740991 · max: 9007199254740991 · required
canShare
​boolean · required
​required
​SupportRequestSharedFeatureDTO[] · required
​SupportRequestSharedTaskDTO[] · required
​SupportRequestSharedBugReportDTO[] · required
​SupportRequestSharedUnavailableDTO[] · required
hiddenCount
​integer · min: 0 · max: 9007199254740991 · required

SupportRequestEligibilityDTO

type
​string · enum · required
Enum values:
code_review
question
bug_report
feature_request
eligible
​boolean · required
​required
billable
​boolean · required
​required
currency
​string · required
​required
canAllowMerge
​boolean · required
​required

SupportRequestChipDTO

id
​string · required
displayId
​string · required
type
​string · enum · required
Enum values:
code_review
question
bug_report
feature_request
status
​string · enum · required
Enum values:
open
assigned
in_progress
awaiting_customer
resolved
cancelled
expired
​required
​required
createdAt
​string · required

SupportRequestChipListResponse

​SupportRequestChipDTO[] · required

SupportAccessGrantOrgListResponse

​SupportAccessGrantOrgDTO[] · required
​required

Pass back as cursor for the next page; null on the last page.

SupportAccessGrantOrgDTO

id
​string · required
status
​string · enum · required
Enum values:
active
ended
​object · required
​required
​object · required
contentVisible
​boolean · required
​SupportPersonDTO · required
level
​string · enum · required
Enum values:
evaluation
review
allowMerge
​boolean · required
issuedAt
​string · required
hardExpiresAt
​string · required
​required
​required
​required
​required

SupportAccessGrantOrgResponse

​SupportAccessGrantOrgDTO · required

ProductmindSupportAccessResponse

​ProductmindSupportAccessDTO · required

ProductmindSupportAccessDTO

organizationId
​string · required
enabled
​boolean · required
​required
requiresSso
​boolean · required
defaultFromSso
​boolean · required
activeGrantCount
​integer · min: 0 · max: 9007199254740991 · required
openAccessRequestCount
​integer · min: 0 · max: 9007199254740991 · required

ProductmindSupportAccessUpdateResponse

ProductmindSupportAccessUpdateDTO

organizationId
​string · required
enabled
​boolean · required
​required
requiresSso
​boolean · required
defaultFromSso
​boolean · required
activeGrantCount
​integer · min: 0 · max: 9007199254740991 · required
openAccessRequestCount
​integer · min: 0 · max: 9007199254740991 · required
grantsRevoked
​integer · min: 0 · max: 9007199254740991 · required
requestsCancelled
​integer · min: 0 · max: 9007199254740991 · required
accessEnded
​integer · min: 0 · max: 9007199254740991 · required
sweepComplete
​boolean · required

ChatMessageDTO

id
​string · required
content
​string · required
isFromAgent
​boolean · required
​object[]
​ChatReference[]
sessionId
​string
source
​string · enum
Enum values:
user
agent
system
kind
​string
​object
pendingInterruptId
​string
​ChatPendingInterrupt
​object
createdAt
​string
updatedAt
​string

ChatReference

entityType
​string · enum · required
Enum values:
feature
application
feature_request
task
bug_report
session
sandbox
entityId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required
title
​string · minLength: 1 · maxLength: 500 · required
displayId
​integer · max: 9007199254740991
kind
​string · maxLength: 50
taskType
​string · maxLength: 50
sessionCategory
​string · maxLength: 50

ChatPendingInterrupt

interruptId
​string · required
name
​string · required
​object · required

CustomerResearchDTO

workspaceId
​string · required
title
​string · required
objectives
​string[] · required
questions
​string[] · required
id
​string
description
​string
guideline
​string
interviewWelcomeMessage
​string
widgetWelcomeMessage
​string
interviewerAgentId
​string
widgetKey
​string
status
​string · enum
Enum values:
draft
scheduled
invited
in_progress
processing
completed
cancelled
invalid
createdAt
​string
updatedAt
​string
​object
summaryGeneratedAt
​string
completedInteractionCountAtGeneration
​number
​object
interactionCount
​number
completedInteractionCount
​number
isSummaryStale
​boolean

FeatureRequestSummaryDTO

id
​string · required
displayId
​number · required
title
​string · required
priority
​string · enum · required
Enum values:
low
high
critical
status
​string · enum · required
Enum values:
new
in_review
rejected
merged
promoted
interestCount
​number · required

TagVocabularyEntryDTO

name
​string · required

Tag name

count
​integer · min: -9007199254740991 · max: 9007199254740991 · required

How many entities of the requested type carry the tag

KnowledgeBaseFollowOnDTO

overviewRefresh
​boolean · required

True when a source indexed now would redraft the Overview: it was never generated, or generated and never edited

starterFeatures
​boolean · required

True when the workspace has no features yet: indexing the Overview drafts starter features with their specifications

​object · required

A measured estimate of what the follow-on work draws; 0 when nothing would run

KnowledgeBaseDocumentListItemDTO

id
​string · required
workspaceId
​string · required
orgId
​string · required
title
​string · required
sourceType
​string · enum · required
Enum values:
system
upload
website
manual
connector
generated
repository
status
​string · enum · required
Enum values:
draft
scraping
processing
indexing
ready
error
deleting
isStale
​boolean · required
isSystem
​boolean · required
isWired
​boolean · required
availableToAgents
​boolean · required
displayId
​number
​
s3Key
​string
​
​
mimeType
​string
tags
​string[]
suggestedTagCount
​integer · min: -9007199254740991 · max: 9007199254740991
description
​string
chunkCount
​number
chunkingStrategy
​string · enum
Enum values:
standard
contextual
​
​
​
​
​
sortOrder
​number
​
createdAt
​string
updatedAt
​string

KnowledgeBaseDocumentMetadata

provider
​string
externalId
​string
externalUrl
​string
originalFileName
​string
generationInsufficient
​boolean
generationNote
​string
generatedContentHash
​string
refusalCode
​string
​object
​object

KnowledgeBaseRepoSyncMetadata

syncId
​string · required

The Knowledge Base sync that owns this document

applicationId
​string · required

The Application whose repository the document is synced from

kind
​string · enum · required

root: the sync's root document; folder: a folder; file: a Markdown file

Enum values:
root
folder
file
path
​string · required

The file or folder path in the repository; empty for the root document

provider
​string · required

The git provider: github, gitlab or bitbucket

repoName
​string · required

The repository's full name, such as owner/repo

branch
​string · required

The branch the document is synced from

webUrl
​string

The file or folder on the provider's website, at the synced branch

commitSha
​string

The commit the document's content was last synced from

KnowledgeBaseDocumentDTO

id
​string · required
workspaceId
​string · required
orgId
​string · required
title
​string · required
sourceType
​string · enum · required
Enum values:
system
upload
website
manual
connector
generated
repository
status
​string · enum · required
Enum values:
draft
scraping
processing
indexing
ready
error
deleting
isStale
​boolean · required
isSystem
​boolean · required
isWired
​boolean · required
availableToAgents
​boolean · required
displayId
​number
​
s3Key
​string
​
​
mimeType
​string
tags
​string[]
suggestedTagCount
​integer · min: -9007199254740991 · max: 9007199254740991
description
​string
chunkCount
​number
chunkingStrategy
​string · enum
Enum values:
standard
contextual
​
​
​
​
​
sortOrder
​number
​
createdAt
​string
updatedAt
​string
​
​

KbDocumentLinkDTO

id
​string · required
entityType
​string · enum · required
Enum values:
application
feature
entityId
​string · required
​
​
​
​
​
​
​

KnowledgeBaseDocumentProposalDTO

id
​string · required
workspaceId
​string · required
​required
kind
​string · enum · required
Enum values:
update
create
source
​string · enum · required
Enum values:
documentation
session
comment
status
​string · enum · required
Enum values:
awaiting_review
approved
applied
dismissed
failed
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
draftStale
​boolean
​
​
​
​
​
​
​
​
createdAt
​string
updatedAt
​string

KnowledgeBaseDocumentProposalSummaryDTO

id
​string · required
​required
kind
​string · enum · required
Enum values:
update
create
source
​string · enum · required
Enum values:
documentation
session
comment
status
​string · enum · required
Enum values:
awaiting_review
approved
applied
dismissed
failed
​
​
​
​
​
​
​
createdAt
​string

KnowledgeBaseSearchResponseDTO

​object[] · required
query
​string · required
mode
​string · enum · required
Enum values:
semantic
hybrid
lexical
total
​number · required
​object[]
usageEventId
​string · minLength: 1

KnowledgeBaseRagResponseDTO

answer
​string · required
​object[] · required
query
​string · required
mode
​string · enum · required
Enum values:
semantic
hybrid
lexical
totalResults
​number · required
​object[]
usageEventId
​string · minLength: 1

KnowledgeBaseIndexingDeferral

deferred
​boolean · const · required
Const value:
reason
​string · required

Why indexing waits: insufficient_credit, payg_activation_required, spending_paused or a usage limit

message
​string · required

The sentence that says why, and what fixes it

IngestConnectorItemsResponseDTO

executionId
​string · required
documentIds
​string[] · required

Present when the imported documents will be stored but not indexed until the organization can pay

IngestTextDocumentResponseDTO

documentId
​string · required

KnowledgeBaseDocumentVersionDTO

id
​string · required
documentId
​string · required
versionNumber
​number · required
title
​string · required
authorIds
​string[] · required
contentMarkdown
​string
​object[]
onBehalfOfUserId
​string

The person an agent author of this version worked for: who started its session, or who the integration acted for. Absent when a person saved it themselves.

​object

The person in onBehalfOfUserId. Absent when they no longer have an account.

summary
​string
createdAt
​string

KnowledgeBaseDocumentVersionDetailDTO

id
​string · required
documentId
​string · required
versionNumber
​number · required
title
​string · required
authorIds
​string[] · required
contentMarkdown
​string
​object[]
onBehalfOfUserId
​string

The person an agent author of this version worked for: who started its session, or who the integration acted for. Absent when a person saved it themselves.

​object

The person in onBehalfOfUserId. Absent when they no longer have an account.

summary
​string
createdAt
​string
contentLexical
​

ChatDTO

id
​string · required
workspaceId
​string · required
status
​string · required
title
​string
mode
​string · enum
Enum values:
auto
brainstorm
plan
build
bugfix
autonomyLevel
​string · enum
Enum values:
autonomous
ask_approval
visibility
​string · enum
Enum values:
private
workspace
activeSessionId
​string
sessionIds
​string[]
agentId
​string
externalThreadRef
​string
​object
createdById
​string
createdByName
​string
​object
​ChatMessageDTO[]
messageCount
​number
createdAt
​string
updatedAt
​string

ChatSessionSummary

id
​string · required
name
​string · required
category
​string · enum · required
Enum values:
plan
live
scan
bugfix
code_chat
status
​string · enum · required
Enum values:
in_planning
planning
awaiting_user_input
awaiting_plan_approval
plan_approved
building
in_progress
paused
displayId
​number
​AssigneeRefDTO[]

UserDTO

id
​string · required
firstName
​string · required
lastName
​string
displayName
​string
initials
​string
email
​string
mobile
​string
jobTitle
​string
profilePictureUrl
​string
disabled
​boolean
createdAt
​string
updatedAt
​string
timezone
​string
timeformat
​string
hasPassword
​boolean

EntityWorkspaceDTO

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

UserSessionDTO

id
​string · required
name
​string · required
source
​string · enum · required
Enum values:
password
idp
invitation
referral
mcp
onboarding
sso
current
​boolean · required
firstParty
​boolean · required
​
​
​
​
​
​
​

CodeflowInstanceDTO

instanceId
​string · required
name
​string · required
​
​
​
organizationBound
​boolean

FeatureBoardDTO

​FeatureBoardItemDTO[] · required
unlinkedRequestCount
​number · required
​LineageGraphDTO[]

FeatureBoardItemDTO

featureId
​string · required
​LineageGraphDTO · required
parentFeatureId
​string

LineageGraphDTO

​LineageNodeDTO[] · required
​LineageEdgeDTO[] · required
rootEntityId
​string · required
rootEntityType
​string · enum · required
Enum values:
customer_interaction
feature_request_interest
feature_request
bug_report
feature
task
session
release

LineageNodeDTO

id
​string · required
entityType
​string · enum · required
Enum values:
customer_interaction
feature_request_interest
feature_request
bug_report
feature
task
session
release
stage
​string · enum · required
Enum values:
customer_feedback
feature_requests
bug_reports
features
tasks
sessions
releases
title
​string · required
status
​string · required
displayId
​integer · min: -9007199254740991 · max: 9007199254740991
description
​string
priority
​string
type
​string
customerResearchId
​string
createdAt
​string
updatedAt
​string
​LineageInterestSummary

LineageInterestSummary

source
​string · enum · required
Enum values:
internal_stakeholders
customer_feedback
market_signal
strategic_directive
support_pattern
competitive_intelligence
sourceName
​string
description
​string
sentiment
​string · enum
Enum values:
negative
neutral
positive
position
​string · enum
Enum values:
supporting
opposing
neutral
conditional
conditionalNotes
​string
weight
​number
stakeholderRole
​string · enum
Enum values:
marketing
leadership
engineering
design
sales
customer_support
customer_engineering
finance
stakeholderName
​string
contactName
​string
accountName
​string
accountIsStrategic
​boolean

LineageEdgeDTO

sourceId
​string · required
sourceType
​string · enum · required
Enum values:
customer_interaction
feature_request_interest
feature_request
bug_report
feature
task
session
release
targetId
​string · required
targetType
​string · enum · required
Enum values:
customer_interaction
feature_request_interest
feature_request
bug_report
feature
task
session
release
relationship
​string · enum · required
Enum values:
extracted_from
promoted_to
implemented_by
includes

DashboardStatsDTO

​DashboardNodeCountsDTO · required
​DashboardKpisDTO · required
​DashboardWindowsDTO · required
​required
​DashboardEventDTO[] · required

DashboardNodeCountsDTO

interviewsAgenticVoice
​number · required
interviewsAgenticEmail
​number · required
feedbackInbound
​number · required
interviewsManualNotes
​number · required
supportCases
​number · required
interestCustomer
​number · required
interestStakeholder
​number · required
internalMeetings
​number · required
notes
​number · required
requestsNew
​number · required
requestsInReview
​number · required
requestsPromoted
​number · required
requestsRejected
​number · required
featuresActive
​number · required
featuresGeneratedPending
​number · required
tasksTodo
​number · required
tasksInProgress
​number · required
tasksInReview
​number · required
tasksDone
​number · required
bugReportsTodo
​number · required
bugReportsInProgress
​number · required
bugReportsInReview
​number · required
bugReportsDone
​number · required
sessionsActive
​number · required
sessionsPlanning
​number · required
sessionsNeedsYou
​number · required
sessionsBuilding
​number · required
sessionsCompleted
​number · required
releasesShipped
​number · required
applicationsTotal
​number · required
applicationsPlatformHosted
​number · required
sessionsTotal
​number · required
sessionsRun
​number · required

DashboardKpisDTO

activeConversations
​number · required
requestsValidated7d
​number · required
​required
releasesShipped7d
​number · required

DashboardWindowsDTO

windowDays
​number · const · required
Const value: 7
customerFeedbackCreated
​number · required
interestCustomerCreated
​number · required
interestStakeholderCreated
​number · required
internalMeetingsCreated
​number · required
notesCreated
​number · required
requestsCreated
​number · required
bugReportsCreated
​number · required
tasksCreated
​number · required
sessionsStarted
​number · required

DashboardLatestReleaseDTO

id
​string · required
name
​string · required
​required

DashboardEventDTO

id
​string · required
kind
​string · enum · required
Enum values:
interview
request
feature
task
session
release
title
​string · required
occurredAt
​string · required

DashboardUpdatesDTO

​DashboardSessionMetricDTO · required
​DashboardTaskMetricDTO · required
​DashboardBugMetricDTO · required
​required
​required

DashboardSessionMetricDTO

total
​number · required
​DashboardBreakdownEntryDTO[] · required
​DashboardSessionItemDTO[] · required

DashboardBreakdownEntryDTO

key
​string · required
label
​string · required
count
​number · required

DashboardSessionItemDTO

id
​string · required
​required
title
​string · required
status
​string · required
​required
​required
updatedAt
​string · required
category
​string · enum · required
Enum values:
plan
live
scan
bugfix
code_chat
​required

DashboardTaskMetricDTO

total
​number · required
​DashboardBreakdownEntryDTO[] · required
​DashboardTaskItemDTO[] · required

DashboardTaskItemDTO

id
​string · required
​required
title
​string · required
status
​string · required
​required
​required
updatedAt
​string · required
type
​string · enum · required
Enum values:
task
subtask

DashboardBugMetricDTO

total
​number · required
​DashboardBreakdownEntryDTO[] · required
​DashboardBugItemDTO[] · required

DashboardBugItemDTO

id
​string · required
​required
title
​string · required
status
​string · required
​required
​required
updatedAt
​string · required
severity
​string · enum · required
Enum values:
minor
major
critical
blocker

DashboardRequestMetricDTO

total
​number · required
​DashboardBreakdownEntryDTO[] · required
​DashboardRequestItemDTO[] · required

DashboardRequestItemDTO

id
​string · required
​required
title
​string · required
status
​string · required
​required
​required
updatedAt
​string · required
source
​string · enum · required
Enum values:
internal_stakeholders
customer_feedback
market_signal
strategic_directive
support_pattern
competitive_intelligence

DashboardFeedbackMetricDTO

total
​number · required
​DashboardBreakdownEntryDTO[] · required
​DashboardFeedbackItemDTO[] · required

DashboardFeedbackItemDTO

id
​string · required
​required
title
​string · required
status
​string · required
​required
​required
updatedAt
​string · required
type
​string · enum · required
Enum values:
notes
interview_manual
agentic_voice
agentic_email
agentic_slack
feedback_stream
support
​required
​required
​required
​required

DashboardTrendsDTO

bucketDays
​number · const · required
Const value: 1
bucketCount
​number · const · required
Const value: 56
start
​string · required
​object · required

DashboardAttentionDTO

​DashboardSessionItemDTO[] · required
​DashboardFeedbackItemDTO[] · required

DashboardSummaryDTO

​object · required
​object · required
​object · required

DashboardMetricDTO

total
​number · required
​DashboardBreakdownEntryDTO[] · required
​DashboardItemDTO[] · required

DashboardItemDTO

id
​string · required
​required
title
​string · required
status
​string · required
​required
​required
updatedAt
​string · required

WorkCountsDTO

sessionsAwaitingMe
​integer · min: 0 · max: 9007199254740991 · required
tasksOpenMine
​integer · min: 0 · max: 9007199254740991 · required
bugReportsOpenMine
​integer · min: 0 · max: 9007199254740991 · required
applicationsScanning
​integer · min: 0 · max: 9007199254740991 · required
sessionsInProgress
​integer · min: 0 · max: 9007199254740991 · required
featuresScanning
​integer · min: 0 · max: 9007199254740991 · required
featuresAwaitingReview
​integer · min: 0 · max: 9007199254740991 · required
featuresDeepScanning
​integer · min: 0 · max: 9007199254740991 · required
kbProposalsAwaitingReview
​integer · min: 0 · max: 9007199254740991 · required
automationRunsInFlight
​integer · min: 0 · max: 9007199254740991 · required
automationRunsFailedRecent
​integer · min: 0 · max: 9007199254740991 · required
featureRequestsOpen
​integer · min: 0 · max: 9007199254740991 · required
releasesBeingPrepared
​integer · min: 0 · max: 9007199254740991 · required
releasesReadyToMerge
​integer · min: 0 · max: 9007199254740991 · required
marketingReactions
​integer · min: 0 · max: 9007199254740991 · required

EntitySearchHit

entityType
​string · enum · required
Enum values:
task
feature
bug_report
feature_request
session
application
sandbox
entityId
​string · required
​required
title
​string · required
matchType
​string · enum · required
Enum values:
display_id
display_id_prefix
title_exact
title_prefix
title_word_prefix
title
recent
score
​number · required
​required
​
​
​

DisplayIdLookup

entityType
​string · enum · required
Enum values:
task
feature
feature_request
bug_report
session
release
application
sandbox
entityId
​string · required
displayId
​integer · min: -9007199254740991 · max: 9007199254740991 · required

TeamDTO

id
​string · required
name
​string · required
organizationId
​string
​
memberCount
​integer · min: -9007199254740991 · max: 9007199254740991
​
​
​TeamMemberDTO[]

TeamMemberDTO

id
​string · required
userId
​string · required
role
​string · required
​
​object

TeamRoleDTO

key
​string · required

What role takes on add-team-member and update-team-member.

name
​string · required
​required

AssignableUserDTO

id
​string · required

Their user id, for assignees (entityType user) and add-team-member.

name
​string · required

Their name, or their email when they have not set one.

email
​string · required

NotificationChannelSubscriptionDTO

id
​string · required
provider
​string · enum · required
Enum values:
slack
connectorInstanceId
​string · required
channelId
​string · required
channelName
​string · required
events
​string[] · required
Enum values:
feature.created
feature.created_bulk
feature.updated
feature.status_changed
feature_request.created
feature_request.updated
feature_request.status_changed
feature_request.promoted
isActive
​boolean · required
createdBy
​string
lastErrorCode
​string
lastErrorAt
​string
createdAt
​string
updatedAt
​string

NotificationChannelProviderStatusDTO

provider
​string · enum · required
Enum values:
slack
connected
​boolean · required
​required
missingScopes
​string[] · required
directMessageCapable
​boolean · required
connectorInstanceId
​string

NotificationChannelTargetDTO

id
​string · required
name
​string · required
isPrivate
​boolean
numMembers
​integer · min: -9007199254740991 · max: 9007199254740991

ReleaseDTO

id
​string · required
workspaceId
​string · required
name
​string · required
status
​string · enum · required
Enum values:
planned
in_progress
released
deployed
archived
displayId
​number
description
​string
prepareStatus
​string · enum
Enum values:
queued
running
completed
failed
​
​
releasedAt
​string
createdById
​string
​ReleaseShippedCounts
​ReleaseProgress
tags
​string[]
suggestedTagCount
​integer · min: -9007199254740991 · max: 9007199254740991
canShip
​boolean
createdAt
​string
updatedAt
​string

ReleaseShippedCounts

tasks
​number · required
bugReports
​number · required
sessions
​number · required

ReleaseApplicationDTO

id
​string · required
releaseId
​string · required
applicationId
​string · required
commitCount
​number · required
commitsTruncated
​boolean · required
commitCountCapped
​boolean · required
pullRequestAdopted
​boolean · required
status
​string · enum · required
Enum values:
pending
preparing
ready
skipped
failed
merged
position
​number · required
applicationName
​string
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
createdAt
​string
updatedAt
​string

ReleaseCommitDTO

id
​string · required
releaseApplicationId
​string · required
sha
​string · required
title
​string · required
position
​number · required
​
​
​
​
​
​

PullRequestChecksResultDTO

​required
overallState
​string · enum · required
Enum values:
success
failure
pending
neutral
none
unavailable
​PullRequestCheckDTO[] · required
​required
​

PullRequestCheckDTO

source
​string · enum · required
Enum values:
check_run
commit_status
pipeline
externalId
​string · required
name
​string · required
​required
​required
status
​string · enum · required
Enum values:
queued
in_progress
completed
unknown
​required
​required
​required
​required
​required
rerunSupported
​boolean

PullRequestCiExpectationDTO

​required
​required
expected
​string · enum · required
Enum values:
required
configured
none
unknown
requiredChecks
​string[] · required
​object[] · required
​required

ReleaseDeploymentDTO

id
​string · required
releaseId
​string · required
environment
​string · required

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

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

For an environment that deploys to a cloud account: the newest deploy run of this commit there, as GitHub ran it and Productmind recorded it, beside this row's own status. Null when none is recorded.

ReleaseProgress

totalTasks
​number · required
completedTasks
​number · required
inProgressTasks
​number · required
pendingTasks
​number · required
percentComplete
​number · required

ReleaseReadinessDTO

​ReleaseReadinessRowDTO[] · required
​ReleaseReadinessRowDTO[] · required

ReleaseReadinessRowDTO

releaseId
​string · required
​required
name
​string · required
applicationsTotal
​integer · min: 0 · max: 9007199254740991 · required
applicationsReady
​integer · min: 0 · max: 9007199254740991 · required
​required

ReleaseShippedWorkDTO

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

ReleaseShippedGroupDTO

​required
​__schema0[] · required
​BugReportDTO[] · required
​SessionDTO[] · required
​FeatureListItemDTO[] · required

ReleaseCuratedItemDTO

relationshipId
​string · required
itemType
​string · enum · required
Enum values:
task
bug_report
session
itemId
​string · required

ReleaseItemProvenanceDTO

itemType
​string · enum · required
Enum values:
task
bug_report
session
itemId
​string · required
derived
​boolean · required
​required
​required

ReleaseShippedItemDTO

id
​string · required
releaseId
​string · required
itemType
​string · enum · required
Enum values:
task
bug_report
session
feature
itemId
​string · required
derived
​boolean · required
​
createdAt
​string
updatedAt
​string

ReleaseItemDTO

id
​string · required
releaseId
​string · required
featureId
​string · required
position
​number · required
featureTitle
​string
featureStatus
​string
featureDescription
​string
notes
​string
derived
​boolean
​
createdAt
​string
updatedAt
​string

ReleaseSessionLineageDTO

​ReleaseLineageFeatureDTO[] · required

ReleaseLineageFeatureDTO

id
​string · required
title
​string · required
status
​string · enum · required
Enum values:
backlog
planned
in_development
stable
deprecated
​ReleaseLineageSessionDTO[] · required
displayId
​number
description
​string
restricted
​boolean

ReleaseLineageSessionDTO

id
​string · required
name
​string · required
status
​string · enum · required
Enum values:
in_planning
planning
awaiting_user_input
awaiting_plan_approval
plan_approved
building
in_progress
paused
category
​string · enum · required
Enum values:
plan
live
scan
bugfix
code_chat
​ReleaseLineageTaskDTO[] · required

ReleaseLineageTaskDTO

id
​string · required
title
​string · required
status
​string · enum · required
Enum values:
todo
in_planning
in_progress
in_testing
in_review
done
displayId
​number
type
​string · enum
Enum values:
task
subtask

ReleaseArtifactDTO

id
​string · required
releaseId
​string · required
type
​string · enum · required
Enum values:
technical_changelog
product_release_notes
marketing_announcement
customer_notification
decision_rationale
sales_enablement
customer_briefing_deck
stakeholder_update
status
​string · enum · required
Enum values:
draft
reviewed
published
content
​string
fileKey
​string
generatedAt
​string
updatedById
​string
createdAt
​string
updatedAt
​string

MergeDeploymentChecksDTO

​required
overallState
​string · enum · required
Enum values:
success
failure
pending
neutral
none
unavailable
​PullRequestCheckDTO[] · required
​required
scope
​string · enum · required

commit: every check on the commit (a merge row); run: the jobs of the deploy run's attempt (a deploy_run row).

Enum values:
commit
run
liveUpdates
​string · enum · required

events: the provider's check events refresh the list (deployment:checks:updated); poll: they do not reach Productmind (GitLab, Bitbucket, or a GitHub commit status still running), so read again while a check runs.

Enum values:
events
poll
​required

A sentence said in place of the jobs (an older attempt's jobs are on the newer attempt's row), or null.

applicationId
​string · required

The application the merge deployed.

commitSha
​string · required

The merge commit the jobs ran on, as the provider recorded it: 40 hexadecimal characters, or a short SHA where the provider records one (Bitbucket).

​object · required

The environment the merge deployed to.

​required
​

PullRequestFilesResultDTO

​PullRequestFileDTO[] · required
truncated
​boolean · required
totalChangedFiles
​integer · min: -9007199254740991 · max: 9007199254740991 · required

PullRequestFileDTO

filename
​string · required
​required
status
​string · enum · required
Enum values:
added
modified
removed
renamed
copied
changed
unchanged
additions
​integer · min: -9007199254740991 · max: 9007199254740991 · required
deletions
​integer · min: -9007199254740991 · max: 9007199254740991 · required
changes
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​required
sha
​string · required

PullRequestFileRisk

level
​string · enum · required
Enum values:
high
medium
low
reasons
​string[] · required

PullRequestDescriptionDTO

url
​string · required

The pull request's URL

body
​string · required

The description as the git provider holds it now (markdown). Empty when the pull request has none.

​required

When a person last saved this description in Productmind. While set, the coding agent's summaries and the release notes no longer replace it. Null when nobody has, and for a pull request linked by hand.

​required

Who last saved this description in Productmind, or null when nobody has.

CloseReleaseResult

releaseId
​string · required
​ReleasePullRequestOutcome[] · required

Pull requests that are now closed, including one the provider had already closed.

​ReleasePullRequestOutcome[] · required

Pull requests the provider would not close, each with its own sentence. They stay open.

ReleasePullRequestOutcome

releaseApplicationId
​string · required

The release-application row the pull request belongs to.

applicationName
​string · required

The application's name, or its repository's when it has none: what the result names it by.

​required

The pull request the outcome is about: the one closed, re-opened, opened in its place, or the one that failed.

​

The provider's own sentence: why a pull request could not be closed or re-opened.

ReopenReleaseResult

releaseId
​string · required
​ReleasePullRequestOutcome[] · required

Pull requests that are open again, with the same number.

​ReleasePullRequestReplacement[] · required

Pull requests that could not be re-opened, each with the reason, and the new pull request opened in its place from the same branches.

​ReleasePullRequestOutcome[] · required

Applications left without an open pull request, each with the reason.

ReleasePullRequestReplacement

releaseApplicationId
​string · required

The release-application row the pull request belongs to.

applicationName
​string · required

The application's name, or its repository's when it has none: what the result names it by.

​required

The pull request the outcome is about: the one closed, re-opened, opened in its place, or the one that failed.

​required

The closed pull request that could not be re-opened. It stays closed.

​

The provider's own sentence: why a pull request could not be closed or re-opened.

adopted
​boolean

True when the pull request in its place was already open for the same branches, and the release took it over rather than opening one.

ReleaseNotesProposalDTO

id
​string · required
workspaceId
​string · required
releaseId
​string · required
source
​string · enum · required
Enum values:
prepare
manual
status
​string · enum · required
Enum values:
queued
running
awaiting_review
applied
dismissed
failed
​
​
​
​
​
​
​
​
createdAt
​string
updatedAt
​string

ShipReleaseResult

releaseId
​string · required
merged
​string[] · required

Release-application IDs that merged.

​object[] · required

Applications the provider refused, with its own message.

skipped
​string[] · required

Release-application IDs with nothing to ship (0 commits ahead). Empty when one application is released.

remaining
​string[] · required

Release-application IDs still to merge after this call: the applications not released yet, and any that failed.

released
​boolean · required

True when no application is left to merge: the release is now released.

MarketingReactionsDTO

available
​boolean · required
likes
​integer · min: 0 · max: 9007199254740991 · required
dislikes
​integer · min: 0 · max: 9007199254740991 · required
​MarketingReactionsNotesDTO[] · required

MarketingReactionsNotesDTO

notesId
​string · required
headline
​string · required
marketingReleaseId
​string · required
​required

The Marketing release's number (MKT-n).

title
​string · required

The Marketing release's title.

likes
​integer · min: 0 · max: 9007199254740991 · required
dislikes
​integer · min: 0 · max: 9007199254740991 · required

MarketingReleaseSummaryDTO

id
​string · required
​required
title
​string · required
status
​string · enum · required
Enum values:
planned
in_progress
announced
archived
​MarketingReleaseSourceCountsDTO · required
​MarketingNotesSummaryDTO[] · required

Every public release notes document, newest first: what the list's Public release notes row reads.

​MarketingReleaseBlogPostStateDTO[] · required

Every blog post, newest first: what the list's Blog posts row reads.

​object · required

What the list's Customer emails row reads.

​required

Readers' likes and dislikes on its public notes in What's new, all time, summed over its notes. Null outside Productmind's own workspace, the only one whose notes reach What's new.

createdAt
​string
updatedAt
​string

MarketingReleaseSourceCountsDTO

releases
​integer · min: 0 · max: 9007199254740991 · required
features
​integer · min: 0 · max: 9007199254740991 · required
featureRequests
​integer · min: 0 · max: 9007199254740991 · required
customerInteractions
​integer · min: 0 · max: 9007199254740991 · required

MarketingNotesSummaryDTO

id
​string · required

The notes document's id.

headline
​string · required

The headline of its text; empty before its first draft.

state
​string · enum · required
Enum values:
none
draft
published
unpublished_changes
unpublished
​required

Its run in flight, else its newest; null when it never had one.

​required

When its first version was published: what dates it in What's new. Null before.

​required
​required

Readers' likes and dislikes in What's new; null outside Productmind's own workspace.

createdAt
​string
updatedAt
​string

MarketingReactionCountsDTO

likes
​integer · min: 0 · max: 9007199254740991 · required
dislikes
​integer · min: 0 · max: 9007199254740991 · required

MarketingReleaseBlogPostStateDTO

id
​string · required
title
​string · required

The post's title, from its text; empty before its first draft.

featureTitles
​string[] · required

The features the post is about that the reader may see: what names a post with no title yet.

state
​string · enum · required
Enum values:
none
draft
approved
approved_changes
​required

The post's run in flight, else its newest; null when it never had one.

MarketingReleaseDetailDTO

​MarketingReleaseCoreDTO · required
​MarketingReleaseSourceDTO[] · required

Attached sources, grouped by type then newest first.

​MarketingReleaseSourceCountsDTO · required
​MarketingReadinessDTO · required
canDelete
​boolean · required

Nothing of it was ever published, approved or emailed: it can be deleted. Archive it otherwise.

​MarketingNotesSummaryDTO[] · required

Its public release notes documents, newest first.

​BlogPostSummaryDTO[] · required

Its blog posts, newest first.

​object · required
​object · required

Its media: how many files are ready, and from which campaigns.

MarketingReleaseCoreDTO

id
​string · required
​required
title
​string · required
status
​string · enum · required
Enum values:
planned
in_progress
announced
archived
​required
createdAt
​string
updatedAt
​string

MarketingReleaseSourceDTO

type
​string · enum · required
Enum values:
release
feature
feature_request
customer_interaction
id
​string · required
​required

REL-4, FEAT-12, PFR-9; null for customer feedback.

title
​string · required
​required

The source's own status, as its own list words it; null for customer feedback.

attachedAt
​string · required
​required
​

A release's status: publishing waits until every attached release is Released or Deployed.

​

Customer feedback: the kind of conversation.

​

Customer feedback: when the conversation happened.

MarketingReadinessDTO

sourceCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required

Sources attached (releases, features, feature requests, customer feedback).

customerFacingFeatureCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required

Features (never private ones) the sources cover: attached ones and those attached releases shipped.

internalOnly
​boolean · required

Every source is a release, and none of their work is under a customer-facing feature.

​object · required

With no release attached, nothing waits.

MarketingOpenReleaseDTO

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

BlogPostSummaryDTO

id
​string · required
marketingReleaseId
​string · required
title
​string · required

The post's title, or "" before its first draft.

state
​string · enum · required
Enum values:
none
draft
approved
approved_changes
​BlogPostScope · required
featureTitles
​string[] · required

The titles of the features in scope, in scope order.

passageCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​required

The post's run in flight, else its newest one.

approvedVersionCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​
​

The post's place on the blog: null until its first publish (Productmind's own workspace only).

createdAt
​string
updatedAt
​string

BlogPostScope

featureIds
​string[] · required
​required
​object[] · required
​

The notes document the passages were picked from.

MarketingGenerationDTO

id
​string · required
status
​string · enum · required
Enum values:
pending
completed
failed
cancelled
acknowledgeInternalOnly
​boolean · required
​

A stable code for a failed run (MARKETING_ERROR_CODE).

​
​

What a blog post's run was asked for; null on the notes' runs.

​
createdAt
​string
​

BlogPostPublicationDTO

live
​boolean · required

The post is on the blog now.

slug
​string · required
​required
​required
​required
publicationId
​string · required

The approved version the blog serves (kept while unpublished).

​required

That version's number; null if it cannot be read.

​required

A newer approved version the blog does not serve yet (Update published moves it there); null when none.

​required
​required

When the version the blog serves last changed.

​required
​required
​required
​
​

MarketingReleaseBriefDTO

​MarketingReleaseCoreDTO · required
​MarketingReadinessDTO · required
​MarketingBriefFeatureDTO[] · required

The customer-facing features the sources cover, in the order of their references. Private features are never listed.

​MarketingBriefNotesDTO[] · required

Its public release notes documents, newest first. Take customer wording from a live one first.

​MarketingBriefBlogPostDTO[] · required

Its blog posts, newest first.

​object · required

The background to write from. Team material: never quote it as if customers had read it.

​object · required

What was already made for it; no campaign when nothing was rendered for it yet. List the files with list-marketing-release-media.

MarketingBriefFeatureDTO

ref
​string · required

Its reference in the sources text (F1, F2, ...): the section headed Feature n (ref Fn) is this feature.

id
​string · required

The feature's id: read its specification with it.

title
​string · required
shippedIn
​string[] · required

The attached releases that shipped it (REL-n); empty when none did.

attached
​boolean · required

It was attached to the Marketing release on its own.

reachedThrough
​string[] · required

The attached feature requests or customer feedback that led to it (their titles).

MarketingBriefNotesDTO

id
​string · required

The notes document's id.

headline
​string · required

The headline of text; empty before its first draft.

state
​string · enum · required
Enum values:
none
draft
published
unpublished_changes
unpublished
live
​boolean · required

A published version is live: text is exactly what customers read. False: text is the working draft.

​required

The live version's number; null when no version is live.

text
​string · required

The live version's text, in markdown, with its images left out. When no version is live, the working draft: customers have not seen it and it may still change.

truncated
​boolean · required

text was cut to fit: read the whole document for the rest.

MarketingBriefBlogPostDTO

id
​string · required

The blog post's id: read its text as a Marketing document of kind blog-post.

title
​string · required

The post's title, or "" before its first draft.

state
​string · enum · required
Enum values:
none
draft
approved
approved_changes
featureTitles
​string[] · required

The titles of the features the post is about.

MarketingMediaListDTO

​MarketingMediaDTO[] · required

Every ready file, a campaign's together.

limit
​number · required

How many files a Marketing release may hold.

MarketingMediaDTO

id
​string · required

The file's id.

releaseId
​string · required

The id of the Marketing release it belongs to.

kind
​string · enum · required

What the file is: clip (a video), loop (a short animated image), poster (a clip's still frame), banner (one still at a channel's exact pixels) or captions (a narrated clip's captions file).

Enum values:
clip
loop
poster
banner
captions
status
​string · enum · required

ready once the file was found in storage; pending while only a place was made for it.

Enum values:
pending
ready
source
​string · enum · required

Who put it there: a person's upload, the marketing studio's publish, or a coding session.

Enum values:
upload
studio
session
fileName
​string · required

The file's name: its path inside its campaign's output folder, or as the person named it.

contentType
​string · required
bytes
​number · required
sha256
​string · required
​required
​required
​required
​required
​required

The campaign it was rendered from; null for a person's own upload.

​required

The build of that campaign.

​required
​required

Where the same file also stands on a public host, when its campaign was published there; null otherwise.

​required

The coding session that rendered it, when one did.

​required
createdAt
​string · required
​required

MarketingMediaLinksDTO

​object · required

A link to each ready file's bytes, by the file's id, shown in place.

expiresAt
​string · required

When the links stop working. Read again before then.

MarketingMediaUploadsDTO

​MarketingMediaUploadDTO[] · required

One link a file, in the order the files were given.

MarketingMediaUploadDTO

mediaId
​string · required

The file's id: pass it to confirm-marketing-media once it is uploaded.

fileName
​string · required
uploadUrl
​string · required

Where to PUT the file's bytes. It works once the headers below are sent with it, until expiresAt.

​object · required

Every header the PUT must carry, exactly: with curl, one -H 'name: value' each, and --data-binary @<file>.

expiresAt
​string · required

When the link stops working.

ConfirmMarketingMediaDTO

​MarketingMediaDTO[] · required

The files found in storage: they are now listed in the Marketing release's media.

​object[] · required

The files that are not there, each with why: not uploaded yet, another size than announced, or an id this Marketing release does not have. Upload it and confirm again.

MarketingMediaDownloadDTO

url
​string · required

A link to the file's bytes, good for a few minutes.

expiresAt
​string · required

MarketingNotesDetailDTO

​MarketingReleaseCoreDTO · required
​MarketingNotesDTO · required
notesState
​string · enum · required
Enum values:
none
draft
published
unpublished_changes
unpublished
​MarketingReadinessDTO · required
​MarketingReleaseSourceDTO[] · required

What the notes are written from, read-only here.

​required

The run in flight, else the newest one (its failure shows until the next run).

​MarketingPublicationSummaryDTO[] · required

Newest first.

MarketingNotesDTO

artifactId
​string · required

The notes document's id: the release-notes room's subject.

headline
​string · required
summary
​string · required
body
​string · required
content
​string · required
status
​string · enum · required
Enum values:
draft
reviewed
published
updatedAt
​string · required

Send back as expectedUpdatedAt when publishing.

editedAfterGeneration
​boolean · required

The text differs from what the last generation wrote, so regenerating loses edits.

​
​
​

Bumped by every save of the collaborative document; null until its first.

​

When the notes were unpublished: no version is live. Null while a version is live or none exists.

​
​
createdAt
​string

MarketingPublicationSummaryDTO

id
​string · required
version
​integer · min: -9007199254740991 · max: 9007199254740991 · required
publishedAt
​string · required
​
​

MarketingPublishCheckDTO

canPublish
​boolean · required
​object[] · required
​object[] · required
possibleCustomerNames
​string[] · required

Names of contacts and accounts behind the release's customer evidence that appear in the text.

containsQuotes
​boolean · required
nextVersion
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​required
content
​string · required

The text a publish would copy, read together with expectedUpdatedAt.

MarketingPublicationDTO

id
​string · required
version
​integer · min: -9007199254740991 · max: 9007199254740991 · required
publishedAt
​string · required
marketingReleaseId
​string · required
notesId
​string · required

The notes document (or blog post) this is a version of.

content
​string · required
​
​

MarketingReaderFeedbackDTO

available
​boolean · required
likes
​integer · min: -9007199254740991 · max: 9007199254740991 · required
dislikes
​integer · min: -9007199254740991 · max: 9007199254740991 · required
opened
​integer · min: -9007199254740991 · max: 9007199254740991 · required

How many people opened the full notes in What's new, each counted once.

​MarketingReaderFeedbackConversationDTO[] · required

MarketingReaderFeedbackConversationDTO

interactionId
​string · required
source
​string · enum · required
Enum values:
list
entry
passage
​required
​required
​required

The published version that was live when it started.

status
​string · required
title
​string · required

The reader's opening words, or Feedback before they wrote any.

​required

The reader, as the conversation's contact names them.

startedAt
​string · required
path
​string · required

Where the conversation opens in the app, without the workspace prefix.

MarketingReaderReactionsPageDTO

available
​boolean · required
​MarketingReaderReactionDTO[] · required
total
​integer · min: -9007199254740991 · max: 9007199254740991 · required
page
​integer · min: -9007199254740991 · max: 9007199254740991 · required
limit
​integer · min: -9007199254740991 · max: 9007199254740991 · required

MarketingReaderReactionDTO

name
​string · required
email
​string · required
​required

The organization they were signed into when they reacted; null when unknown or since deleted.

reaction
​string · enum · required
Enum values:
like
dislike
reactedAt
​string · required

BlogPostScopeOptionsDTO

​BlogPostFeatureOptionDTO[] · required
​BlogPostNotesOptionDTO[] · required

Each published notes document's newest version, newest publish first; empty when none was published.

BlogPostFeatureOptionDTO

id
​string · required
title
​string · required
hasSpecification
​boolean · required

False when the feature's specification is empty.

customerRequestCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required

Feature requests promoted into the feature.

​
kind
​string · enum

Which tier the feature is, as its list row draws it.

Enum values:
domain
feature
component
​

A component's plane of the stack.

​

Where the feature was imported from, if anywhere.

status
​string · enum

The feature's status.

Enum values:
backlog
planned
in_development
stable
deprecated
​BlogPostCustomerRequestDTO[]

The feature requests promoted into the feature, newest first.

BlogPostCustomerRequestDTO

id
​string · required
title
​string · required
status
​string · enum · required
Enum values:
new
in_review
rejected
merged
promoted
source
​string · enum · required
Enum values:
internal_stakeholders
customer_feedback
market_signal
strategic_directive
support_pattern
competitive_intelligence
interestCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required

The interests on the request: the customers who asked for it.

​

BlogPostNotesOptionDTO

id
​string · required
headline
​string · required
version
​integer · min: -9007199254740991 · max: 9007199254740991 · required
publishedAt
​string · required
content
​string · required
​CustomerNotesSectionDTO[] · required

CustomerNotesSectionDTO

index
​integer · min: -9007199254740991 · max: 9007199254740991 · required
heading
​string · required
text
​string · required

BlogPostCreatedDTO

​BlogPostDetailDTO · required
​MarketingGenerationDTO · required

BlogPostDetailDTO

id
​string · required
marketingReleaseId
​string · required
title
​string · required

The post's title, or "" before its first draft.

state
​string · enum · required
Enum values:
none
draft
approved
approved_changes
​BlogPostScope · required
featureTitles
​string[] · required

The titles of the features in scope, in scope order.

passageCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​required

The post's run in flight, else its newest one.

approvedVersionCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required
content
​string · required
status
​string · enum · required
Enum values:
draft
reviewed
published
editedAfterGeneration
​boolean · required

The text differs from what the last completed run wrote, so regenerating loses edits.

​BlogPostScopeFeatureDTO[] · required

The features in scope, in scope order.

​required

The guidance the newest run used.

​MarketingPublicationSummaryDTO[] · required

Approved versions, newest first.

​object[] · required

What stops Approve, in order.

​
​

The post's place on the blog: null until its first publish (Productmind's own workspace only).

createdAt
​string
updatedAt
​string
​
​
​

BlogPostScopeFeatureDTO

id
​string · required
title
​string · required
hasSpecification
​boolean · required

False when the feature's specification is empty.

customerRequestCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required

Feature requests promoted into the feature.

inSources
​boolean · required

False when the feature is no longer a customer-facing feature of the sources.

​
kind
​string · enum

Which tier the feature is, as its list row draws it.

Enum values:
domain
feature
component
​

A component's plane of the stack.

​

Where the feature was imported from, if anywhere.

status
​string · enum

The feature's status.

Enum values:
backlog
planned
in_development
stable
deprecated
​BlogPostCustomerRequestDTO[]

The feature requests promoted into the feature, newest first.

BlogPostApproveCheckDTO

canApprove
​boolean · required
​object[] · required
​object[] · required
possibleCustomerNames
​string[] · required

Names of contacts and accounts behind the post's customer evidence that appear in the text.

containsQuotes
​boolean · required
nextVersion
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​required
content
​string · required

The text an approval would copy, read together with expectedUpdatedAt.

BlogPostPublishResultDTO

​BlogPostDetailDTO · required
​required

The deploy of the blog this asked for; null when it could not even be recorded. The post's change stands either way.

BlogDeployOutcomeDTO

​BlogDeployDTO · required
repeated
​boolean · required

True when a deploy of the same posts was asked for moments ago: it is answered and nothing new was started.

BlogDeployDTO

id
​string · required
reason
​string · enum · required
Enum values:
publish
unpublish
retry
​required
revision
​string · required

The live set's revision when the deploy was asked for.

state
​string · enum · required

requested (no answer yet), dispatched (accepted: a run was started), failed (refused: nothing started) or unknown (the answer was lost: a run may have started; it is never tried again by itself).

Enum values:
requested
dispatched
failed
unknown
requestedAt
​string · required
​required
​required
​required
​required
​required
​required
​required
​required
​

BlogStatusDTO

revision
​string · required

The revision of the posts on the blog as Productmind holds them now.

livePosts
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​object · required
​required

CustomerEmailOverviewDTO

​MarketingReleaseCoreDTO · required
​CustomerEmailNotesOptionDTO[] · required

The live notes documents, newest publish first: Write drafts picks one (the first by default).

​object[] · required

What refuses every send now: no live notes, the drafts' notes taken off since, attached releases not Released, a run in flight.

​required

The run in flight, else the newest one (its failure shows until the next run).

​required

When the newest completed run finished; null until one has.

​required

The notes document the newest completed run was written from.

​required

The notes version the newest completed run was written from.

​object · required
​CustomerEmailRecipientDTO[] · required
​CustomerEmailSkippedDTO[] · required

CustomerEmailNotesOptionDTO

id
​string · required
headline
​string · required
version
​integer · min: -9007199254740991 · max: 9007199254740991 · required

Its live (newest) published version.

publishedAt
​string · required

CustomerEmailRecipientDTO

contactId
​string · required

The recipient's own contact: drafts and sends are keyed on it.

contactIds
​string[] · required

Every contact sharing the address.

recipientKey
​string · required
name
​string · required
​required
​required
eligibility
​string · enum · required
Enum values:
eligible
no_email
invalid_email
opted_out
​CustomerEmailItemDTO[] · required
​CustomerEmailDraftDTO · required
​CustomerEmailSendStateDTO · required
​object[] · required

What refuses this recipient now (CUSTOMER_EMAIL_REFUSAL).

​object[] · required

CUSTOMER_EMAIL_WARNING: never blockers.

possibleCustomerNames
​string[] · required

Names of OTHER contacts and accounts behind the release's customer evidence that appear in the text.

CustomerEmailItemDTO

key
​string · required

request:<featureRequestId> or fix:<bugReportId>: the highlight key.

kind
​string · enum · required
Enum values:
request
fix
id
​string · required

The feature request's or bug report's id.

​required
title
​string · required
deliveredBy
​string[] · required

What delivered it: feature or task titles (a request), the bug itself (a fix).

​required
shippedRefs
​string[] · required

The sources it came through: release:<id>, feature:<id>, feature_request:<id>, customer_interaction:<id>, and the work an attached release shipped (task:<id>, bug_report:<id>).

written
​boolean · required

The newest completed run wrote a highlight for it; false means the fallback.

CustomerEmailDraftDTO

subject
​string · required
body
​string · required

Markdown.

edited
​boolean · required

A person's edit; false means the draft composed from the highlights.

​required

The edit's updatedAt (null for a composed draft): send back as expectedDraftUpdatedAt / expectedUpdatedAt.

​required
newerDraftAvailable
​boolean · required

A run completed after the edit: Use the new draft.

​

The email's document, a person's edit: its images are filed under this id. Null for a composed draft.

privateImageCount
​integer · min: -9007199254740991 · max: 9007199254740991

Images in the text that are not public: they are left out of the email when it is sent.

CustomerEmailSendStateDTO

state
​string · enum · required
Enum values:
not_sent
sending
sent
failed
unconfirmed
sentCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required

Counted sends: send back as expectedSentCount.

​required
​required

The newest attempt.

​required

The newest counted send.

​required

CustomerEmailSkippedDTO

reason
​string · enum · required
Enum values:
account_without_contact
itemKey
​string · required
itemTitle
​string · required
​required

CustomerEmailDocumentDTO

id
​string · required

The document's id: the customer-email room's subject, and its comments' entityId.

edited
​boolean · required

A person edited the email; false while it is the composed draft.

CustomerEmailSendResultDTO

​object[] · required
sent
​integer · min: -9007199254740991 · max: 9007199254740991 · required
failed
​integer · min: -9007199254740991 · max: 9007199254740991 · required
refused
​integer · min: -9007199254740991 · max: 9007199254740991 · required

CustomerEmailSendLogPageDTO

​CustomerEmailSendLogRowDTO[] · required
total
​integer · min: -9007199254740991 · max: 9007199254740991 · required
page
​integer · min: -9007199254740991 · max: 9007199254740991 · required
limit
​integer · min: -9007199254740991 · max: 9007199254740991 · required

CustomerEmailSendLogRowDTO

id
​string · required
​required
recipientName
​string · required
recipientEmail
​string · required
​required
subject
​string · required
​object[] · required
status
​string · enum · required
Enum values:
sending
sent
failed
unconfirmed
deliveryNumber
​integer · min: -9007199254740991 · max: 9007199254740991 · required
sendAgain
​boolean · required
​required
​required
​required
​required
createdAt
​string · required
​required
​required

CustomerEmailSendDetailDTO

id
​string · required
​required
recipientName
​string · required
recipientEmail
​string · required
​required
subject
​string · required
​object[] · required
status
​string · enum · required
Enum values:
sending
sent
failed
unconfirmed
deliveryNumber
​integer · min: -9007199254740991 · max: 9007199254740991 · required
sendAgain
​boolean · required
​required
​required
​required
​required
createdAt
​string · required
​required
​required
body
​string · required

Exactly the text that was sent (markdown).

​required
​required
​required

MarketingDocumentDTO

kind
​string · enum · required

Which Marketing document: release-notes (one of a Marketing release's public release notes), blog-post (one of its blog posts) or customer-email (one customer's email about it).

Enum values:
release-notes
blog-post
customer-email
id
​string · required

The document's id: pass it back to propose-marketing-document-content.

releaseId
​string · required

The id of the Marketing release the document belongs to (never a technical release).

releaseName
​string · required

The Marketing release's title.

​required

The blog post's title, or the customer the email is for; null for the notes.

markdown
​string · required

The document's current text, exactly as it stands. Copy edits[].find passages from it.

generationInFlight
​boolean · required

A new draft is being generated: it will replace the whole text, so no suggestion is taken until it lands.

​required

A suggestion already waiting for review on this document: no second one is taken until a person settles it.

​

The Marketing release's number: MKT-<releaseDisplayId>.

MarketingDocumentProposalDTO

id
​string · required
subjectKind
​string · enum · required

Which Marketing document: release-notes (one of a Marketing release's public release notes), blog-post (one of its blog posts) or customer-email (one customer's email about it).

Enum values:
release-notes
blog-post
customer-email
subjectId
​string · required
releaseId
​string · required

The id of the Marketing release the document belongs to.

status
​string · enum · required
Enum values:
awaiting_review
applied
dismissed
superseded
baseMarkdown
​string · required

The document's text the suggestion was made against.

proposedMarkdown
​string · required

The whole document as the suggestion would leave it.

​required
reviewCommentIds
​string[] · required
​required
createdAt
​string · required
​required
​required

MarketingDocumentActiveProposalDTO

​required

SandboxDTO

id
​string · required
workspaceId
​string · required
name
​string · required
size
​SandboxSize · enum · required

Sandbox size: small (2 vCPU, 8 GB), medium (4 vCPU, 16 GB) or large (8 vCPU, 32 GB)

Enum values:
small
medium
large
applicationIds
​string[] · required
isDefault
​boolean · required
displayId
​number
description
​string
​
​
​SidecarEnvOutput[]
​WorkspaceEnvVarDTO[]
createdById
​string
createdAt
​string
updatedAt
​string

WorkspaceEnvVarDTO

key
​string · required
secret
​boolean · required
value
​string · required
isSet
​boolean · required

ApplicationDTO

id
​string · required
workspaceId
​string · required
name
​string · required
​WorkspaceEnvVarDTO[] · required
llmAssistedPreviewSetup
​boolean · required
displayId
​number
description
​string
​
​
​
​
​
requireDependencyInstall
​boolean
readOnly
​boolean
​
​PreviewPortOutput[]
​
​
​
​
​
​
activeScans
​string[]
Enum values:
readiness
discovery
documentation
​
​
createdById
​string
createdAt
​string
updatedAt
​string

ApplicationTemplateDTO

id
​string · required
name
​string · required
​
​
​
​

ApplicationFromTemplateDTO

id
​string · required
workspaceId
​string · required
name
​string · required
​WorkspaceEnvVarDTO[] · required
llmAssistedPreviewSetup
​boolean · required
displayId
​number
description
​string
​
​
​
​
​
requireDependencyInstall
​boolean
readOnly
​boolean
​
​PreviewPortOutput[]
​
​
​
​
​
​
activeScans
​string[]
Enum values:
readiness
discovery
documentation
​
​
createdById
​string
createdAt
​string
updatedAt
​string
​TemplateCopyReport

TemplateCopyReport

​object · required
​object · required
businessRulesCopied
​integer · min: 0 · max: 9007199254740991 · required

ApplicationEnvironmentDTO

environmentId
​string · required
key
​string · required
name
​string · required
tier
​string · enum · required

The environment's tier: production or non_production.

Enum values:
production
non_production
isDefault
​boolean · required
​required

The branch whose merges deploy to this environment: the application's own, else, for Development and Production, the workspace's Git workflow default. Null when a custom environment is unmapped.

source
​string · enum · required

Where the branch comes from: own, workspace_default or unmapped.

Enum values:
own
workspace_default
unmapped
​required

The cloud account this environment deploys to, or null when none is attached.

​required

The environment's deploys to its cloud account: the newest run, the one that runs now, the app's address, and whether a deploy can be retried or started. Null while the environment is attached to none and has no deploy recorded.

ApplicationEnvironmentAttachmentDTO

status
​string · enum · required

Where the environment's cloud account attachment is: requested (recorded, nothing set up yet), wiring, wired (deploying), rewiring after a branch change, paused while the account is frozen, detaching, or failed (it can be retried or detached).

Enum values:
requested
wiring
wired
rewiring
paused
detaching
detached
failed
kind
​string · enum · required

managed: an AWS account Productmind created for the workspace; byo: one the company owns and connected.

Enum values:
managed
byo
tier
​string · enum · required

The account's tier, always the environment's own.

Enum values:
production
non_production
branch
​string · required

The branch the environment deploys from, which its deploy role trusts. During a branch change it is the new branch, which the application's own branch may not name yet.

​required

The attached cloud account's id, for those who may read cloud accounts; null for anyone else.

​required

The attached AWS account, as a person reads it; null for those who may not read cloud accounts.

​required

Why the last step failed, while the status is failed; null otherwise, and for those who may not read cloud accounts.

​required

While the status is failed, what failed, which a retry goes on with: attach (setting up deploys), rewire (a branch change, or following a renamed repository) or detach. Null otherwise, and for those who may not read cloud accounts.

​required

True when the attachment failed and can be retried (not while its repository reads as having left Productmind's hosting: should it read present again, the failure says Productmind could not reach it, and a retry is offered); null for those who may not read cloud accounts.

​required

True while nothing has been set up for the environment outside Productmind yet: a request no step has taken, or one that failed before its first step. A detach then removes the attachment at once. Null for those who may not read cloud accounts.

​required

While the status is paused, why nothing deploys: organization_suspended, or account_not_active (the account does not take deploys now). Null while paused but the account takes deploys again (the environment is routed again within a few minutes), null for any other status, and for those who may not read cloud accounts.

​required

What became of the application's repository: renamed (the deployment is following the new name), departed (it reads as having left Productmind's hosting, so only a detach ends the attachment unless it reads present again), or null. Null for those who may not read cloud accounts.

​required

While the environment's branch change is carried out (rewiring, or failed part way), the branch it deployed from before; null otherwise.

​required

True when a detach of the company's own AWS account failed at its last step, removing the deploy role (Productmind can no longer reach the account, could not remove the role there, or failed for another reason), and can be closed, leaving the deploy role for the company to delete. When the repository had left Productmind's hosting, its deploy settings were not removed from it either. Null for those who may not read cloud accounts.

​required

While the detach can be closed, the deploy role it leaves in the company's own AWS account; null otherwise, and for those who may not read cloud accounts.

​required

While the detach can be closed: true when the application's repository had left Productmind's hosting, so its deploy settings stay on it as well as the deploy role in the account. Null otherwise, and for those who may not read cloud accounts.

​required

The environment's domain: the name its app., api., ws. and docs. hosts live under, whether public DNS delegates it yet, and whose it is; for those who may read cloud accounts, a domain the company owns also carries its DNS zone's name servers and the checks. Null while it has none.

​required

A domain change being prepared: the domain the environment moves to once it points at its DNS zone, as domain names one. Its hosts move at the first deploy after its deploy settings name it (domainPairAt). Null with no change pending.

​required

When the environment's domain last changed (ISO 8601). Its hosts move to it at the first deploy after its deploy settings name it (domainPairAt). Null while its domain never changed.

​required

When the repository's deploy settings came to name the environment's changed domain (ISO 8601): a deploy started after it moves the environment's hosts there. Null while its domain never changed, and after a change while the settings are still being written.

​

The environment's destroy: where one stands, and whether one is offered. Null while destroys are being set up after an update.

ApplicationEnvironmentDestroyDTO

​required

Where a destroy of the environment's stack stands: scheduled (a production environment's destroy waiting its day, still deploying), requested (under way: deploys stopped), restoring (a cancel putting it back in deploys), failed, or destroyed (its stack removed; Deploy again builds it anew). Null with none.

​required

When a scheduled destroy starts (ISO 8601), unless cancelled first. Null otherwise.

​required

When the destroy was asked for, or last tried again (ISO 8601). Null with none.

​required

When the stack was last removed (ISO 8601). Null while it never was.

detachAfter
​boolean · required

Whether the environment is detached from its cloud account once its stack is removed.

​required

Who asked for the destroy, or last tried it again. Null for a reader who may not read cloud accounts, and with none.

​required

Why a failed destroy failed, as a code. Null unless failed, and for a reader who may not read cloud accounts.

​required

What a failed destroy's failure means and what to do, in words. Null unless failed, and for a reader who may not read cloud accounts.

​required

Whether the environment can be destroyed now: deploying from its cloud account, with no destroy standing and no domain change under way. Null for a reader who may not read cloud accounts.

​required

Whether the environment's stack may run in this cloud account: a deploy of it there did more than not deploy, and no destroy removed the stack since. Null for a reader who may not read cloud accounts.

​required

Whether cancelling the destroy now also deploys the environment's branch, to put back what a failed destroy may have changed in the stack: true for such a failure, false where a cancel only puts the environment back in its deploys (scheduled, under way, or a failure that changed nothing). Null when no destroy can be cancelled now, and for a reader who may not read cloud accounts.

​required

Whether a failed destroy can be tried again now: deploying from its cloud account, no domain change under way, never a cancel GitHub refused, and none of the refusals a press always meets (a departed repository, a switched domain not deployed since, the account taking no deploys, a destroy run of the environment still queued or running, the organization's deletion scheduled). False where none applies. Null for a reader who may not read cloud accounts.

​required

Whether a destroyed environment can be built again now, as far as the environment and its account go: deploying from its cloud account, no domain change under way, and none of the refusals a press always meets. The attach rollout and the plan's Cloud accounts capability are the route's own checks. False where none applies. Null for a reader who may not read cloud accounts.

EnvironmentDeploymentBlockDTO

​required

The environment's newest run, deploy or destroy; null before the first.

​required

The newest run that deployed, which is what runs now; null before the first, and after a run that destroyed the stack.

​required

The environment's app, once a run deployed it and its domain is ready: its address follows the environment's own host settings.

retryable
​boolean · required

True when the newest run is a failed or cancelled deploy that can be run again.

deployable
​boolean · required

True when the environment's branch can be deployed now.

readOnly
​boolean · required

True once the repository left Productmind's hosting: the records stop there.

EnvironmentDeploymentDTO

id
​string · required
kind
​string · enum · required

deploy: a run of the repository's deploy workflow; destroy: a run of its destroy workflow.

Enum values:
deploy
destroy
status
​string · enum · required

Where the run is: queued (waiting for its turn or a runner), in_progress, or completed.

Enum values:
queued
in_progress
completed
​required

GitHub's conclusion of the run, once completed.

​required

Null while the run is not completed, or its result is still being read.

settled
​boolean · required

True once Productmind has read what the completed run did. Until then a completed run's outcome is null, or provisional: a failure whose jobs are still to be read.

runId
​string · required

GitHub's id of the run.

runNumber
​integer · min: -9007199254740991 · max: 9007199254740991 · required

The run's number in the repository's runs of its workflow.

runAttempt
​integer · min: -9007199254740991 · max: 9007199254740991 · required

The attempt: a retry is a new attempt of the same run.

latestAttempt
​boolean · required

False when a later attempt of the same run is recorded.

event
​string · required

What started the run: push (a merge into the branch) or workflow_dispatch (Deploy now).

headBranch
​string · required
headSha
​string · required

The commit the run deployed.

​required

The job that failed, by its name in the workflow.

​required

The step that failed, by its name in the workflow.

​required

The run on GitHub. Only Productmind support can open it while Productmind hosts the repository.

​required

The person whose Retry or Deploy now started this attempt, when Productmind started it.

runCreatedAt
​string · required

When GitHub created the run (ISO 8601).

​required
​required

ApplicationReadinessReportDTO

id
​string · required
workspaceId
​string · required
applicationId
​string · required
status
​string · enum · required
Enum values:
queued
running
completed
failed
​
​
​
​
​
​
​
hasCompletedRun
​boolean
​
createdAt
​string
updatedAt
​string

ApplicationDiscoveryRunDTO

id
​string · required
workspaceId
​string · required
applicationId
​string · required
objective
​string · enum · required
Enum values:
features
status
​string · enum · required
Enum values:
queued
running
completed
failed
​
​
​
​
​
hasCompletedRun
​boolean
​
createdAt
​string
updatedAt
​string

ApplicationDocumentationRunDTO

id
​string · required
workspaceId
​string · required
applicationId
​string · required
status
​string · enum · required
Enum values:
queued
running
completed
failed
​
​
​
​
​
hasCompletedRun
​boolean
​
createdAt
​string
updatedAt
​string

DetectableRepositoryDTO

workforceConnectorId
​string · minLength: 1 · maxLength: 1024 · required
externalRepoId
​string · minLength: 1 · maxLength: 1024 · required
repoName
​string · minLength: 1 · maxLength: 1024 · required
repoUrl
​string · minLength: 1 · maxLength: 1024 · required
provider
​string · minLength: 1 · maxLength: 1024 · required
baseBranch
​string · minLength: 1 · maxLength: 256 · required
owner
​string · minLength: 1 · maxLength: 1024 · required
private
​boolean
​
​

ApplicationDetectionRunDTO

id
​string · required
workspaceId
​string · required
status
​string · enum · required
Enum values:
queued
running
completed
failed
​
​
​
​
​
​
​
createdAt
​string
updatedAt
​string

ScanEstimateDTO

repositories
​integer · min: -9007199254740991 · max: 9007199254740991 · required

The repository count the estimate is for.

​object · required

The estimate in AI credits: median and 90th percentile.

​object · required

The estimate in euro cents at the plan's price per 1M AI credits, rounded up to the cent. For a user-hosted scan (userHosted), the plan's session fee of every session the scan starts instead, since it draws no AI credits. Null when the plan has no such price.

walletBalanceCents
​integer · min: -9007199254740991 · max: 9007199254740991 · required

The organization's pay-as-you-go balance in euro cents. May be negative.

coversMedian
​boolean · required

Whether a scan of this size may start now: the balance covers the median, or the scan is not charged from the balance.

userHosted
​boolean · required

The scan would run on the caller's own Productmind agent, which uses no AI credits (a session fee applies per session).

​required

Why a scan of this size would be refused right now, or null.

ScanStepFundingDTO

​object[] · required

ScanStepRefusal

​required

The billing error code the start would get. Null for a refusal no billing action lifts: your organization's own model provider key cannot run the scan.

message
​string · required

The sentence that refusal carries.

​required

The amounts behind a balance refusal (what the step needs, the balance, the top-up that covers it), or null.

ResumeWorkspaceScanResponseDTO

​WorkspaceScanRunDTO[] · required

The paused scan steps that were started again.

WorkspaceScanRunDTO

id
​string · required
workspaceId
​string · required
objective
​string · enum · required
Enum values:
architecture
feature_map
feature_map_deterministic
status
​string · enum · required
Enum values:
queued
running
completed
failed
paused
​
​
​
​
​
​
createdAt
​string
updatedAt
​string

LinkedFeatureDTO

id
​string · required
title
​string · required
status
​string · enum · required
Enum values:
backlog
planned
in_development
stable
deprecated
priority
​string · enum · required
Enum values:
low
high
critical
​
​

ApplicationRepoFileDTO

found
​boolean · required
​required
​required

ApplicationRepoPathsDTO

​required
​ApplicationRepoPathEntry[] · required
truncated
​boolean · required
total
​integer · min: 0 · max: 9007199254740991 · required

ApplicationRepoPathEntry

path
​string · required
type
​string · enum · required
Enum values:
file
dir

ApplicationApiSpecsDTO

​required
truncated
​boolean · required
​ApplicationApiSpecService[] · required
otherSpecs
​string[] · required

API description files no service took, best first

ApplicationApiSpecService

serviceName
​string · required
​required

The port the service serves on in a live preview

​required
pinnedMissing
​boolean · required

The pinned file is not in the repository at the base branch

ApplicationApiSpec

path
​string · required

The file's path in the repository

source
​string · enum · required

pinned by a person, or detected by the rule set

Enum values:
pinned
detected

ApplicationApiTargetsDTO

​ApplicationApiPreviewTarget[] · required
​ApplicationApiEnvironmentTarget[] · required

ApplicationApiPreviewTarget

sessionId
​string · required
​required
name
​string · required

The session's title

port
​integer · min: -9007199254740991 · max: 9007199254740991 · required
baseUrl
​string · required

The preview's address for that port, without the API's own base path

ApplicationApiEnvironmentTarget

environmentId
​string · required
name
​string · required
tier
​string · required

production or non_production

liveUrl
​string · required

The environment's live address

domain
​string · required

Requests may go to this host or any host under it

EnvironmentDTO

id
​string · required
key
​string · required
name
​string · required
tier
​string · enum · required

The environment's tier: production or non_production.

Enum values:
production
non_production
isDefault
​boolean · required

Development or Production: never deleted, and its tier never changes.

createdAt
​string
updatedAt
​string

CloudAccountDTO

id
​string · required
kind
​string · enum · required

managed: an AWS account Productmind created for the workspace; byo: one the customer owns and connected.

Enum values:
managed
byo
tier
​string · enum · required

production or non_production: only environments of the same tier can use the account.

Enum values:
production
non_production
status
​string · enum · required

Where the account is in its life. A managed account goes requested, creating, created, baselining, configuring, then ready; a connected one starts unverified. failed can be retried; retention, queued and closed follow a deletion; closed, handed_over and disconnected are final.

Enum values:
requested
creating
created
baselining
configuring
unverified
ready
failed
live
​boolean · required

False once the account is closed, handed over or disconnected; such an account is history.

​required

The 12-digit AWS account id, once known.

​required

The AWS region the account deploys to, once chosen.

​required

Why the last step failed, while the status is failed.

verifying
​boolean · required

True while Productmind is checking a connected account; it then becomes ready or failed.

cancellable
​boolean · required

True for a request for an account managed by Productmind that has not started: deleting it cancels the request.

​required

The version of the template the account's stack was created from, once checked.

​required

The default version of the account's workload boundary policy, recorded when it was last checked.

​required

When Productmind last checked the account and found it ready.

​required

The version of the terms accepted when the account was added.

​object · required

A managed account's own network, once its baseline has made it.

​required

When a deletion's retention ends; until then the deletion can be cancelled.

​required

When the account left Productmind, after a hand-over.

​required

When a connection to an account the company owns was disconnected, and Productmind deleted its ExternalId from its records.

​required
​

Since when a managed account has been frozen over its spend cap: what runs in it keeps serving, and nothing new can be deployed, created or started until this month's spend is under the cap. Null when it is not, and for an account the company connected itself.

createdAt
​string
updatedAt
​string

The environments that deploy to the account (live attachments), on a read of one account or the list; absent from a write's answer.

productmindAddress
​boolean

On the list alone: whether an environment attached to the account can take Productmind's address, a name under Productmind's own domain, now. False for an account the company connected itself, which needs a domain the company owns, and while Productmind's address isn't available to the organization; a domain the company owns works on either kind. Attaching decides: this says what it would answer. Absent from a read of one account and from a write's answer.

CloudAccountAttachmentRefDTO

id
​string · required

The attachment's id.

applicationId
​string · required

The application whose environment deploys to the account. It may have been deleted since.

environmentId
​string · required

The environment's id.

environmentKey
​string · required

The environment's key, which never changes.

status
​string · enum · required

Where the environment's cloud account attachment is: requested (recorded, nothing set up yet), wiring, wired (deploying), rewiring after a branch change, paused while the account is frozen, detaching, or failed (it can be retried or detached).

Enum values:
requested
wiring
wired
rewiring
paused
detaching
detached
failed
awaitingDomain
​boolean · required

True while the environment is being set up and waits for a domain the company owns to point at its DNS zone: the company's DNS change is next.

CloudAccountCostEstimatesDTO

cloudAccountId
​string · required
month
​string · pattern: ^\d{4}-(0[1-9]|1[0-2… · required

The month answered, YYYY-MM in UTC.

kind
​string · enum · required

estimate: the current month, or a closed month AWS has not closed yet; statement: the month's amount, fixed once AWS closed the month.

Enum values:
estimate
statement
state
​string · enum · required

For an estimate: estimated, no_costs, not_read_yet, or not_estimated (an account the company connected itself, which AWS bills directly, or a managed account that has no AWS account yet). For a statement: pending (not charged yet), charged, invoiced, zero (nothing to charge) or held (not charged for now; note says why).

Enum values:
estimated
no_costs
not_read_yet
not_estimated
pending
charged
invoiced
zero
​required

Why a held month is not charged, in words: AWS's figures for the month need a review (no total is shown until they are settled), or the account was handed over to the company. Null for every other month.

​required

When the figures were read from AWS (an estimate), or when the statement was made.

​required

The days the account has been the workspace's, from and to (null while it still is).

currency
​string · const · required
Const value: EUR
​required

The month's amount in euros, rounded up to the cent; null when there is nothing to convert yet, or for a month held for review (note says why).

​required

The last day the figures cover.

​required

What the total is computed from. A statement's are fixed when it is made; an estimate's are today's plan and the latest rate.

​required

How a statement was charged: from the balance or on an invoice. Null until it is charged.

​object[] · required

The total per day, in order; the days add up to the total.

​object[] · required

The total per AWS service, largest first; they add up to the total. A service with nothing to charge is left out.

​object[] · required

The total per application environment, largest first, with the unallocated part; they add up to the total.

​object[] · required

Every month the account has figures for, newest first.

​

The account's spend cap for the open month: its cap and where its ceiling comes from, this month's figure, the warning's threshold, and whether it is frozen over the cap. Null for any other month, an account the company connected itself, a managed account with no AWS account yet, one queued for closure or closed, or while caps are being set up.

CloudAccountSpendCapDTO

month
​string · required

The month the figure is of, YYYY-MM in UTC: the open month.

cap
​string · pattern: ^\d+\.\d{2}$ · required

The effective cap in euros: the account's own cap, never above its ceiling.

ceiling
​string · pattern: ^\d+\.\d{2}$ · required

The most an Owner or Admin may set, in euros.

ceilingSource
​string · enum · required

Where the ceiling comes from: plan (the plan's value for the account's tier), organization (a value Productmind set for the organization), account (a value Productmind set for this account), or default (the platform's default for the tier).

Enum values:
account
organization
plan
default
​required

The cap an Owner or Admin set, in euros; null when the account follows its ceiling.

​required

This month's AWS spend in euros as charged, excluding VAT, as the Costs section prices it; null when there is no rate to convert with yet.

​required

Where the figure comes from: estimate, the daily cost estimates; null before the month's first read.

​required

When the figure was read from AWS; null before the month's first read.

​required

The figure at which the Owner and Admins are warned: 80% of the cap; null for a cap of 0, which no warning precedes.

warned
​boolean · required

Whether this month's warning was given.

held
​boolean · required

Whether the account is frozen over its cap now: nothing new deploys, is created or started until the month's spend is under the cap.

​required
​object[] · required

What Productmind limited in the account to stop its spend, while it stays limited.

AuditLogListResponse

​AuditEventListItemDTO[] · required
​required

Pass back as cursor for the next page; null on the last page.

​required

The Athena execution the page came from (result reuse); null for the local store.

windowFrom
​string · required

The event-time window the read was bounded to, ISO-8601 — 90 days ending at to unless from was given.

windowTo
​string · required

AuditEventListItemDTO

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

The event id (event_id).

eventTime
​string · required

When the change committed, ISO-8601 UTC.

operationId
​string · required

Shared by an attempted/completed pair and by every subject of one bulk operation.

sequence
​integer · min: -9007199254740991 · max: 9007199254740991 · required

0-based order inside operationId.

phase
​string · enum · required

completed for every ordinary change; attempted / failed bracket a destructive operation — an attempted with no completed means the process died mid-operation.

Enum values:
attempted
completed
failed
action
​string · enum · required
Enum values:
create
update
delete
soft_delete
bulk_delete
purge
workspace_reset
workspace_provision
entityType
​string · required

The audited entity type (registry key), e.g. task.

​required
​required

Writer-formatted, e.g. TASK-12. Null only where the row never had one — a create carries it, read back from the database in the capturing flush.

​required

The entity's title/name at the time of the change.

scope
​string · enum · required
Enum values:
workspace
organization
platform
​required
​required

Null for org-level governance rows (roles, memberships, SSO), which every workspace view of the org shows.

​required
​required
actorKind
​string · enum · required

browser = a person; agent = a delegated coding-session token; service = a machine caller; impersonated = a service acting on behalf of a user; support = a Productmind Architect through a support grant (actorTokenId is the grant id).

Enum values:
browser
agent
service
impersonated
legacy
support
local_agent
mcp_client
​required
​required
​required
onBehalfOf
​boolean · required
​required

The automation run whose agent made the change, when one did.

source
​string · enum · required
Enum values:
http
admin
reaper
ws
compaction
tier-move
migration-lambda
cli
​required
​required
​required

The matched route PATTERN (/workspaces/:workspaceId/tasks/:id), never the concrete path.

changedFields
​string[] · required

The field names present in changes, after redaction.

​object · required

Per-field before/after, keyed by field name — inline, so the detail view needs no second read.

changesTruncated
​boolean · required

True when the record was too large and changes was dropped to {}.

​required

{ entityType: count } of dependants removed by a destructive operation.

​required
producer
​string · required

api@<version>.

​required
actorRedacted
​boolean · required

True when this organization's view withheld the actor's email and avatar because they are not one of its own people - a Productmind Architect. The page badges exactly these actors.

AuditChangeDTO

kind
​string · enum · required
Enum values:
tracked
large
secret
from
​
to
​
from_length
​integer · min: 0 · max: 9007199254740991
to_length
​integer · min: 0 · max: 9007199254740991
truncated
​boolean

PullRequestCheckFailuresResultDTO

​required
​PullRequestCheckFailureDTO[] · required
​required

PullRequestCheckFailureDTO

externalId
​string · required
name
​string · required
​required
​required
​required
​required
​PullRequestCheckAnnotationDTO[] · required
​required
logTruncated
​boolean · required

PullRequestCheckAnnotationDTO

path
​string · required
​required
​required
​required
​required
​required

ArchitectureGraphDTO

​ArchitectureNodeDTO[] · required
​ArchitectureEdgeDTO[] · required
​

ArchitectureNodeDTO

id
​string · required
​required
​required
name
​string · required
isApplication
​boolean · required
​
​
​
​
​
featureCount
​integer · min: -9007199254740991 · max: 9007199254740991

ArchitectureEdgeDTO

id
​string · required
sourceType
​string · required
sourceId
​string · required
targetType
​string · required
targetId
​string · required
​
​
​

ServiceFeatureDTO

id
​string · required
​required
title
​string · required
kind
​string · enum · required
Enum values:
domain
feature
component
​required
​required
status
​string · enum · required
Enum values:
backlog
planned
in_development
stable
deprecated
source
​string · enum · required
Enum values:
manual
folder

FeatureMapScanModeDTO

proposes
​boolean · required

True when the run writes nothing and proposes its changes for review.

​required

Why it proposes; null when it writes directly.

scannedBefore
​boolean · required

True when a catalogue scan has run here before: the run is a re-scan, not a first scan.

FeatureMapProposalSummaryDTO

id
​string · required
status
​string · enum · required
Enum values:
pending
applied
discarded
superseded
arm
​string · enum · required
Enum values:
deterministic
agentic
​required
​required
​required
​object · required
hiddenCount
​number · required
suppressedCount
​number · required
​required
​object[] · required
​required

How the scan connected the existing features to what it found. Null on a proposal made before this was recorded.

​required
​required
​required
​required
​required
createdAt
​string

FeatureMapProposalDTO

id
​string · required
status
​string · enum · required
Enum values:
pending
applied
discarded
superseded
arm
​string · enum · required
Enum values:
deterministic
agentic
​required
​required
​required
​object · required
hiddenCount
​number · required
suppressedCount
​number · required
​required
​object[] · required
​required

How the scan connected the existing features to what it found. Null on a proposal made before this was recorded.

​required
​required
​required
​required
​required
​FeatureMapDeltaDTO[] · required
​object[] · required
​object[] · required

Existing features the scan matched to none of its code, limited to the ones this reader may list.

unmatchedHiddenCount
​number · required

Unmatched features left out of the list: private to this reader, or past the list's limit.

​required
createdAt
​string

FeatureMapDeltaDTO

id
​string · required
type
​string · enum · required
Enum values:
link
add
rename
move
remove
merge
status
​string · enum · required
Enum values:
pending
accepted
amended
declined
skipped
applied
​required
​required

FEAT-n, COMP-n or DOM-n of the feature the change is about.

​required
​required

The feature's title now, which a move or merge row names it by.

​required

The feature's provenance marker (repo_discovered for one a scan made), for its leading glyph.

​required

A component's layer (view, API service, data repository), for its leading glyph; null on a feature or domain.

​required
​required
​required
​required
​required
​required
evidence
​string[] · required
editedByPerson
​boolean · required
changedSinceScan
​boolean · required

The feature changed after the scan read it: its title, place or status no longer matches the row's before value.

​required
​required
​required
carriedOver
​boolean · required
​required

The row this one follows: an addition's parent addition, else the row of the same type on the nearest feature above its own. Null when it stands on its own.

​required

person for a decision made on this row, inherited for one it follows from the row above; null while undecided.

​required

An inherited decision's origin: the row whose decision it follows.

​object[] · required

Tags held on the change. They land on its feature when it is applied accepted or amended.

​AssigneeRefDTO[] · required

Who the change is assigned to: people and teams.

​required

person, inherited (from a row above a person assigned) or owner (its feature's owners); null when unassigned.

​required

An inherited assignment's origin: the row a person assigned.

assignedToViewer
​boolean · required

Assigned to the reader, or to a team they belong to.

commentCount
​number · required

Comments in the change's thread.

​

FeatureGraphDTO

​FeatureGraphNodeDTO[] · required
​FeatureGraphEdgeDTO[] · required
​

FeatureGraphNodeDTO

id
​string · required
title
​string · required
depth
​number · required
status
​string · enum · required
Enum values:
backlog
planned
in_development
stable
deprecated
priority
​string · enum · required
Enum values:
low
high
critical
isAiGenerated
​boolean · required
kind
​string · enum · required
Enum values:
domain
feature
component
​object[] · required
​
​
specificationState
​string · enum
Enum values:
queued
scanning
awaiting_review
pending
failed
​
​

FeatureGraphEdgeDTO

id
​string · required
sourceId
​string · required
targetId
​string · required
​
​

LatestWorkspaceScanRunDTO

id
​string · required
workspaceId
​string · required
objective
​string · enum · required
Enum values:
architecture
feature_map
feature_map_deterministic
status
​string · enum · required
Enum values:
queued
running
completed
failed
paused
​
​
​
​
​
​
createdAt
​string
updatedAt
​string
​

When a scan of this kind last completed; null when none ever has.

FeatureDeepScanResultDTO

startedFeatureIds
​string[] · required
​object[] · required

SessionSkillDTO

workspaceId
​string · required
version
​string · required
content
​string · required

SessionContextDTO

content
​string · required

SessionScopePreflight

ready
​boolean · required

True when the session would clone at least one repository and has a sandbox and somewhere to run: the Productmind cloud, or, while cloud sessions are turned off for the workspace, the person's own Productmind agent.

​SessionScopeBlocker[] · required

Empty when ready.

​required

The sandbox the session would run in - the caller's choice, else the workspace default.

​SessionScopeApplication[] · required

Every application in the workspace, so the user can be offered the ones not yet in scope.

​SessionScopeRepository[] · required

What the session would actually clone, deduplicated.

The sandboxes to choose from. Present only for a caller who may read them, and only when the choice is open.

SessionScopeBlocker

code
​string · enum · required
Enum values:
no_application
no_application_with_repository
no_sandbox
no_default_sandbox
no_repositories_resolved
no_local_agent
message
​string · required

Plain-language statement of what is missing and who can fix it — relay it to the user.

SessionScopeSandbox

id
​string · required
​required
name
​string · required
isDefault
​boolean · required

SessionScopeApplication

id
​string · required
​required
name
​string · required
​required
​required
attachedToSandbox
​boolean · required

SessionScopeRepository

repoName
​string · required
​required
applicationId
​string · required
via
​string · enum · required
Enum values:
sandbox
task
bug_report
explicit
readOnly
​boolean · required

True when an application on this repository is read-only: the session would read it for context and never push to it or open a pull request on it.

Default: false

CodeChatDTO

sessionId
​string · required
chatId
​string · required
​SessionDTO

SessionMenuItemDTO

id
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required
​required
name
​string · required
category
​string · enum · required
Enum values:
plan
live
scan
bugfix
code_chat
status
​string · enum · required
Enum values:
in_planning
planning
awaiting_user_input
awaiting_plan_approval
plan_approved
building
in_progress
paused
​required

SessionRunnerDTO

key
​string · required

cloud, mcp, none, or the Productmind agent's UUID

​required

The build mode behind it; null for sessions not started yet

​required

The Productmind agent's UUID, for an agent

​required

The Productmind agent's name, as its most recent session recorded it

AddSessionItemsResult

message
​string · required
​SessionSuggestedRepository[] · required

SessionSuggestedRepository

applicationId
​string · required
applicationName
​string · required
repoName
​string · required

SessionTaskDTO

id
​string · required
displayId
​string · required
title
​string · required
description
​string · required
status
​string · enum · required
Enum values:
todo
in_planning
in_progress
in_testing
in_review
done

SessionFeatureDTO

id
​string · required
displayId
​string · required
title
​string · required
description
​string · required
restricted
​boolean

SessionBugReportDTO

id
​string · required
displayId
​string · required
title
​string · required
description
​string · required
severity
​string · enum · required
Enum values:
minor
major
critical
blocker
status
​string · enum · required
Enum values:
open
in_review
confirmed
in_progress
resolved
closed
merged
priority
​string · enum · required
Enum values:
low
high
critical
​SessionBugReportReporterDTO[] · required
​SessionBugReportRelatedEntityDTO[] · required

SessionBugReportReporterDTO

name
​string · required
details
​string · required

The reporter's own words — usually the repro steps

SessionBugReportRelatedEntityDTO

entityType
​string · required

feature | application | task | …

entityId
​string · required
displayId
​string · required
title
​string · required
relationshipType
​string · required

SessionBugReportConvertedTaskDTO

id
​string · required
displayId
​string · required
title
​string · required
status
​string

DraftPlanFromChatResponse

anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: promoted, sessionId
type = object · requires: scheduled, sessionId
Properties for Variant 1:
promoted
​boolean · const · required
Const value:
sessionId
​string · required

SessionAgentStatus

​object · required
​object · required
​object · required

SessionDispatchReadiness

ready
​boolean · required
​required
​SessionPushAccess

SessionPushAccess

verdict
​string · enum · required
Enum values:
ok
held
warning
unknown
checkedAt
​string · required
runKind
​string · required
​SessionPushAccessRepository[] · required

SessionPushAccessRepository

repoName
​string · required
workingBranch
​string · required
verdict
​string · enum · required
Enum values:
ok
refused
warning
unknown
reason
​string · enum · required
Enum values:
ok
cannot_push
no_access
archived
permission_not_granted
sso_required
branch_rule
unverified
​required
sentence
​string · required
​required
​SessionPushAccessRule[] · required
pusher
​string · enum
Enum values:
creator
workspace
​
​

SessionPushAccessRule

source
​string · enum · required
Enum values:
github_ruleset
github_branch_protection
gitlab_protected_branch
gitlab_push_rule
name
​string · required
rule
​string · required
effect
​string · enum · required
Enum values:
refuse
warn
detail
​string · required
pattern
​string
requiredAccessLevel
​string

SessionCostDTO

currency
​string · required

ISO 4217 currency of every amount, lower case

chargedCents
​integer · min: -9007199254740991 · max: 9007199254740991 · required

Everything the session was charged so far, in cents: AI credits, sandbox time and the session fee

​object · required

The session's AI credits

​object · required

Sandbox time; a preview still running is charged when it stops

​required

The fee for a session built on your own machine, in cents (0 when your plan includes it); null when there is none

billedByInvoice
​boolean · required

True when some of this cost is billed on your organization's invoice instead of its credit balance

floor
​boolean · required

True when a turn is still running, or ended before reporting its final usage: the totals are a lower bound

​SessionCostTurn[] · required

Every turn that drew AI credits, oldest first

SessionCostTurn

key
​string · required

Stable id of the turn within the session

label
​string · required

What the turn did: plan, build, documentation, pr_review, live_edit, publish_live, scan, or another step name

firstAt
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

When the turn's first usage was recorded

lastAt
​string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

When the turn's latest usage was recorded

credits
​integer · min: -9007199254740991 · max: 9007199254740991 · required

AI credits the turn drew

chargedCents
​integer · min: -9007199254740991 · max: 9007199254740991 · required

What the turn's AI credits were charged, in cents

complete
​boolean · required

False while the turn is still running, or when it ended before reporting its final usage (its figures are a lower bound)

SessionGitIdentity

​required
​SessionGitIdentityAccount[] · required
​SessionGitIdentityRepository[] · required

SessionGitIdentityAccount

provider
​string · enum · required
Enum values:
github
gitlab
bitbucket
connected
​boolean · required
​required

SessionGitIdentityRepository

repoName
​string · required
provider
​string · enum · required
Enum values:
github
gitlab
bitbucket
actor
​string · enum · required
Enum values:
user
workspace
​required
​required

SessionTranscriptUploadDTO

uploadId
​string · required

Pass this to import-session-transcript once command has run.

uploadUrl
​string · required

Where command uploads the transcript. It expires at expiresAt; you do not need to use it yourself.

expiresAt
​string · required

ISO 8601 time the upload URL stops working. Request a new upload after it.

maxBytes
​number · required

The largest upload the import accepts, in bytes.

command
​string · required

Run this verbatim with your shell tool. It finds your own conversation's transcript on this machine (the one file holding uploadId) and uploads it. The person may be asked to approve it; it needs network access.

SessionTranscriptImportResultDTO

client
​string · enum · required

The transcript format that was read.

Enum values:
claude_code
codex
copilot
complete
​boolean · required

False when the import stopped at its time limit: call import-session-transcript again with the same uploadId until it is true.

imported
​number · required

Conversation entries added to the session by this call.

skipped
​number · required

Entries the session already had from an earlier share, left as they were.

images
​number · required

Images from your conversation (screenshots in tool results, images in prompts) that the session now shows. When above zero, do not upload those screenshots again.

omittedImages
​number · required

Images that could not be stored (too large, unsupported type, or the session's attachment limit).

conversationIds
​string[] · required

Your client's own id for the conversation that was read.

PlanQuestionDispatchDTO

​required

SessionRunErrorList

​SessionRunError[] · required
total
​integer · min: 0 · max: 9007199254740991 · required
fatal
​integer · min: 0 · max: 9007199254740991 · required
lastRunStopped
​boolean · required

SessionRunError

id
​string · required
sessionId
​string · required
code
​string · required
severity
​string · enum · required
Enum values:
fatal
error
warning
stage
​string · enum · required
Enum values:
dispatch
runner
workspace
clone
checks
install
agent
publish
title
​string · required
message
​string · required
​required
​required
detailsHidden
​boolean · required
​required
​required
applicationIds
​string[] · required
​required
source
​string · enum · required
Enum values:
codeflow
apps
​required
occurredAt
​string · required
​

SessionRunErrorSession

id
​string · required
​required
name
​string · required

SessionRunErrorBugFixState

​required
​required

SessionRunErrorBugReportRef

id
​string · required
​required

SessionRunErrorBodyAccess

url
​string · required
expiresAt
​string · required

ISO 8601 time the URL stops working

​required

SessionRunErrorBugFix

created
​boolean · required
​object · required
​SessionRunErrorSession · required

SessionSubagentList

​SessionSubagent[] · required
running
​integer · min: 0 · max: 9007199254740991 · required
total
​integer · min: 0 · max: 9007199254740991 · required
​required

SessionSubagent

id
​string · required

The sub-agent's id in Productmind

sessionId
​string · required
provider
​string · enum · required
Enum values:
claude
codex
externalId
​string · required

The provider's id for it: Claude's task id, Codex's thread id

​required

The sub-agent that started this one; null when the main agent did

​required

The tool call that started it

​required
​required
status
​string · enum · required
Enum values:
running
reported_back
failed
stopped
​required
startedAt
​string · required
​required
resumeCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required
messageCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​required

SessionSubagentUsage

​required
​required
​required

SessionSubagentAvailability

provider
​string · enum · required
Enum values:
claude
codex
​required
state
​string · enum · required
Enum values:
available
on_request
unavailable
​required
​required
reportedAt
​string · required

SessionSubagentDetail

id
​string · required

The sub-agent's id in Productmind

sessionId
​string · required
provider
​string · enum · required
Enum values:
claude
codex
externalId
​string · required

The provider's id for it: Claude's task id, Codex's thread id

​required

The sub-agent that started this one; null when the main agent did

​required

The tool call that started it

​required
​required
status
​string · enum · required
Enum values:
running
reported_back
failed
stopped
​required
startedAt
​string · required
​required
resumeCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required
messageCount
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​required
​SessionSubagentSettings · required
​required

Its final report, markdown

​required

What went wrong, when it failed

SessionSubagentSettings

​required
​required
​required
​required
​required
​required
​required

SessionSubagentMessage

id
​string · required
subagentId
​string · required
sessionId
​string · required
position
​integer · min: -9007199254740991 · max: 9007199254740991 · required
source
​string · required
kind
​string · required
content
​string · required
createdAt
​string · required
updatedAt
​string · required
​object

SessionPullRequestDTO

url
​string · uri · required
source
​string · enum · required
Enum values:
auto
manual
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
​required
behindByCapped
​boolean · required
syncSupported
​boolean · required
​required
​
​
​
​
​
​
​

PullRequestCommitsResultDTO

​PullRequestCommitDTO[] · required

PullRequestCommitDTO

sha
​string · required
title
​string · required
​required
​required
​required

SessionPullRequestCheckRerunResultDTO

url
​string · required
externalId
​string · required
​required

OpenPullRequestResponse

pullRequestUrl
​string · required

SessionDocumentationContextDTO

markdown
​string · required
​SessionDocumentationContextApplicationDTO[] · required
draftingInstructions
​string · required

SessionDocumentationContextApplicationDTO

id
​string · required
​required
name
​string · required
​required
workingDirectory
​string · required
hasTechnicalDocs
​boolean · required
docIndexMarkdown
​string · required

SessionDocumentationContextFeatureDTO

id
​string · required
​required
title
​string · required
hasSpecification
​boolean · required

SessionConversationDTO

sessionId
​string · required
content
​string · required
truncated
​boolean · required
chatId
​string

SessionPreviewTokenResponse

token
​string · required
expiresAt
​string · required

SessionPreviewShareDTO

available
​boolean · required
​required
canManage
​boolean · required
enabled
​boolean · required
expiry
​string · enum · required
Enum values:
1d
7d
30d
never
​required
expired
​boolean · required
​required
commentsEnabled
​boolean · required
aiRepliesEnabled
​boolean · required
​required
​required
​required

CodingErrorsSummary

days
​integer · min: -9007199254740991 · max: 9007199254740991 · required
​required
​object · required
​object[] · required
​object[] · required
​object[] · required
​object[] · required
​object[] · required

CodingErrorsList

​SessionRunError[] · required
​required

SkillPreviewDTO

content
​string · required

SettingDTO

id
​string · required
domain
​string · required
​required
namespace
​string · required
name
​string · required
value
​

SettingValueDTO

namespace
​string · required
name
​string · required
value
​

TagDTO

id
​string · required
entity
​string · enum · required
Enum values:
account
feature_request
bug_report
feature
task
session
release
customer_interaction
entityId
​string · required
name
​string · required
source
​string · enum · required

Who applied the tag: user (a person or API caller) or generated (stamped by the platform)

Enum values:
user
generated
status
​string · enum · required

active — the entity carries the tag. suggested — proposed by the tagger, inert until a person accepts it (only returned with includeSuggested=true). rejected rows are never returned.

Enum values:
active
suggested
rejected
​

The tagger's one-line justification for a suggested tag

createdAt
​string
updatedAt
​string

TagGenerateResponseDTO

queued
​integer · min: -9007199254740991 · max: 9007199254740991 · required

How many tag.generate messages were published

entityIds
​string[] · required

TagSuggestionsAcceptResponseDTO

accepted
​integer · min: -9007199254740991 · max: 9007199254740991 · required

TagSuggestionNewNameDTO

name
​string · required
count
​integer · min: -9007199254740991 · max: 9007199254740991 · required

How many entities of the type the tagger proposed it on

TagSuggestionByNameResponseDTO

affected
​integer · min: -9007199254740991 · max: 9007199254740991 · required

How many suggested rows were accepted / rejected

FeatureTemplateDTO

content
​string · required

FeatureRequestTemplateDTO

content
​string · required

GitBranchDTO

name
​string · required
isDefault
​boolean
protected
​boolean

GitBranchPresenceDTO

provider
​string · required
externalRepoId
​string · required
​required

The GitLab server the repository is on, as its key names it; null for gitlab.com, GitHub and Bitbucket

​required

Whether the repository has the branch; null when its branches could not be read

GitConnectionAccess

​required

The connection's provider, read from its Applications; null when none use it

supported
​boolean · required

Whether this provider's connection can be checked yet (GitLab)

​required

The account every action on this connection runs as; null when nothing was checked

​object[] · required
​required

Why the check could not run, e.g. gitlab_connection_refused: the connection must be reconnected

GitConnectionWebhooks

​required

The connection's provider, read from its applications; null when none use it

supported
​boolean · required

Whether Productmind manages this provider's webhooks (GitLab, Bitbucket)

​required

The URL every webhook of this connection delivers to; null when the provider was not asked

​GitConnectionWebhookProject[] · required

One per project, in the order of its first application's name

​required

Why the provider could not be asked about every project: gitlab_connection_refused (reconnect the connection), timeout, or another failure

GitConnectionWebhookProject

externalRepoId
​string · required

The GitLab project's id, or the Bitbucket repository's UUID

repoName
​string · required

The project's path (group/name, or workspace/slug on Bitbucket), as its applications record it

​required

The project's URL, as its applications record it

​object[] · required

The applications that use the project: a monorepo's are several

status
​string · enum · required

present: a webhook delivers merge requests (pull requests on Bitbucket) to this connection. stale: it delivers to a connection of this workspace that was replaced. missing: none delivers to this workspace. added / repointed: Productmind just added one, or moved the stale one onto this connection. no_permission: the connection's account cannot manage the project's webhooks (on GitLab it takes Maintainer; on Bitbucket, repository admin and a connection allowed to manage webhooks), so a person adds it by hand. not_found: the provider does not show the account the project. failed: the provider refused for another reason, in detail. unchecked: the provider could not be asked; error says why.

Enum values:
present
stale
missing
added
repointed
no_permission
not_found
failed
​required

The provider's id of the webhook, where there is one

disabled
​boolean · required

GitLab turned the webhook off after failed deliveries. A successful test request from the webhook's page in GitLab turns it back on.

​required

What the provider said, where it refused or failed

GitConnectorRebindResult

applications
​integer · min: -9007199254740991 · max: 9007199254740991 · required

Application repository blobs repointed

sessionRepositories
​integer · min: -9007199254740991 · max: 9007199254740991 · required

Session git-repository rows repointed

releaseApplications
​integer · min: -9007199254740991 · max: 9007199254740991 · required

Release application snapshots repointed

notificationChannels
​integer · min: -9007199254740991 · max: 9007199254740991 · required

Channel subscriptions repointed

unresolved
​string[] · required

Repositories no connected provider can currently serve. Left pointing at their existing connector on purpose — a reconnect that granted access to fewer repositories must surface, not be silently rebound onto a connector that cannot see them.

​object

Present when the workspace has a GitLab connection with projects in use: after the links are repaired, each project's merge request webhook that still delivers to a replaced connection is moved onto the live one

AuditEventDetailDTO

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

The event id (event_id).

eventTime
​string · required

When the change committed, ISO-8601 UTC.

operationId
​string · required

Shared by an attempted/completed pair and by every subject of one bulk operation.

sequence
​integer · min: -9007199254740991 · max: 9007199254740991 · required

0-based order inside operationId.

phase
​string · enum · required

completed for every ordinary change; attempted / failed bracket a destructive operation — an attempted with no completed means the process died mid-operation.

Enum values:
attempted
completed
failed
action
​string · enum · required
Enum values:
create
update
delete
soft_delete
bulk_delete
purge
workspace_reset
workspace_provision
entityType
​string · required

The audited entity type (registry key), e.g. task.

​required
​required

Writer-formatted, e.g. TASK-12. Null only where the row never had one — a create carries it, read back from the database in the capturing flush.

​required

The entity's title/name at the time of the change.

scope
​string · enum · required
Enum values:
workspace
organization
platform
​required
​required

Null for org-level governance rows (roles, memberships, SSO), which every workspace view of the org shows.

​required
​required
actorKind
​string · enum · required

browser = a person; agent = a delegated coding-session token; service = a machine caller; impersonated = a service acting on behalf of a user; support = a Productmind Architect through a support grant (actorTokenId is the grant id).

Enum values:
browser
agent
service
impersonated
legacy
support
local_agent
mcp_client
​required
​required
​required
onBehalfOf
​boolean · required
​required

The automation run whose agent made the change, when one did.

source
​string · enum · required
Enum values:
http
admin
reaper
ws
compaction
tier-move
migration-lambda
cli
​required
​required
​required

The matched route PATTERN (/workspaces/:workspaceId/tasks/:id), never the concrete path.

changedFields
​string[] · required

The field names present in changes, after redaction.

​object · required

Per-field before/after, keyed by field name — inline, so the detail view needs no second read.

changesTruncated
​boolean · required

True when the record was too large and changes was dropped to {}.

​required

{ entityType: count } of dependants removed by a destructive operation.

​required
producer
​string · required

api@<version>.

​required
actorRedacted
​boolean · required

True when this organization's view withheld the actor's email and avatar because they are not one of its own people - a Productmind Architect. The page badges exactly these actors.

​AuditEventListItemDTO[] · required

The other phases of the same operation (attempted ↔ completed / failed), and the sibling subjects of a bulk operation.

AuditExportStatusDTO

executionId
​string · required
format
​string · enum · required
Enum values:
csv
json
status
​string · enum · required
Enum values:
running
succeeded
failed
downloadUrl
​string

Where to fetch the file: a presigned URL valid ~1 h (re-signed on every poll) — or, on the local store, the API's own download route.

downloadUrls
​string[]

Every part of a multi-part JSON export; downloadUrl is the first.

expiresAt
​string
bytesScanned
​integer · min: -9007199254740991 · max: 9007199254740991
error
​string

AuditSettingsDTO

​required

Days kept; null = indefinite.

isDefault
​boolean · required

True when the workspace never saved a value — the registry default applies and follows future default changes; a saved value is returned verbatim forever.

PlanPricingFactsDTO

​required
​object[] · required

PublicBlogPostListDTO

revision
​string · required

The revision of exactly these posts: what the blog's revision.json publishes once built from them.

​PublicBlogPostSummaryDTO[] · required

Every post on the blog, newest first publish first.

linksExpireAt
​string · required

When the short-lived links in this answer stop working.

PublicBlogPostSummaryDTO

slug
​string · required
title
​string · required
summary
​string · required
​required
publishedAt
​string · required

When the post was first put on the blog.

updatedAt
​string · required

When the version the blog serves last changed.

​required

PublicBlogHeroDTO

kind
​string · enum · required
Enum values:
image
loop
clip
url
​string · required

Where to fetch it: its address on the assets host when published there, else a short-lived link.

contentType
​string · required
​required
​required
​required
​required

PublicBlogPostDTO

slug
​string · required
title
​string · required
summary
​string · required
​required
publishedAt
​string · required

When the post was first put on the blog.

updatedAt
​string · required

When the version the blog serves last changed.

​required
content
​string · required

The post's markdown, as approved, with each of its images given a short-lived link.

linksExpireAt
​string · required

When the short-lived links in this answer stop working.

PublicBlogRevisionDTO

revision
​string · required

A hash of the posts on the blog: each one's slug and the version it serves.

posts
​integer · min: -9007199254740991 · max: 9007199254740991 · required

How many posts are on the blog.

EmailPreferencesDTO

organizationName
​string · required
optedOut
​boolean · required

__schema0

id
​string · required
displayId
​number · required
workspaceId
​string · required
title
​string · required
status
​string · enum · required
Enum values:
todo
in_planning
in_progress
in_testing
in_review
done
type
​string · enum · required
Enum values:
task
subtask
priority
​string · enum · required
Enum values:
low
high
critical
​object · required
sortOrder
​number · required
childCount
​number · required
description
​string
assigneeId
​string
​object
​AssigneeRefDTO[]
parentId
​string
​TaskParentDTO
startAt
​string
dueAt
​string
externalSource
​string
externalId
​string
externalSourceUrl
​string
tags
​string[]
suggestedTagCount
​integer · min: -9007199254740991 · max: 9007199254740991
​CreatedFromNoteDTO
​CreatedFromBugReportDTO
createdAt
​string
updatedAt
​string
​__schema0[]

AgentDefinitionModelOutput

tier
​string · enum

Model capability class — quick, standard, top or ultra. Ignored when id is set.

Enum values:
quick
standard
top
ultra
id
​string · minLength: 1 · maxLength: 200

Explicit model id for the active LLM provider; a Bedrock-style id is normalized on the Anthropic API. Beats tier.

temperature
​number · min: 0 · max: 1
maxTokens
​integer · max: 200000
thinkingEnabled
​boolean
thinkingEffort
​string · enum
Enum values:
low
medium
high
max
xhigh
promptCaching
​boolean

AgentDefinitionMcpServerOutput

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · kind="productmind" · requires: id
type = object · kind="integration" · requires: id, instanceId
type = object · kind="http" · requires: id, transport, url
Properties for Variant 1:
id
​string · minLength: 1 · maxLength: 64 · required

Identifier for this server within the definition. Never used as a shared cache key.

kind
​string · const · required
Const value: productmind
allowedTools
​string[] · maxItems: 200

Tool-name globs to load from this server. Required for the asynchronous path — an absent list means 'everything this server exposes', which cannot be validated at publish time.

rejectedTools
​string[] · maxItems: 200

Tool-name globs to exclude, applied after allowedTools and on top of the global rejections.

ProductmindMcpServerOutput

id
​string · minLength: 1 · maxLength: 64 · required

Identifier for this server within the definition. Never used as a shared cache key.

kind
​string · const · required
Const value: productmind
allowedTools
​string[] · maxItems: 200

Tool-name globs to load from this server. Required for the asynchronous path — an absent list means 'everything this server exposes', which cannot be validated at publish time.

rejectedTools
​string[] · maxItems: 200

Tool-name globs to exclude, applied after allowedTools and on top of the global rejections.

IntegrationMcpServerOutput

id
​string · minLength: 1 · maxLength: 64 · required

Identifier for this server within the definition. Never used as a shared cache key.

kind
​string · const · required
Const value: integration
instanceId
​string · minLength: 1 · maxLength: 128 · required

Workforce instance id of an MCP integration already attached to this workspace.

allowedTools
​string[] · maxItems: 200

Tool-name globs to load from this server. Required for the asynchronous path — an absent list means 'everything this server exposes', which cannot be validated at publish time.

rejectedTools
​string[] · maxItems: 200

Tool-name globs to exclude, applied after allowedTools and on top of the global rejections.

HttpMcpServerOutput

id
​string · minLength: 1 · maxLength: 64 · required

Identifier for this server within the definition. Never used as a shared cache key.

kind
​string · const · required
Const value: http
transport
​string · const · required
Const value: http
Default: http
url
​string · uri · required

The MCP server endpoint. Our infrastructure connects outbound to it, unauthenticated.

allowedTools
​string[] · maxItems: 200

Tool-name globs to load from this server. Required for the asynchronous path — an absent list means 'everything this server exposes', which cannot be validated at publish time.

rejectedTools
​string[] · maxItems: 200

Tool-name globs to exclude, applied after allowedTools and on top of the global rejections.

AgentDefinitionSettingsOutput

maxTurns
​integer · max: 50

Cap on agent-loop turns. The bound on how long a tool-using run can iterate.

maxTotalTokens
​integer · max: 2000000

Cap on tokens processed per run, including cache reads and writes; not cost-weighted.

AgentDefinitionKbFiltersOutput

includeTags
​string[] · maxItems: 50
excludeTags
​string[] · maxItems: 50

AutomationTriggerOutput

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: type, eventType
type = object · requires: type, frequency, timezone
type = object · requires: type
Properties for Variant 1:
type
​string · const · required
Const value: event
eventType
​string · enum · required

A workspace event this automation reacts to, e.g. bug_report.created.

Enum values:
feature.created
feature.updated
feature.status_changed
feature_request.created
feature_request.updated
feature_request.status_changed
feature_request.promoted
bug_report.created

AutomationConditionsOutput

combinator
​string · enum · required
Enum values:
and
or
​AutomationConditionNodeOutput[] · maxItems: 10 · required

AutomationConditionNodeOutput

anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: field, operator
type = object · requires: combinator, children
Properties for Variant 1:
field
​string · minLength: 1 · maxLength: 100 · required

A field declared for this trigger's event by automationConditionFields.

operator
​string · enum · required
Enum values:
equals
notEquals
contains
in
isEmpty
isNotEmpty
changed
changedTo
​

AutomationConditionOutput

field
​string · minLength: 1 · maxLength: 100 · required

A field declared for this trigger's event by automationConditionFields.

operator
​string · enum · required
Enum values:
equals
notEquals
contains
in
isEmpty
isNotEmpty
changed
changedTo
​

AutomationConditionGroupOutput

combinator
​string · enum · required
Enum values:
and
or
​AutomationConditionNodeOutput[] · minItems: 1 · maxItems: 10 · required

AutomationActionOutput

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: type, agentSlug, input
Properties for Variant 1:
type
​string · const · required
Const value: runAgent
agentSlug
​string · minLength: 2 · maxLength: 64 · pattern: ^[a-z0-9]+(-[a-z0-9]… · required

The agent definition to run. Must resolve, be enabled and be async-eligible.

input
​string · maxLength: 5000 · required

The per-run instruction, as a template over {{entity.id}}, {{entity.key}}, {{entity.title}}, {{entity.status}}, {{event}}, {{actor.name}} and {{changes.<field>.to}} / .from. Unknown placeholders render empty and are recorded as warnings on the run.

AutomationLimitsOutput

maxRunsPerHour
​integer · min: -9007199254740991 · max: 9007199254740991

Runs per hour for this automation, clamped to [1, 200]. Defaults to 50. Counted with an indexed query, and it FAILS CLOSED.

RunTelemetryOutput

​TelemetryStepOutput[] · maxItems: 100 · required
Default: []
modelCallCount
​integer · min: 0 · max: 9007199254740991 · required
Default: 0
toolCallCount
​integer · min: 0 · max: 9007199254740991 · required
Default: 0
toolErrorCount
​integer · min: 0 · max: 9007199254740991 · required
Default: 0
​
​
stepsTruncated
​boolean
stepsDropped
​integer · min: 0 · max: 9007199254740991
​
​

TelemetryStepOutput

kind
​string · enum · required
Enum values:
model_call
tool_call
name
​string · maxLength: 200 · required
startedAtMs
​integer · min: 0 · max: 9007199254740991 · required
status
​string · enum · required
Enum values:
ok
error
retried
incomplete
Default: ok
​
​
previewOmitted
​boolean
​
​
​
​
​
​
​
reasoningTruncated
​boolean
​
​
​
inputTruncated
​boolean
​
outputTruncated
​boolean
​

CommentAnchorOutput

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: type, startNodeKey, startOffset +3 more
type = object · requires: type, pullRequestUrl, pullRequestNumber +4 more
type = object · requires: type, port, pagePath +4 more
Properties for Variant 1:
type
​string · const · required
Const value: range
startNodeKey
​string · required
startOffset
​integer · min: 0 · max: 9007199254740991 · required
endNodeKey
​string · required
endOffset
​integer · min: 0 · max: 9007199254740991 · required
snippet
​string · required
prefix
​string
suffix
​string
textStart
​integer · min: 0 · max: 9007199254740991
textEnd
​integer · min: 0 · max: 9007199254740991

FeatureBusinessRuleCitationDTOOutput

label
​string · required
repoName
​string · required
sha
​string · required
path
​string · required
​required
​required

BugReportProposedRelationshipOutput

targetType
​string · enum · required
Enum values:
feature
application
targetId
​string · minLength: 1 · required
confidence
​string · enum · required
Enum values:
high
medium
low
​
​
​
​

SessionInteractionOptionOutput

value
​string · minLength: 1 · maxLength: 120 · required
label
​string · minLength: 1 · maxLength: 200 · required
description
​string · maxLength: 2000
recommended
​boolean

Set true on the option you recommend (put it first). The app labels it Recommended and picks it in advance, so the user can accept it with one click. Omit it when you have no recommendation; on a single-choice question flag at most one.

PreviewPortOutput

port
​integer · min: 1 · max: 65535 · required
name
​string · minLength: 1 · maxLength: 64 · required
protocol
​string · enum · required
Enum values:
http
https
tcp
Default: http
isMain
​boolean

InternalMeetingActionPointOutput

description
​string · required
done
​boolean · required
Default: false
assigneeUserId
​string
assigneeEmail
​string

BlogPostGuidanceOutput

tone
​string · enum · required
Enum values:
friendly
professional
enthusiastic
Default: friendly
length
​string · enum · required
Enum values:
short
standard
long
Default: standard
angle
​string · maxLength: 500 · required

A free-text angle for the post, e.g. who it is for or what to lead with.

Default:

SidecarEnvOutput

key
​string · minLength: 1 · maxLength: 256 · pattern: ^[A-Za-z_][A-Za-z0-9… · required
command
​string · minLength: 1 · maxLength: 4096 · required

ApplicationRiskRuleOutput

id
​string · minLength: 1 · maxLength: 64 · required

Unique within the profile

name
​string · minLength: 1 · maxLength: 60 · required

Shown as the reason a file is flagged

tier
​string · enum · required

high and medium flag a file; a file matching any low rule is never flagged

Enum values:
high
medium
low
pathPatterns
​string[] · maxItems: 50 · required

Globs over the repository-relative path (*, **, ?, {a,b}), case-insensitive. A pattern with no / matches the file name in any folder

nameWords
​string[] · maxItems: 100 · required

Whole words of a folder or file name, case-insensitive. Names split on punctuation and camelCase, and two adjacent pieces also match joined

lineTexts
​string[] · maxItems: 50 · required

Text an added or removed line contains as whole words, case-insensitive, with any run of spaces between words

​required

Matches when additions plus deletions reach this; null for no threshold

ApplicationRepoOutput

workforceConnectorId
​string · minLength: 1 · maxLength: 1024 · required
externalRepoId
​string · minLength: 1 · maxLength: 1024 · required
repoName
​string · minLength: 1 · maxLength: 1024 · required
repoUrl
​string · minLength: 1 · maxLength: 1024 · required
provider
​string · minLength: 1 · maxLength: 1024 · required
baseBranch
​string · minLength: 1 · maxLength: 256 · required
​
​

ApplicationServiceOutput

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

The service's name, e.g. web or api

type
​string · enum · required

What kind of unit the service is

Enum values:
webservice
monorepo
cli
worker
mobile
library
desktop
infrastructure
port
​integer · min: 1 · max: 65535

The port it serves on in a live preview; leave it out for a service with nothing to preview

protocol
​string · enum

How the port is reached: http (the default) or https

Enum values:
http
https
tcp
Default: http
isMain
​boolean

Whether this port is the one a live preview opens first

​

The service's OpenAPI or Swagger file, a path in the repository such as services/api/openapi.json. Leave it out to keep the stored one; null clears it, so the file is found automatically again

MonorepoServiceOutput

name
​string · minLength: 1 · maxLength: 200 · required
type
​string · enum · required
Enum values:
webservice
monorepo
cli
worker
mobile
library
desktop
infrastructure