Productmind API

Customer interactions

A customer interaction is one conversation with a customer: a customer meeting, a support case, an agentic interview or a feedback widget conversation. List, create, update and delete interactions, change their status, read and add messages, and summarize one, which also files what the customer asked for as feature requests and the problems they hit as bug reports. You can also have Productmind read an interaction's screenshots into a draft analysis, then append it to the notes or dismiss it. See Customer meetings.


List customer interactions in a workspace

GET
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions

Returns customer interactions (interviews, feedback streams, meeting notes). Supports filtering by status, type, and account. Returns: id, type, status, contact, summary, createdAt.

List customer interactions in a workspace › path Parameters

workspaceId
​string · required

Workspace UUID

List customer interactions in a workspace › query Parameters

page
​number

Page number (1-indexed, default 1)

limit
​number

Items per page (default 50)

sortBy
​string · enum

Field to sort by

Enum values:
createdAt
updatedAt
status
type
account
source
date
title
sortOrder
​string · enum

Sort direction (default desc)

Enum values:
asc
desc
search
​string

Full-text search across searchable fields

status
​string

Comma-separated interaction statuses to filter by (draft, scheduled, invited, in_progress, processing, completed, cancelled, invalid, failed)

types
​string

Comma-separated interaction types to filter by

standaloneOnly
​boolean

Only return standalone interactions

accountIds
​string

Comma-separated account UUIDs to filter by

contactIds
​string

Comma-separated contact UUIDs to filter by

tags
​string

Comma-separated tag names to filter by

sources
​string

Comma-separated interaction sources to filter by. Use productmind for interactions created in Productmind rather than imported.

