#The AIDisplayMessage is a user-visible message for rendering object

AIDisplayMessage is a user-visible message for rendering

string

sender

string

text

string

timestamp

string (date-time)

GET/v1/ai/conversationRequires auth

#Get AI conversation

Get the display-ready chat history for a specific context.

#Parameters

query parameters

contextType

stringquery

contextId

stringquery

#Response

200

Everything worked as expected.

messages

array<object>

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

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

Typical response

{
  "messages": [
    {
      "id": "string",
      "sender": "string",
      "text": "string",
      "timestamp": "2026-06-27T19:18:42.391Z"
    }
  ]
}

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

POST/v1/ai/messageRequires auth

#Send AI message

Send a message to the AI assistant. The context type determines which specialized agent handles the request.

#Parameters

This endpoint does not accept any parameters.

#Request body

contextId

string

ID of the resource being edited (dashboard ID, workflow ID, link ID)

contextType

string (enum)

AI context types

Allowed values

AI_CONTEXT_TYPE_UNSPECIFIED

AI_CONTEXT_TYPE_ANALYTICS_DASHBOARD

AI_CONTEXT_TYPE_WORKFLOW

AI_CONTEXT_TYPE_LINK

message

string

The user's message

#Response

200

Everything worked as expected.

appliedActions

array<string>

contextUpdated

boolean

True if the agent modified the resource (frontend should refresh)

responseText

string

uiActions

array<object>

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/ai/message" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"contextId":"string","contextType":"AI_CONTEXT_TYPE_UNSPECIFIED","message":"string"}'

Sample payload (application/json)

{
  "contextId": "string",
  "contextType": "AI_CONTEXT_TYPE_UNSPECIFIED",
  "message": "string"
}

Typical response

{
  "appliedActions": [
    "string"
  ],
  "contextUpdated": false,
  "responseText": "string",
  "uiActions": [
    {
      "label": "string",
      "options": [
        {}
      ],
      "type": "string",
      "value": "string"
    }
  ]
}

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

DELETE/v1/ai/conversationRequires auth

#Clear AI conversation

Clear the conversation history for a specific context.

#Parameters

query parameters

contextType

stringquery

contextId

stringquery

#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

objectRequired

Wrapped error response.

Example request (cURL)

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

Typical response

{}

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

AI Assistant

#The AIDisplayMessage is a user-visible message for rendering object

#Get AI conversation

#Parameters

query parameters

#Response

#Error response

#Send AI message

#Parameters

#Request body

Allowed values

#Response

#Error response

#Clear AI conversation

#Parameters

query parameters

#Response

#Error response