{"id":18073,"date":"2018-11-24T06:27:42","date_gmt":"2018-11-24T06:27:42","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?post_type=docs&p=15505"},"modified":"2021-03-25T07:38:54","modified_gmt":"2021-03-25T07:38:54","slug":"ml-utterances-export-status-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/ml-utterances-export-status-api\/","title":{"rendered":"ML Utterances Export Status API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Gets the download link of the ML Utterances export copy.<\/p>\n

To use this API, app needs the Bot Builder API scope of Utterances Export<\/em>.
\nOR the Admin API Scope of Utterances Export<\/em> under Test and Train<\/em>.<\/p>\n

GET<\/b> https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/mlexport\/status<\/code><\/i><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Path Parameters<\/span><\/h3>\n\n\n\n\n\n
Parameter<\/b><\/th>\nRequired\/Optional<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
host<\/td>\nRequired<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n
BotID<\/td>\nRequired<\/td>\nBot ID or Stream ID. You can access it from the General Settings page of the bot.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Authorization<\/span><\/h3>\n

Invoke the API with JWT in the header with the following syntax:<\/p>\n

auth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Response Content Type<\/span><\/h3>\n

application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Sample Request<\/span><\/h3>\n
curl -X GET \\\r\n  https:\/\/{{host}}\/api\/public\/bot\/{{bot ID}}\/mlexport\/status \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n  -H 'content-type: application\/json' \\<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h3>\n
{\r\n    \"_id\": \"ds-aadcadee-befe-559c-b15f-31b87b0d8e63\",\r\n    \"status\": \"SUCCESS\",\r\n    \"percentageComplete\": 100,\r\n    \"streamId\": \"st-6ecb5ba2-5e31-5a40-b918-8cbee40f3fdb\",\r\n    \"createdBy\": \"u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91\",\r\n    \"jobType\": \"ML_UTTERANCE\",\r\n    \"action\": \"EXPORT\",\r\n    \"fileType\": \"CSV\",\r\n    \"statusLogs\": [],\r\n    \"lMod\": \"2019-06-27T06:49:15.726Z\",\r\n    \"createdOn\": \"2019-06-27T06:49:15.572Z\",\r\n    \"__v\": 0,\r\n    \"downloadUrl\": \"\"\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"Gets the download link of the ML Utterances export copy. To use this API, app needs the Bot Builder API scope of Utterances Export. OR the Admin API Scope of Utterances Export under Test and Train. GET https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/mlexport\/status Path Parameters Parameter Required\/Optional Description host Required Environment URL, for example, https:\/\/bots.kore.ai BotID Required Bot ID or...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-18073","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18073","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/comments?post=18073"}],"version-history":[{"count":5,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18073\/revisions"}],"predecessor-version":[{"id":22551,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/18073\/revisions\/22551"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=18073"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=18073"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=18073"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}