Documentation Index Fetch the complete documentation index at: https://koreai.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Back to API List A lightweight endpoint that returns chat transcripts without additional metadata or payload overhead. Supports high-volume retrieval and minimizes response size to reduce processing time and avoid rate limit issues.
Field Value Method GET and POST Endpoint GET : https://{{host}}/api/public/bot/{{botId}}/messages-lite?userId={{userId}}&limit=5&skip=0&offset=0 POST : https://{{host}}/api/public/bot/{{botId}}/messages-liteContent Type application/jsonAuthorization auth: {{JWT}} See How to generate the JWT Token .API Scope App Builder: Chat History; Admin Console: Bot Analytics > Chat History
Path Parameters Parameter Required Description hostRequired Environment URL, for example, https://platform.kore.ai. botIdRequired Bot ID or Stream ID. Access it on the bot’s General Settings page.
Sample Request GET Method: curl --location 'https://{{host}}/api/public/bot/{{botId}}/messages-lite?userId={{userId}}&limit=5&skip=0&offset=0' \ --header 'accept: application/json' \ --header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}'
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 (GET) Parameter Required Type Description userIdRequired String Unique identifier of the user. limitOptional Integer The maximum number of messages returned per request is 1000, with a default of 5 messages if no limit is specified. skipOptional Integer Number of records to skip before retrieving results. offsetOptional Integer Pagination offset value.
Request Body Parameters (POST) Parameter Required Type Description userIdRequired String Unique identifier of the user. sessionIdOptional String Unique session identifier. dateFromOptional String Start date for filtering messages. Format: YYYY-MM-DD. dateToOptional String End date for filtering messages. Format: YYYY-MM-DD. channelTypeOptional String Source channel, for example rtm. typeOptional Array Message direction: incoming or outgoing. limitOptional Integer Maximum number of messages to return. skipOptional Integer Number of records to skip. isDeveloperOptional Boolean Indicates if the query runs in developer mode.
Sample Response GET method: { "total" : 120 , "moreAvailable" : true , "messages" : [ { "_id" : "ms-221b1c28-b924-56be-aac7-2d28d5b5xxxx" , "botId" : "st-cb7818ab-5d92-5b27-95c4-503c1d94xxxx" , "type" : "outgoing" , "status" : "pending" , "createdOn" : "2025-11-11T05:05:46.526Z" , "sessionId" : "6912c08e55667c476791xxxx" , "lang" : "en" , "chnl" : "rtm" , "components" : [ { "cT" : "text" , "data" : { "text" : "I am closing our current conversation as I have not received any input from you." } } ] } ] }
Response Body Parameters Parameter Type Description totalInteger Total number of messages matching the query. moreAvailableBoolean Indicates whether more messages are available beyond the current response. messagesArray Array of message objects. _idString Unique identifier of the message. botIdString Unique identifier of the bot. typeString Direction: incoming or outgoing. statusString Message status, such as pending or received. createdOnString ISO 8601 timestamp when the message was created. sessionIdString Unique session ID. langString Language of the message. chnlString Channel through which the message was sent. componentsArray Array of message components. cTString Type of message component, for example text. dataObject Object containing message content.
