Chat Message

List all chat messages

Retrieve all chat messages for a specific chatflow.

GET/chatmessage/{id}

Authorization

bearerAuth

Path parameters

id*string

Chatflow ID

Query parameters

Response

200500

A list of chat messages

Body

application/json

idstring (uuid)

Example: "d290f1ee-6c54-4b01-90e6-d701748f0851"

roleenum

Example: "apiMessage"

apiMessageuserMessage

chatflowidstring (uuid)

Example: "d290f1ee-6c54-4b01-90e6-d701748f0852"

contentstring

Example: "Hello, how can I help you today?"

sourceDocumentsnullable array of Document (object)

usedToolsnullable array of UsedTool (object)

fileAnnotationsnullable array of FileAnnotation (object)

agentReasoningnullable array of AgentReasoning (object)

fileUploadsnullable array of FileUpload (object)

actionnullable array of Action (object)

chatTypeenum

Example: "INTERNAL"

INTERNALEXTERNAL

chatIdstring

Example: "chat12345"

memoryTypenullable string

sessionIdnullable string

createdDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

leadEmailnullable string

Example: "[e-mail]"

Request

JavaScriptCurlPython

const response = await fetch('/chatmessage/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

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"
            }
          }
        ]
      }
    ],
    "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]"
  }
]

Delete all chat messages

Delete all chat messages for a specific chatflow.

DELETE/chatmessage/{id}

Authorization

bearerAuth

Path parameters

id*string

Chatflow ID

Query parameters

Response

200400404500

Chat messages deleted successfully

Request

JavaScriptCurlPython

const response = await fetch('/chatmessage/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();