ML Utterances Export API¶

To export the ML utterances of a bot by creating a request ID to generate the download link of the bot using the ML Utterance Export Status API.

Method	POST
Endpoint	`https://{{host}}/api/public/bot/{{BotID}}/mlexport`
Content Type	`application/json`
Authorization	`auth: {{JWT}}` See How to generate the JWT Token.
API Scope	Bot Builder: Utterances Export Admin Console: Test > Utterances Export and Train

Query Parameters¶

PARAMETER	DESCRIPTION	MANDATE
host	The environment URL. For example, `https://bots.kore.ai`	Required
BotId	Bot ID or Stream ID can be accessed under General Settings on the Bot Builder.	Required

Sample Request¶

curl -X POST 'https://{{host}}/api/public/bot/{{bot_id}}/mlexport?state=configured&=&type=csv' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json'

Body Parameters¶

No body parameters are passed.

Sample Response¶

{
    "status": "IN_PROGRESS",
    "percentageComplete": 0,
    "streamId": "st-22184e1f-e116-5ed4-8741-7aec3be466d7",
    "jobType": "ML_UTTERANCE",
    "action": "EXPORT",
    "countOfDockStatuses": 1,
    "createdBy": "u-8214dc3a-c749-5d23-b8ad-2a21bfa396ca",
    "fileType": "CSV",
    "statusLogs": [],
    "_id": "ds-db32ec69-7f80-5873-890a-576fe585965f",
    "lMod": "2023-07-26T13:15:04.000Z",
    "createdOn": "2023-07-26T13:15:04.983Z",
    "requestedTime": "2023-07-26T13:15:04.984Z",
    "__v": 0
}