Chat Message

List all chat messages

get

Retrieve all chat messages for a specific chatflow.

Authorizations

Path parameters

idstringrequired

Chatflow ID

Query parameters

chatTypestring · enumoptional

Filter by chat type

Available options:

orderstring · enumoptional

Sort order

Available options:

chatIdstringoptional

Filter by chat ID

memoryTypestringoptional

Filter by memory type

Example: Buffer Memory

sessionIdstringoptional

Filter by session ID

startDatestringoptional

Filter by start date

Example: 2025-01-01T11:28:36.000Z

endDatestringoptional

Filter by end date

Example: 2025-01-13T11:28:36.000Z

feedbackbooleanoptional

Filter by feedback

feedbackTypestring · enumoptional

Filter by feedback type. Only applicable if feedback is true

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/chatmessage/{id}' \
  --header 'Authorization: Bearer JWT'

200

500

200

[
  {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "role": "apiMessage",
    "chatflowid": "d290f1ee-6c54-4b01-90e6-d701748f0852",
    "content": "Hello, how can I help you today?",
    "sourceDocuments": [
      {
        "pageContent": "This is the content of the page.",
        "metadata": {
          "author": "John Doe",
          "date": "2024-08-24"
        }
      }
    ],
    "usedTools": [
      {
        "tool": "Name of the tool",
        "toolInput": {
          "input": "search query"
        },
        "toolOutput": "text"
      }
    ],
    "fileAnnotations": [
      {
        "filePath": "path/to/file",
        "fileName": "file.txt"
      }
    ],
    "agentReasoning": [
      {
        "agentName": "agent",
        "messages": [
          "hello"
        ],
        "nodeName": "seqAgent",
        "nodeId": "seqAgent_0",
        "usedTools": [
          {
            "tool": "Name of the tool",
            "toolInput": {
              "input": "search query"
            },
            "toolOutput": "text"
          }
        ],
        "sourceDocuments": [
          {
            "pageContent": "This is the content of the page.",
            "metadata": {
              "author": "John Doe",
              "date": "2024-08-24"
            }
          }
        ],
        "state": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "fileUploads": [
      {
        "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAABjElEQVRIS+2Vv0oDQRDG",
        "type": "image",
        "name": "image.png",
        "mime": "image/png"
      }
    ],
    "action": [
      {
        "id": "61beeb58-6ebe-4d51-aa0b-41d4c546ff08",
        "mapping": {
          "approve": "Yes",
          "reject": "No",
          "toolCalls": []
        },
        "elements": []
      }
    ],
    "chatType": "INTERNAL",
    "chatId": "chat12345",
    "memoryType": "text",
    "sessionId": "text",
    "createdDate": "2024-08-24T14:15:22Z",
    "leadEmail": "[e-mail]"
  }
]

A list of chat messages

Delete all chat messages

delete

Delete all chat messages for a specific chatflow.

Authorizations

Path parameters

idstringrequired

Chatflow ID

Query parameters

chatIdstringoptional

Filter by chat ID

memoryTypestringoptional

Filter by memory type

Example: Buffer Memory

sessionIdstringoptional

Filter by session ID

chatTypestring · enumoptional

Filter by chat type

Available options:

startDatestringoptional

Filter by start date

Example: 2025-01-01T11:28:36.000Z

endDatestringoptional

Filter by end date

Example: 2025-01-13T11:28:36.000Z

feedbackTypestring · enumoptional

Filter by feedback type

Available options:

hardDeletebooleanoptional

If hardDelete is true, messages will be deleted from the third party service as well

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/chatmessage/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

200

No body

Chat messages deleted successfully