Tags
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
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.
path Parameters
workspaceIdWorkspace UUID
query Parameters
entityParent entity type
entityIdParent entity UUID
uniqueReturn distinct tag names for the entity type (entityId not required)
includeSuggestedAlso return status: suggested rows (machine-proposed, not yet accepted). Default false — agents see only what the entity carries.
includeRejectedAlso return status: rejected rows — the editor's Rejected group, where a rejection can be undone. Default false.
List tags on an entity › Responses
List of tags — Tag rows normally, { name, count } vocabulary entries when unique=true
Add a tag to an entity
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.
path Parameters
workspaceIdWorkspace UUID
Add a tag to an entity › Request Body
entityentityIdnameThe 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
Ask the tagger to propose tags for entities
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.
path Parameters
workspaceIdWorkspace UUID
Ask the tagger to propose tags for entities › Request Body
entityentityIdsAsk the tagger to propose tags for entities › Responses
Runs queued
Accept pending tag suggestions on entities
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.
path Parameters
workspaceIdWorkspace UUID
Accept pending tag suggestions on entities › Request Body
entityentityIdsincludeNewNamesAccept pending tag suggestions on entities › Responses
How many suggestions were accepted
Proposed tag names not yet in the vocabulary
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.
path Parameters
workspaceIdWorkspace UUID
query Parameters
entityEntity type the listing applies to
Proposed tag names not yet in the vocabulary › Responses
Proposed new names
Accept a proposed name everywhere it is pending
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).
path Parameters
workspaceIdWorkspace UUID
Accept a proposed name everywhere it is pending › Request Body
entitynameThe 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
How many rows were accepted
Reject a proposed name everywhere it is pending
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.
path Parameters
workspaceIdWorkspace UUID
Reject a proposed name everywhere it is pending › Request Body
entitynameThe 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
How many rows were rejected
Accept one tag suggestion
The suggested row becomes a tag the entity carries (status: active, provenance kept).
path Parameters
workspaceIdWorkspace UUID
tagIdTag UUID
Accept one tag suggestion › Responses
Accepted tag
Reject one tag suggestion
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.
path Parameters
workspaceIdWorkspace UUID
tagIdTag UUID
Reject one tag suggestion › Responses
Rejected tag
Delete a tag
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.
path Parameters
workspaceIdWorkspace UUID
tagIdThe tag row's UUID: its id from list-tags.
Delete a tag › Responses
Tag deleted