Productmind API

Productmind support

A Productmind support request asks the Productmind team for help: a question about using Productmind or its API, a bug report, a feature request, or a Productmind Architect's review of a coding session's pull requests. Open a request, follow and reply in its conversation, attach screenshots to it and its replies, cancel it, approve or reject a review's quotes, and choose which features, tasks and bug reports a review shares. Your organization can also see, revoke and turn off the architects' access to its sessions. These operations work only from a signed-in browser session: a request made with an API key or an agent's token is refused. See Support center.


List Productmind support requests

GET
https://api.productmind.ai
/support/requests

The caller organization's support requests, each shaped by the caller's visibility tier (full or billing).

List Productmind support requests › query Parameters

type
​
status
​
workspaceId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
mine
​string · enum
Enum values:
true
false
subjectType
​string · enum
Enum values:
session
support_conversation
subjectId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
search
​string · minLength: 1 · maxLength: 200
sortBy
​string · enum

Field to sort by

Enum values:
createdAt
lastActivityAt
sortOrder
​string · enum
Enum values:
asc
desc
cursor
​string · minLength: 1 · maxLength: 512
limit
​integer · min: 1 · max: 100
Default: 50

List Productmind support requests › Responses

200

A page of support requests

​SupportRequestListItemDTO[] · required
​required

Pass back as cursor for the next page; null on the last page.


Open a question, bug report or feature request

POST
https://api.productmind.ai
/support/requests

Opens a support request of a type that is not tied to a workspace: a question, a bug report or a feature request. It may name the assistant conversation it was drafted in, and carry screenshots attached from the Support center in the app. Limited per user and per organization each hour.

Open a question, bug report or feature request › Request Body

type
​string · enum · required
Enum values:
question
bug_report
feature_request
title
​string · minLength: 1 · maxLength: 200 · required
subjectType
​string · enum
Enum values:
session
support_conversation
subjectId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
summary
​string · maxLength: 4000
​object
Default: {}

Open a question, bug report or feature request › Responses

The created request

​SupportRequestDTO · required

Count support requests with unread Productmind replies

GET
https://api.productmind.ai
/support/requests/unread-count

count: requests with a Productmind reply the caller has not read. awaitingCount: requests waiting on the customer that this caller can act on — a quote approval needs billing:manage, an information request needs full visibility.

Count support requests with unread Productmind replies › Responses

200

Unread count

​SupportRequestUnreadCountDTO · required

Get a Productmind support request

GET
https://api.productmind.ai
/support/requests/{id}

Get a Productmind support request › path Parameters

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

Get a Productmind support request › Responses

200

The request, shaped by the caller's tier

​SupportRequestDTO · required

List the customer-visible thread of a support request

GET
https://api.productmind.ai
/support/requests/{id}/messages

List the customer-visible thread of a support request › path Parameters

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

List the customer-visible thread of a support request › query Parameters

cursor
​string · minLength: 1 · maxLength: 512
limit
​integer · min: 1 · max: 100
Default: 50

List the customer-visible thread of a support request › Responses

200

A page of messages

​SupportRequestMessageDTO[] · required
​required

Pass back as cursor for the next page; null on the last page.


Post a message on a support request

POST
https://api.productmind.ai
/support/requests/{id}/messages

Post a message on a support request › path Parameters

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

Post a message on a support request › Request Body

body
​string · maxLength: 10000
Default:
​SupportScreenshotClaim[] · maxItems: 5

Post a message on a support request › Responses

The message

​SupportRequestMessageDTO · required

Delete one's own message (15 minutes)

DELETE
https://api.productmind.ai
/support/requests/{id}/messages/{messageId}

Delete one's own message (15 minutes) › path Parameters

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

Delete one's own message (15 minutes) › Responses

200

The tombstoned message

​SupportRequestMessageDTO · required

Edit one's own message (15 minutes)

PATCH
https://api.productmind.ai
/support/requests/{id}/messages/{messageId}

