Bug reports
Bug reports track defects in your product. Create, triage and delete reports, record who reported each one, merge duplicates, and link a report to the applications, features and tasks it affects. Have AI describe a report from its screenshots, see the customer conversations that surfaced it, and convert it into a task, feature or feature request. See Bug reports.
List bug reports in a workspace
Returns bug reports — internal bug-tracking rows with priority, severity, status, reporter, and tags. Filterable by status, priority, severity, application, feature, reporter, and tags. Soft-deleted reports are excluded.
path Parameters
workspaceIdWorkspace UUID
query Parameters
pagePage number (1-indexed, default 1)
limitItems per page (default 50)
sortByField to sort by
sortOrderSort direction (default desc)
searchFull-text search across searchable fields
priorityFilter by priority (single value or array)
severityFilter by severity (single value or array)
statusFilter by status (single value or array)
reporterIdFilter to reports having a reporter (user or contact) with this id
assigneeIdFilter by assignee: a user or team UUID, or a comma-separated list of them (reports assigned to ANY listed user/team match). my-teams stands for every team the caller belongs to, and for-me for the reports FOR the caller: assigned to them or to a team they are on, or linked to a feature in a team's area or a task in a team's view. for-me is the sidebar's Bug reports count.
teamIdFilter to a TEAM's area: a team UUID, or a comma-separated list of them (items in the area of ANY listed team match). my-teams stands for every team the caller belongs to. An item is in a team's area when it is assigned to the team, or sits under a feature assigned to it, at any depth: a feature's sub-features, their tasks and sub-tasks, the bug reports linked to those features and tasks, and the coding sessions working on them. Unlike assigneeId, which matches only items assigned directly. A user id matches nothing, and so does my-teams for a caller on no team.
applicationFilter by linked application id
featureFilter by linked feature id
tagsFilter by tag names (single value or comma-separated array)
includeSessionsOpt in to each report's sessions: the coding sessions it is in (id, displayId, name, category, status), scans and code chats left out. Returned only to a caller who may read coding sessions. Defaults to false. sortBy=codingSession orders the reports by their current session: the newest one working on the report, else the newest still in planning, else the newest finished one; reports in no session come last.
activityAfter^(?:(?:\d\d[2468][04…Only the items with activity after this ISO 8601 instant (for example 2026-10-26T09:00:00Z): for a session its last activity, or its last update when it has none; for every other list its last update (updatedAt). Send it with limit=1 and read pagination.total to count what changed since then. The response names the instant it applied in filters.activityAfter. A value that is not an ISO 8601 instant is refused with 400.
List bug reports in a workspace › Responses
List of bug reports
Create a bug report
File a new bug report. Seeds a first reporter: the authenticated user by default, or a contact via reporterType + reporterId; add more later via the reporters sub-resource. Optionally set an assignee (the person leading the resolution). Reports start in 'open' status. Pass featureId (the Feature the bug affects) and/or applicationId (where it was observed) to link the report in the same call; a feature link hands a report created with no assignee to that feature's owners. For a Task link, or more targets, call create-bug-report-relationship afterwards. When you are creating this from a conversation, pass that conversation's id as originChatId: the newest images the user attached there are copied onto the report.
path Parameters
workspaceIdWorkspace UUID
Create a bug report › Request Body
titledescriptionMarkdown, at most 200,000 characters.
priorityseverityreporterTypereporterIdreporterDetailsassigneeIdAssign ONE user by UUID (the legacy single-assignee field). Use assignees to assign several people or a team.
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.
sortOrderoriginChatId^([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^([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^([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.
Create a bug report › Responses
Created bug report
Bulk soft-delete bug reports
Soft-delete multiple bug reports by id. Deleted reports are excluded from lists but retained for potential reopening.
path Parameters
workspaceIdWorkspace UUID
Bulk soft-delete bug reports › Responses
Bug reports deleted
Merge bug reports
Fold one or more duplicate bug reports into a surviving target report. Reporters, comments, and attachments move onto the target; each source is set to 'merged'. The target's own description is left unchanged.
path Parameters
workspaceIdWorkspace UUID
Merge bug reports › Request Body
sourceIdstargetIdMerge bug reports › Responses
The surviving (target) bug report
List reports merged into a bug report
Returns the source bug reports that were merged into this one.
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
List reports merged into a bug report › Responses
Merged source reports
List a bug report's reporters
Returns everyone who reported this bug, each with their own details.
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
List a bug report's reporters › Responses
List of reporters
Add a reporter to a bug report
Attribute an additional reporter (a workspace member or a contact) to a bug report, with optional details of what they observed.
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
Add a reporter to a bug report › Request Body
reporterTypereporterIddetailsAdd a reporter to a bug report › Responses
Created reporter
Update a reporter's details
Edit the free-text details of one reporter on a bug report.
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
reporterIdReporter UUID
Update a reporter's details › Responses
Updated reporter
List the sources that surfaced a bug report
Returns the interests on a bug report — one per source that raised it, each carrying the source's name, a link back to it, and the reporter's own words. Distinct from reporters: a reporter is a person who hit the bug, an interest is a conversation that surfaced it, so one person across two interviews is one reporter and two interests.
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
List the sources that surfaced a bug report › Responses
List of interests
List the bug reports a customer interaction surfaced
Returns the bug reports linked to one customer interaction, whether newly created from it or matched to an existing report. Excludes soft-deleted reports.
path Parameters
workspaceIdWorkspace UUID
interactionIdCustomer interaction UUID
List the bug reports a customer interaction surfaced › Responses
Bug reports surfaced by the interaction
Convert a bug report to a task, feature, or feature request
Graduate a triaged bug report into the backlog. Pass targetType: 'task' for tracked engineering work, 'feature' for a roadmap item the defect revealed as a gap, 'feature_request' for a customer demand signal. Title, description and priority carry forward (each overridable in the body). A Task additionally folds the report's SEVERITY into its priority - the task takes the stronger of the report's own priority and the one its severity implies (minor->low, major->high, critical/blocker->critical), so a blocker never lands at the bottom of the board - and goes under the Feature the report is linked to, or, when the report is linked to no Feature and to exactly one Application, under that Application; a Feature Request additionally gets one interest per reporter, preserving customer lineage. Feature and Feature Request keep the report's priority unchanged. Every target gets a copy of the report's attachments, such as screenshots, and the report keeps its own; a failed copy does not fail the conversion. On success the report is set to 'closed', gains a system comment naming the new entity, and links to it in both directions. Only reports in 'open', 'in_review' or 'confirmed' can be converted. Idempotent - a second call returns the existing entity with created=false, and copies the report's attachments only if that entity has none.
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
Convert a bug report to a task, feature, or feature request › Request Body
targetTypeWhat 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.
titleOverride the new entity's title. Defaults to the bug report's title.
descriptionOverride 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.
priorityOverride the new entity's priority. Defaults to the bug report's priority.
Convert a bug report to a task, feature, or feature request › Responses
The created (or existing) entity and the updated bug report
List a bug report's relationships
Returns the Applications, Features and Tasks linked to a bug report (related_to links only; the entity it was converted into and the report it was merged into are on get-bug-report). Each row's id is what delete-bug-report-relationship takes.
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
List a bug report's relationships › Responses
List of relationships
Link a bug report to an application, feature, or task
Create a relationship between a bug report and an Application (where it was observed), a Feature (the affected area), or a Task. One target per call. Side effect on a FEATURE link: if the report has no assignees at all, it inherits the feature's assignees (users and teams), falling back to the nearest owning ancestor feature. A report that already has any assignee is never changed, nothing re-syncs if the feature's owner changes later, and unlinking does not unassign. Application and Task links never assign. Linking a target that is already linked returns the existing link unchanged, with no re-assignment. When you are filing the report now, create-bug-report takes featureId / applicationId directly.
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
Link a bug report to an application, feature, or task › Request Body
targetTypeWhat 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.
targetIdUUID of that feature, application or task in this workspace. Resolve a FEAT-n / COMP-n / APP-n / TASK-n handle with search-entities first.
relationshipTypeIgnored: every link made here is stored as related_to. Omit it.
Link a bug report to an application, feature, or task › Responses
Created relationship
Remove a bug report relationship
Delete a link between a bug report and an application, feature, or task. relationshipId is the id of a row from list-bug-report-relationships (or from get-bug-report's relationships). Unlinking never unassigns the report.
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
relationshipIdThe id of a row from list-bug-report-relationships (or from get-bug-report's relationships), not the linked feature's, application's or task's own id.
Remove a bug report relationship › Responses
Relationship removed
Get a bug report by ID
Retrieve a single bug report with full details including reporter, tags, relationships, and the entity it was converted into (if any).
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
Get a bug report by ID › Responses
Bug report details
Update a bug report
Modify a bug report's title, description, priority, severity, status, assignee, or tags (reporters are managed via the reporters sub-resource). Links to features, applications and tasks are not fields here: manage them with list-bug-report-relationships, create-bug-report-relationship and delete-bug-report-relationship. Status changes are validated against the lifecycle transition map (invalid transitions return 400).
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
Update a bug report › Request Body
titledescriptionMarkdown, 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.
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.
priorityseveritystatusSet 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.
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.
tagssortOrderUpdate a bug report › Responses
Updated bug report
Describe a bug report from its screenshots
Trigger the vision agent to read the bug report's attached screenshots and draft an updated description, incorporating the existing description and every reporter's details. Idempotent while a run is in flight. On a blank description the draft is applied automatically; otherwise it is held for review.
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
Describe a bug report from its screenshots › Request Body
sourceHow the run was triggered (auto on image upload / manual button)
Describe a bug report from its screenshots › Responses
The queued (or in-flight) description proposal
List a bug report's description proposals
Returns AI-drafted description proposals for a bug report. Pass activeOnly=true for the single in-flight / awaiting-review proposal.
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
query Parameters
activeOnlyList a bug report's description proposals › Responses
Description proposals
Apply a bug report description proposal
Write the reviewer-composed markdown (accepted diff blocks) to the bug report's description and settle the proposal.
path Parameters
workspaceIdWorkspace UUID
idBug report UUID
proposalIdProposal UUID
Apply a bug report description proposal › Request Body
descriptionApply a bug report description proposal › Responses
The applied proposal