1. Home
  2. Kore.ai Conversational Platform
  3. Using Kore.ai APIs
  4. Bot Export API

Bot Export API

Used to export bot definition and all associated components. This API only initiates the export process. Use Export Status API to view the progress of the export and also to get a link to download the file once export is completed.

POST https://{{host}}/api/public/bot/{{botid}}/export

Query Parameters

Parameter Description
host Environment URL, for example, https://bots.kore.ai
bot_id Bot ID or Stream ID. You can access it from the General Settings page of the bot.

Body Parameters

Parameter Description
exportType Export mode – ‘latest’ or ‘published’
exportOptions (optional) All bot components are exported by default. If needed, you may specify the components to be included in the export.

“exportOptions”: {

“tasks”: [

“botTask”,

“knowledgeGraph”

],

“nlpData”: [

“nlpSettings”,

“utterances”,

“standardResponses”

],

“settings”: [

“botSettings”,

“botVariables”,

“ivrSettings”

]

},

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {JWT}

Response content type

application/json

Sample Request

curl -X POST \
  http://{{host}}/api/public/bot/{{bot_Id}/export \

  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \

  -H 'content-type: application/json' \

  -d '{
"exportType": "latest"
}'

Sample Response

{
    "streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
    "createdBy": "u-xxx-xxx-xxx-xxx-xxxxx",
    "exportType": "published",
    "requestType": "Botexport",
    "_id": "ber-xxxxx-xxx-xxx-xxx-xxxxx",
    "status": "pending",
    "createdOn": "2018-12-05T07:18:40.028Z",
    "__v": 0
}

Articles

Was this article helpful to you? Yes No