Edit one's own message (15 minutes) › path Parameters

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

Edit one's own message (15 minutes) › Request Body

body
​string · minLength: 1 · maxLength: 10000 · required

Edit one's own message (15 minutes) › Responses

200

The message

​SupportRequestMessageDTO · required

Mark a support request read

POST
https://api.productmind.ai
/support/requests/{id}/read

Mark a support request read › path Parameters

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

Mark a support request read › Request Body

Mark a support request read › Responses

200

Read

​object · required

Cancel a support request (before any access grant)

POST
https://api.productmind.ai
/support/requests/{id}/cancel

Cancel a support request (before any access grant) › path Parameters

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

Cancel a support request (before any access grant) › Request Body

note
​string · maxLength: 2000

Cancel a support request (before any access grant) › Responses

200

The cancelled request

​SupportRequestDTO · required

Approve a Productmind quote

POST
https://api.productmind.ai
/support/requests/{id}/quotes/{quoteId}/approve

Approve a Productmind quote › path Parameters

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

Approve a Productmind quote › Request Body

capMinutes
​integer · min: 1 · max: 4320 · required
rateCentsPerHour
​integer · min: 0 · max: 9007199254740991 · required

Approve a Productmind quote › Responses

200

The request

​SupportRequestDTO · required

Reject a Productmind quote

POST
https://api.productmind.ai
/support/requests/{id}/quotes/{quoteId}/reject

Reject a Productmind quote › path Parameters

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

Reject a Productmind quote › Request Body

note
​string · maxLength: 2000

Reject a Productmind quote › Responses

200

The request

​SupportRequestDTO · required

Revoke Productmind's access to this request's subject

POST
https://api.productmind.ai
/support/requests/{id}/access/revoke

Revoke Productmind's access to this request's subject › path Parameters

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

Revoke Productmind's access to this request's subject › Request Body

note
​string · maxLength: 2000
expectedLevel
​string · enum
Enum values:
evaluation
review

Revoke Productmind's access to this request's subject › Responses

200

The request

​SupportRequestDTO · required

Preview what a Productmind support request would share

GET
https://api.productmind.ai
/workspaces/{workspaceId}/support-requests/scope-preview

What a new request on the session would share with the Productmind Architect — the session's tasks and bug reports and the features they belong to — as the caller may see it. Entries of a type the caller cannot read are only counted.

Preview what a Productmind support request would share › path Parameters

workspaceId
​string · required

Workspace UUID

Preview what a Productmind support request would share › query Parameters

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

Preview what a Productmind support request would share › Responses

200

The derived scope

​SupportRequestScopePreviewDTO · required

List what a Productmind support request shares

GET
https://api.productmind.ai
/workspaces/{workspaceId}/support-requests/{id}/shared-entities

The entities the request shares with the Productmind Architect: those its session links to, then those the customer added. Entries of a type the caller cannot read are only counted.

List what a Productmind support request shares › path Parameters

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

List what a Productmind support request shares › Responses

200

Shared entities

​SupportRequestSharedEntitiesDTO · required

Share a feature, task or bug report with a Productmind support request

POST
https://api.productmind.ai
/workspaces/{workspaceId}/support-requests/{id}/shared-entities

The requester or a support-request:update holder, with the entity type's read permission, on an open request consented at scope version 2. Idempotent: 201 when shared now, 200 when it already was.

Share a feature, task or bug report with a Productmind support request › path Parameters

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

Share a feature, task or bug report with a Productmind support request › Request Body

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

Share a feature, task or bug report with a Productmind support request › Responses

Already shared — the shared entities

​SupportRequestSharedEntitiesDTO · required

Stop sharing an entity the customer added

DELETE
https://api.productmind.ai
/workspaces/{workspaceId}/support-requests/{id}/shared-entities/{entityType}/{entityId}

Only entities the customer shared can be removed; one the session links to answers 409 support.shared_entity_derived.

