Conversation History API - Lightweight¶

The API provides a lightweight endpoint that returns chat transcripts without additional metadata or payload overhead. It supports high-volume retrieval and minimizes response size to reduce processing time and avoid rate limit issues.

Method	GET and POST
Endpoint	This API has GET and POST methods. GET Method `https://{{host}}>/api/public/bot/{{botId}}/messages-lite?userId={{userId}}&limit=5&skip=0&offset=0` POST Method `https://{{host}}/api/public/bot/{{botId}}/messages-lite`
Content Type	`application/json`
Authorization	`auth: {{JWT}}` See How to generate the JWT Token.
API Scope	App Builder: Chat History \ OR Admin Console: Bot Analytics > Chat History

Path Parameters¶

PARAMETER	REQUIRED/OPTIONAL	DESCRIPTION
host	required	Environment URL, for example, https://platform.kore.ai
botId	required	Bot ID or Stream ID. You can access it on the bot's General Settings page.

Sample Request¶

Sample Request for GET Method

curl --location
'https://{{host}}/api/public/bot/{{botId}}/messages-lite?userId={{user
Id}}&limit=5&skip=0&offset=0'
--header 'accept: application/json'
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}'

Sample Request for POST method

curl --location
'https://{{host}}/api/public/bot/{{botId}}/messages-lite'
--header 'accept: application/json'
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}'
--header 'Content-Type: application/json'
--data '{ "userId": "u-xxxx-xxxxx-xxxx", "sessionId":
"5eadxxxxxxxxxxxxx", "dateFrom": "2019-04-01", "dateTo":
"2019-04-30", "channelType": "rtm", "type": [ "incoming",
"outgoing" ], "limit": 100, "skip": 0, "isDeveloper": false, }'

Request Query Parameters¶

PARAMETER	REQUIRED/OPTIONAL	TYPE	DESCRIPTION
`userId`	Required	String	Unique identifier of the user.
`limit`	Optional	Integer	Maximum number of messages to return. Default is 5.
`skip`	Optional	Integer	Number of records to skip before retrieving results.
`offset`	Optional	Integer	Pagination offset value.

Request Body Parameters¶

PARAMETER	REQUIRED/OPTIONAL	TYPE	DESCRIPTION
`userId`	Required	String	Unique identifier of the user.
`sessionId`	Optional	String	Unique session identifier.
`dateFrom`	Optional	String	Start date for filtering messages. Format: `YYYY-MM-DD`.
`dateTo`	Optional	String (Date)	End date for filtering messages. Format: `YYYY-MM-DD`.
`channelType`	Optional	String (Date)	Source channel of the conversation. For example, `rtm`.
`type`	Optional	Array	Message direction. Supports `incoming` or `outgoing`.
`limit`	Optional	Integer	Maximum number of messages to return.
`skip`	Optional	Integer	Number of records to skip before retrieving results.
`isDeveloper`	Optional	Boolean	Indicates if the query runs in developer mode.

Sample Response¶

Sample response for the GET method

