#The AssistantDisplayMessageAttachment is a file attached to a message object

AssistantDisplayMessageAttachment is a file attached to a message

mimeType

string

name

string

GET

/v1/assistant/conversation

Requires auth

#Get assistant conversation

Get the display-ready chat history for a specific context. Requires the `assistant:read` scope.

#Parameters

query parameters

contextType

string

query

dashboard id — the dashboard does not exist yet while the user and the assistant are still agreeing on what it should show. Once it exists, editing it happens under ASSISTANT_CONTEXT_TYPE_ANALYTICS_DASHBOARD instead. the WORKSPACE id: this thread is not about any one link, dashboard or design, and every capability the resource-scoped assistants have is available from it. One conversation per workspace, so it survives navigation.

Allowed values

ASSISTANT_CONTEXT_TYPE_LINK_ANALYTICS

Building a link's analytics dashboard. context_id is the LINK id, not a

ASSISTANT_CONTEXT_TYPE_WORKSPACE

The workspace-wide assistant, with no resource selected. The context id is

contextId

string

query

#Response

200

Everything worked as expected.

messages

array<object>

unreadCount

integer (int32)

Assistant messages in this conversation the member has not seen yet.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/assistant/conversation?contextType={contextType}&contextId={contextId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "messages": [
    {
      "attachments": [
        {}
      ],
      "id": "string",
      "readAt": "2026-10-12T12:50:32.530Z",
      "sender": "string",
      "text": "string",
      "timestamp": "2026-10-12T12:50:32.530Z",
      "uiActions": [
        {}
      ]
    }
  ],
  "unreadCount": 0
}

Base URL: https://api.linkbreakers.com

POST

/v1/assistant/conversation/read

Requires auth

#Mark assistant conversation read

Record that the member has seen every assistant reply in this conversation. Call it when the thread is actually on screen, not when history is fetched. Requires the `assistant:write` scope.

#Parameters

header parameters

Idempotency-Key

string

header

Makes retrying this request safe. See components.parameters.IdempotencyKey.

#Request body

contextId

string

contextType

string (enum)

dashboard id — the dashboard does not exist yet while the user and the assistant are still agreeing on what it should show. Once it exists, editing it happens under ASSISTANT_CONTEXT_TYPE_ANALYTICS_DASHBOARD instead. the WORKSPACE id: this thread is not about any one link, dashboard or design, and every capability the resource-scoped assistants have is available from it. One conversation per workspace, so it survives navigation.

Allowed values

ASSISTANT_CONTEXT_TYPE_UNSPECIFIED

ASSISTANT_CONTEXT_TYPE_ANALYTICS_DASHBOARD

ASSISTANT_CONTEXT_TYPE_WORKFLOW

ASSISTANT_CONTEXT_TYPE_LINK

ASSISTANT_CONTEXT_TYPE_QRCODE_DESIGN

ASSISTANT_CONTEXT_TYPE_PAGE_THEME

ASSISTANT_CONTEXT_TYPE_LINK_ANALYTICS

Building a link's analytics dashboard. context_id is the LINK id, not a

ASSISTANT_CONTEXT_TYPE_WORKSPACE

The workspace-wide assistant, with no resource selected. The context id is

#Response

200

Everything worked as expected.

markedCount

integer (int32)

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/assistant/conversation/read" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  --data '{"contextId":"string","contextType":"ASSISTANT_CONTEXT_TYPE_UNSPECIFIED"}'

Sample payload (application/json)

{
  "contextId": "string",
  "contextType": "ASSISTANT_CONTEXT_TYPE_UNSPECIFIED"
}

Typical response

{
  "markedCount": 0
}

Base URL: https://api.linkbreakers.com

POST

/v1/assistant/upload

Requires auth

#Upload file for assistant chat

Upload a file to attach to the next assistant message. Returns a temporary file ID. Files expire after 5 minutes. Max 20MB. Requires the `assistant:write` scope.

#Parameters

header parameters

Idempotency-Key

string

header

Makes retrying this request safe. See components.parameters.IdempotencyKey.

#Request body

content

string

File content (base64-encoded in JSON)

mimeType

string

MIME type (e.g. "image/png", "application/pdf")

name

string

Original filename

#Response

200

Everything worked as expected.

fileId

string

Temporary file ID to include in assistant message attachments

mimeType

string

MIME type (echoed back)

name

string

Original filename (echoed back)

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/assistant/upload" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  --data '{"content":"string","mimeType":"string","name":"string"}'

Sample payload (application/json)

{
  "content": "string",
  "mimeType": "string",
  "name": "string"
}

Typical response

{
  "fileId": "string",
  "mimeType": "string",
  "name": "string"
}

Base URL: https://api.linkbreakers.com

DELETE

/v1/assistant/conversation

Requires auth

#Clear assistant conversation

Clear the conversation history for a specific context. Requires the `assistant:write` scope.

#Parameters

query parameters

contextType

string

query

dashboard id — the dashboard does not exist yet while the user and the assistant are still agreeing on what it should show. Once it exists, editing it happens under ASSISTANT_CONTEXT_TYPE_ANALYTICS_DASHBOARD instead. the WORKSPACE id: this thread is not about any one link, dashboard or design, and every capability the resource-scoped assistants have is available from it. One conversation per workspace, so it survives navigation.

Allowed values

ASSISTANT_CONTEXT_TYPE_LINK_ANALYTICS

Building a link's analytics dashboard. context_id is the LINK id, not a

ASSISTANT_CONTEXT_TYPE_WORKSPACE

The workspace-wide assistant, with no resource selected. The context id is

contextId

string

query

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X DELETE "https://api.linkbreakers.com/v1/assistant/conversation?contextType={contextType}&contextId={contextId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{}

Base URL: https://api.linkbreakers.com