Productmind API

Tags label your records, such as features, tasks, bug reports, releases and knowledge base documents, so you can group and filter them. List, add and remove the tags on a record, or list the tag names in use across your workspace. Ask Productmind to suggest tags from a record's content, then accept or reject the suggestions one by one, per record, or by name across the workspace.


List tags on an entity

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

Returns the tags an entity carries. Tag is polymorphic via (entity, entityId) — pass entity (any taggable type, e.g. feature, task, knowledge_base_document) and the parent id to scope the response. Each row carries source (user for tags a person or API caller applied, generated for tags the platform proposed) and status (active — carried; suggested — proposed by the tagger and not yet accepted, returned only with includeSuggested=true; rejected — declined, returned only with includeRejected=true for the editor's undo surface). Pass unique=true with entity alone for the distinct vocabulary in use across the workspace — that mode returns { name, count } entries (count = how many entities carry the tag) instead of tag rows.

List tags on an entity › path Parameters

workspaceId
​string · required

Workspace UUID

List tags on an entity › query Parameters

entity
​string · enum · required

Parent entity type

Enum values:
account
feature_request
bug_report
feature
task
session
release
customer_interaction
entityId
​string

Parent entity UUID

unique
​boolean

Return distinct tag names for the entity type (entityId not required)

includeSuggested
​boolean

Also return status: suggested rows (machine-proposed, not yet accepted). Default false — agents see only what the entity carries.

includeRejected
​boolean

Also return status: rejected rows — the editor's Rejected group, where a rejection can be undone. Default false.

List tags on an entity › Responses

200

List of tags — Tag rows normally, { name, count } vocabulary entries when unique=true

​required

Add a tag to an entity

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

Polymorphic tag creation. Pass entity (any taggable type) and entityId to attach the tag to its parent. Tag names are deduplicated per parent via a (entity, entityId, name) unique constraint; adding a name the tagger had suggested (or a person had rejected) accepts it as a source: user tag. Tags created here are always source: user. On a knowledge_base_document the document's tags field and its indexed chunks follow automatically, and on a note the note's tags field does.

Add a tag to an entity › path Parameters

workspaceId
​string · required

Workspace UUID

Add a tag to an entity › Request Body

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.

Add a tag to an entity › Responses

Tag added

​TagDTO · required

Ask the tagger to propose tags for entities

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

Queues one tag.generate worker run per entity (up to 50). The tagger reads the entity's content and the workspace's tag vocabulary and stages its proposals as status: suggested rows — inert until a person accepts them (/tags/{tagId}/accept, /tags/suggestions/accept). Names the entity already carries or a person rejected earlier are never re-proposed. Returns 202 with the ids actually queued; ids the caller cannot reach are skipped.

Ask the tagger to propose tags for entities › path Parameters

workspaceId
​string · required

Workspace UUID

Ask the tagger to propose tags for entities › Request Body

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

Ask the tagger to propose tags for entities › Responses

Runs queued

​TagGenerateResponseDTO · required

Accept pending tag suggestions on entities

POST
https://api.productmind.ai
/workspaces/{workspaceId}/tags/suggestions/accept

Accepts every suggested row on the given entities. By default only names already in the workspace vocabulary are accepted — bulk accept never mints a name; pass includeNewNames: true (the per-entity "Accept all") to accept proposed new names too. Respects the knowledge-base document ceiling; overflow stays suggested.

Accept pending tag suggestions on entities › path Parameters

workspaceId
​string · required

Workspace UUID

Accept pending tag suggestions on entities › Request Body

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

Accept pending tag suggestions on entities › Responses

200

How many suggestions were accepted

​TagSuggestionsAcceptResponseDTO · required

Proposed tag names not yet in the vocabulary

GET
https://api.productmind.ai
/workspaces/{workspaceId}/tags/suggestions/new-names

Distinct suggested names on an entity type that no entity of that type carries yet, with how many entities the tagger proposed each on. Accepting one anywhere creates the vocabulary entry.

Proposed tag names not yet in the vocabulary › path Parameters

workspaceId
​string · required

Workspace UUID

Proposed tag names not yet in the vocabulary › query Parameters

entity
​string · enum · required

Entity type the listing applies to

Enum values:
account
feature_request
bug_report
feature
task
session
release
customer_interaction

Proposed tag names not yet in the vocabulary › Responses

200

Proposed new names

​TagSuggestionNewNameDTO[] · required

Accept a proposed name everywhere it is pending

POST
https://api.productmind.ai
/workspaces/{workspaceId}/tags/suggestions/accept-name

Flips every suggested row carrying the name to active across the workspace's entities of that type (the knowledge-base ceiling still applies per document).

Accept a proposed name everywhere it is pending › path Parameters

workspaceId
​string · required

Workspace UUID

Accept a proposed name everywhere it is pending › Request Body

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.

Accept a proposed name everywhere it is pending › Responses

200

How many rows were accepted

​TagSuggestionByNameResponseDTO · required

Reject a proposed name everywhere it is pending

POST
https://api.productmind.ai
/workspaces/{workspaceId}/tags/suggestions/reject-name

Rejects every suggested row carrying the name across the workspace's entities of that type. The rejected rows are per-entity memory: the tagger never re-proposes the name on those entities, and each entity's editor can undo or forget the rejection.

Reject a proposed name everywhere it is pending › path Parameters

workspaceId
​string · required

Workspace UUID

Reject a proposed name everywhere it is pending › Request Body

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.

Reject a proposed name everywhere it is pending › Responses

200

How many rows were rejected

​TagSuggestionByNameResponseDTO · required

Accept one tag suggestion

POST
https://api.productmind.ai
/workspaces/{workspaceId}/tags/{tagId}/accept

The suggested row becomes a tag the entity carries (status: active, provenance kept).

Accept one tag suggestion › path Parameters

workspaceId
​string · required

Workspace UUID

tagId
​string · required

Tag UUID

Accept one tag suggestion › Responses

200

Accepted tag

​TagDTO · required

Reject one tag suggestion

POST
https://api.productmind.ai
/workspaces/{workspaceId}/tags/{tagId}/reject

Declines the suggestion and remembers it: a regeneration never proposes the name again on this entity. Rejecting an accepted generated tag removes it from the entity.

Reject one tag suggestion › path Parameters

workspaceId
​string · required

Workspace UUID

tagId
​string · required

Tag UUID

Reject one tag suggestion › Responses

200

Rejected tag

​TagDTO · required

Delete a tag

DELETE
https://api.productmind.ai
/workspaces/{workspaceId}/tags/{tagId}

Remove a single tag row by id: one tag from one entity. Take the row's id from list-tags with the entity's entity and entityId; a tag's name is not its id. A row the platform proposed (source: generated) is rejected rather than deleted, so a regeneration never re-proposes it; deleting an ALREADY-rejected row forgets the rejection, after which the tagger may propose the name again.

Delete a tag › path Parameters

workspaceId
​string · required

Workspace UUID

tagId
​string · required

The tag row's UUID: its id from list-tags.

Delete a tag › Responses

200

Tag deleted

No data returned