To create a new bot in the account owner’s Builder Tool using the File IDs generated when uploading the files to the local server.
Note: The API requires the JWT generated by an application created only from the Bot Admin Console.
Method | POST |
Endpoint | https://{{host}}/api/public/bot/import |
Content Type | application/json |
Authorization |
|
API Scope |
|
Query Parameters
Parameter | Description | Mandate |
---|---|---|
host | The environment URL. For example, https://bots.kore.ai |
Required |
Sample Request
curl -X POST \ https://{{host}}/api/public/bot/import \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json' \ -d '{ "botDefinition" : "5bxxxxxxxxxxx4f9", "configInfo" : "5bxxxxxxxxxxxxx4fa", "botFunctions":["5bxxxxxxxxxxxxxea6"], "icon":"5bxxxxxxxxxxxxxxxx4fb" }'
Body Parameters
Parameter | Description | Mandate |
---|---|---|
botDefinition | “Bot definition file id” | Required |
configInfo | “Bot configuration file id” | Required |
botFunctions | “Bot functions File id” | Optional |
icon | “Bot icon File id” | Required |
name | “Bot name” – If not provided, it is fetched from the existing bot’s copy. |
Optional |
purpose | “customer”/”employee” – If not provided, it is fetched from the existing bot’s copy. |
Optional |
Sample Response
{ "status": "pending", ""streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx", "statusLogs": [ { "taskType": "importRequest", "taskName": "Welcome", "status": "success" } ], "createdBy": "u-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx", "requestType": "Botimport", "bir": "bir-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "createdOn": "2022-07-29T07:24:17.496Z", "__v": 0 }