Stop sharing an entity the customer added › path Parameters

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

Stop sharing an entity the customer added › Responses

200

Shared entities

​SupportRequestSharedEntitiesDTO · required

Check whether a Productmind support request can be created

GET
https://api.productmind.ai
/workspaces/{workspaceId}/support-requests/eligibility

Runs the create checks in order and answers the first failing reason code.

Check whether a Productmind support request can be created › path Parameters

workspaceId
​string · required

Workspace UUID

Check whether a Productmind support request can be created › query Parameters

type
​string · enum · required
Enum values:
code_review
question
bug_report
feature_request
subjectType
​string · enum · required
Enum values:
session
support_conversation
subjectId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required

Check whether a Productmind support request can be created › Responses

200

Eligibility

​SupportRequestEligibilityDTO · required

List Productmind support requests about one subject

GET
https://api.productmind.ai
/workspaces/{workspaceId}/support-requests

List Productmind support requests about one subject › path Parameters

workspaceId
​string · required

Workspace UUID

List Productmind support requests about one subject › query Parameters

subjectType
​string · enum · required
Enum values:
session
support_conversation
subjectId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required
open
​string · enum
Enum values:
true
false

List Productmind support requests about one subject › Responses

200

Request chips


Create a Productmind support request

POST
https://api.productmind.ai
/workspaces/{workspaceId}/support-requests

Create a Productmind support request › path Parameters

workspaceId
​string · required

Workspace UUID

Create a Productmind support request › Request Body

type
​string · enum · required
Enum values:
code_review
subjectType
​string · enum · required
Enum values:
session
support_conversation
subjectId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required
title
​string · minLength: 1 · maxLength: 200 · required
summary
​string · maxLength: 4000
​object
Default: {}
consentedRateCentsPerHour
​integer · min: 0 · max: 9007199254740991
​

Create a Productmind support request › Responses

The created request

​SupportRequestDTO · required

List Productmind support access grants

GET
https://api.productmind.ai
/organizations/{organizationId}/support-access-grants

Every support access grant issued in the caller's organization, newest first. Productmind Architects appear by display name only; the request title and session snapshot are withheld for workspaces the caller cannot reach.

List Productmind support access grants › path Parameters

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

List Productmind support access grants › query Parameters

status
​string · enum

active, ended or all (default).

Enum values:
active
ended
all
Default: all
workspaceId
​string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

Only grants on this workspace.

cursor
​string · minLength: 1 · maxLength: 512

The previous page's cursor.

limit
​integer · min: 1 · max: 100
Default: 50

List Productmind support access grants › Responses

200

A page of grants

​SupportAccessGrantOrgDTO[] · required
​required

Pass back as cursor for the next page; null on the last page.


Revoke a Productmind support access grant

POST
https://api.productmind.ai
/organizations/{organizationId}/support-access-grants/{grantId}/revoke

Ends the architect's access at once. Final: the request can never be granted access again.

Revoke a Productmind support access grant › path Parameters

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

Revoke a Productmind support access grant › Request Body

note
​string · maxLength: 2000

Revoke a Productmind support access grant › Responses

200

The grant as it now reads


Get whether Productmind Architects may access sessions

GET
https://api.productmind.ai
/organizations/{organizationId}/productmind-support-access

Get whether Productmind Architects may access sessions › path Parameters

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

Get whether Productmind Architects may access sessions › Responses

200

The organization's support access setting


Allow or refuse Productmind Architect access to sessions

PATCH
https://api.productmind.ai
/organizations/{organizationId}/productmind-support-access

Stores the organization's explicit choice. Turning access off revokes every active grant and cancels the open requests that would grant access, in one transaction.

Allow or refuse Productmind Architect access to sessions › path Parameters

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

Allow or refuse Productmind Architect access to sessions › Request Body

enabled
​boolean · required

Allow or refuse Productmind Architect access to sessions › Responses

200

The setting after the change, with what it revoked