{
  "total": 120,
  "moreAvailable": true,
  "messages": [
    {
      "_id": "ms-221b1c28-b924-56be-aac7-2d28d5b5xxxx",
      "botId": "st-cb7818ab-5d92-5b27-95c4-503c1d94xxxx",
      "orgId": "o-a4577a81-97d7-53ba-aa0a-7b9d6a35xxxx",
      "accountId": "66eaa0843a8348c1e506xxxx",
      "type": "outgoing",
      "status": "pending",
      "createdBy": "u-dbb60272-982d-56ba-88f8-e647d7e6xxxx",
      "createdOn": "2025-11-11T05:05:46.526Z",
      "timestampValue": 1762837546526,
      "sessionId": "6912c08e55667c476791xxxx",
      "lang": "en",
      "chnl": "rtm",
      "components": [
        {
          "_id": "cp-53882b7c-a651-5a3d-ae81-ef04fbc5xxxx",
          "cT": "text",
          "data": {
            "text": "I am closing our current conversation as I have not received any   \ input from you. We can start over when you need."
          },
          "thumbnails": []
        }
      ],
      "channels": [
        {
          "from": "u-dbb60272-982d-56ba-88f8-e647d7e6xxxx"
        }
      ]
    },
    {
      "_id": "ms-fb4acded-b252-53bd-b8c8-91edda21xxxx",
      "botId": "st-cb7818ab-5d92-5b27-95c4-503c1d94xxxx",
      "orgId": "o-a4577a81-97d7-53ba-aa0a-7b9d6a35xxxx",
      "accountId": "66eaa0843a8348c1e506xxxx",
      "type": "incoming",
      "status": "received",
      "createdBy": "u-dbb60272-982d-56ba-88f8-e647d7e6xxxx",
      "createdOn": "2025-11-11T04:50:37.624Z",
      "timestampValue": 1762836637624,
      "sessionId": "6912c08e55667c476791xxxx",
      "lang": "en",
      "chnl": "rtm",
      "components": [
        {
          "_id": "cp-6b711fb2-0c82-5c08-a870-95ce4af4xxxx",
          "cT": "text",
          "data": {
            "text": "login"
          },
          "thumbnails": []
        }
      ],
      "channels": [
        {
          "from": "u-dbb60272-982d-56ba-88f8-e647d7e6xxxx",
          "channelUId": "john.doe@example.com"
        }
      ]
    }
  ]
}

Sample Response from POST method

{
  "total": 1234,
  "moreAvailable": true,
  "messages": [
    {
      "_id": "ms-fb4acded-b252-53bd-b8c8-91edda21xxxx",
      "botId": "st-cb7818ab-5d92-5b27-95c4-503c1d94xxxx",
      "orgId": "o-a4577a81-97d7-53ba-aa0a-7b9d6a35xxxx",
      "accountId": "66eaa0843a8348c1e506xxxx",
      "type": "incoming",
      "status": "received",
      "createdBy": "u-dbb60272-982d-56ba-88f8-e647d7e6xxxx",
      "createdOn": "2019-04-10T10:21:45.103Z",
      "timestampValue": 1554891705103,
      "sessionId": "6912c08e55667c476791xxxx",
      "lang": "en",
      "chnl": "rtm",
      "channels": [
        {
          "from": "john.doe@example.com",
          "to": "jane.doe@example.com",
          "channelUId": "john.doe@example.com"
        }
      ],
      "components": [
        {
          "_id": "cp-6b711fb2-0c82-5c08-a870-95ce4af4xxxx",
          "cT": "text",
          "data": {
            "additionalProp1": {}
          },
          "thumbnails": [
            {}
          ]
        }
      ]
    }
  ]
}

Response Body Parameters¶

PARAMETER	TYPE	DESCRIPTION
`total`	Integer	Total number of messages that match the query.
`moreAvailable`	Boolean	Indicates whether more messages are available beyond the current response.
`messages`	Array	An array of message objects is returned in the response.
`_id`	String	Unique identifier of the message or component.
`botId`	String	Unique identifier of the bot associated with the message.
`orgId`	String	Identifier of the organization associated with the bot.
`accountId`	String	Identifier of the account under which the message was generated.
`type`	String	Direction of the message. Possible values: `incoming`, `outgoing`.
`status`	String	Current message status, such as `pending` or `received`.
`createdBy`	String	Identifier of the sender or system that created the message.
`createdOn`	String (Date-Time)	ISO 8601 timestamp when the message was created.
`timestampValue`	Number	Epoch timestamp of message creation.
`sessionId`	String	Unique ID of the session associated with the message.
`lang`	String	Language of the message content. For example, `en`.
`chnl`	String	Channel through which the message was sent (for example, `rtm`).
`components`	Array	An array containing one or more message components.
`channels`	Array	An array containing channel metadata for the sender and the recipient.
`cT`	String	Type of message component. For example, `text`.
`data`	Object	Object containing message content, such as text or structured data.
`thumbnails`	Array	An array of thumbnail objects if media is present.
`from`	String	Sender identifier at the channel level.
`to`	String	Recipient identifier (in POST responses).
`channelUId`	String	Channel-specific unique sender identifier.

Send Feedback