activityAfter
​string · date-time · pattern: ^(?:(?:\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 customer interactions in a workspace › Responses

200

List of customer interactions

​CustomerInteractionDTO[] · required
​object
​object

Create a customer interaction

POST
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions

Create a new customer interaction (customer meeting, support case, etc.).

Create a customer interaction › path Parameters

workspaceId
​string · required

Workspace UUID

Create a customer interaction › Request Body

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.

Create a customer interaction › Responses

Created interaction

​CustomerInteractionDTO · required

List accounts that have customer interactions

GET
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/accounts

Returns distinct accounts that have at least one customer interaction.

List accounts that have customer interactions › path Parameters

workspaceId
​string · required

Workspace UUID

List accounts that have customer interactions › query Parameters

standaloneOnly
​boolean

Only standalone interactions

List accounts that have customer interactions › Responses

200

List of accounts

​object[] · required

Get a customer interaction by ID

GET
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{id}

Retrieve a single customer interaction with full details.

Get a customer interaction by ID › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Interaction UUID

Get a customer interaction by ID › Responses

200

Interaction details

​CustomerInteractionDTO · required

Update a customer interaction

PUT
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{id}

Modify an existing customer interaction's details.

Update a customer interaction › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Interaction UUID

Update a customer interaction › Request Body

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

Update a customer interaction › Responses

200

Updated interaction

​CustomerInteractionDTO · required

Delete a customer interaction

DELETE
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{id}

Permanently remove a customer interaction.

Delete a customer interaction › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Interaction UUID

Delete a customer interaction › Responses

200

Interaction deleted

No data returned

Update a customer interaction's status

PUT
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{id}/status

Change the status of a customer interaction (e.g., draft → in_progress → completed).

Update a customer interaction's status › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Interaction UUID

Update a customer interaction's status › Request Body

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.

Update a customer interaction's status › Responses

200

Updated interaction

​CustomerInteractionDTO · required

Update a customer interaction's progress

PATCH
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{id}/progress

Update the progress metadata of a customer interaction.

Update a customer interaction's progress › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Interaction UUID

Update a customer interaction's progress › Request Body

​object
​object[]

Update a customer interaction's progress › Responses

200

Updated interaction

​CustomerInteractionDTO · required

Summarize a customer interaction

POST
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{id}/summarize

Queue AI summarization of a customer interaction's content. Returns as soon as the job is published; the result arrives over the customer_interaction:status_updated socket frame and an interaction.summarized notification. Refused with 409 while a run is already in flight — a second run would duplicate the interests the first one imports.

Summarize a customer interaction › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Interaction UUID

Summarize a customer interaction › Responses

Summarization queued

No data returned

Cancel a customer interaction recording

POST
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{id}/cancel-recording

Cancel an ongoing recording session for a customer interaction.

Cancel a customer interaction recording › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Interaction UUID

Cancel a customer interaction recording › Responses

200

Recording cancelled

No data returned

Read a conversation's screenshots into its notes

POST
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{id}/describe-from-images

Trigger the vision agent to read the screenshots attached to a customer conversation and draft an analysis section for its meeting notes. Idempotent while a run is in flight. The draft is ALWAYS held for review — unlike the feature-request, task and bug-report equivalents there is no auto-apply, because the section is appended to notes somebody wrote. Rejected for a conversation whose content is a message thread rather than notes: its summary is built from the thread, so an appended section would never reach it.

Read a conversation's screenshots into its notes › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Interaction UUID

Read a conversation's screenshots into its notes › Request Body

source
​string · enum

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

Enum values:
auto
manual

Read a conversation's screenshots into its notes › Responses

The queued (or in-flight) description proposal


List a conversation's screenshot-analysis proposals

GET
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{id}/description-proposal

Returns AI-drafted screenshot-analysis proposals for a customer conversation. Pass activeOnly=true for the single in-flight / awaiting-review proposal.

List a conversation's screenshot-analysis proposals › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Interaction UUID

List a conversation's screenshot-analysis proposals › query Parameters

activeOnly
​boolean

List a conversation's screenshot-analysis proposals › Responses

200

Screenshot-analysis proposals


Append a reviewed screenshot analysis to the notes

POST
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{id}/description-proposal/{proposalId}/apply

Append the reviewed analysis BLOCK to the conversation's notes under a stable heading, replacing any block a previous run left, and settle the proposal. The body carries the block, not the whole notes — this is the one place this endpoint differs from its feature-request, task and bug-report equivalents.

Append a reviewed screenshot analysis to the notes › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Interaction UUID

proposalId
​string · required

Proposal UUID

Append a reviewed screenshot analysis to the notes › Request Body

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

Append a reviewed screenshot analysis to the notes › Responses

200

The settled proposal


Dismiss a screenshot-analysis proposal

POST
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{id}/description-proposal/{proposalId}/dismiss

Reject the drafted analysis wholesale, leaving the conversation's notes unchanged.

Dismiss a screenshot-analysis proposal › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Interaction UUID

proposalId
​string · required

Proposal UUID

Dismiss a screenshot-analysis proposal › Responses

200

The dismissed proposal


Cancel an in-flight screenshot-analysis run

POST
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{id}/description-proposal/{proposalId}/cancel

Stop a queued or running run, releasing the one-active-proposal slot. A late worker callback then no-ops on the already-settled proposal.

Cancel an in-flight screenshot-analysis run › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Interaction UUID

proposalId
​string · required

Proposal UUID

Cancel an in-flight screenshot-analysis run › Responses

200

The cancelled proposal


List messages for a customer interaction

GET
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{interactionId}/messages

Returns all messages exchanged during a customer interaction.

List messages for a customer interaction › path Parameters

workspaceId
​string · required

Workspace UUID

interactionId
​string · required

Interaction UUID

List messages for a customer interaction › Responses

200

List of messages

​CustomerInteractionMessageDTO[] · required
​object
​object

Add a message to a customer interaction

POST
https://api.productmind.ai
/workspaces/{workspaceId}/customer-interactions/{interactionId}/messages

Post a new message to a customer interaction conversation. A message posted through the API carries its content alone: an interviewer's turn and what it cost are reported by Productmind's interviewer, and refused (400) from any other caller.

Add a message to a customer interaction › path Parameters

workspaceId
​string · required

Workspace UUID

interactionId
​string · required

Interaction UUID

Add a message to a customer interaction › Request Body

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.

Add a message to a customer interaction › Responses

Message created

​CustomerInteractionMessageDTO · required