Docs

FAQ Training Status API

To get the status of the FAQ training. Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/faqs/train/status?language={{Lang}}&state={{state}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Train FAQ Admin Console: Test and Train > Train FAQ Path Parameters Parameter Description Mandate host The environment URL.…

FAQ Training API

To initiate the training of the knowledge graph. Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/faqs/train Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Train FAQ Admin Console: Test and Train > Train FAQ Path Parameters Parameter Description Mandate host The environment URL.…

ML Utterances Export Status API

To get the download link of the ML Utterances export copy. Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/mlexport/status 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 Path Parameters Parameter Required/Optional Description host…

ML Utterances Import Status API

To get the status of the ML utterances import request made through Import ML Utterances API. Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/mlimport/status/{{MLutteranceID}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Utterances Import Admin Console: Test and Train > Utterances Import Path…

ML Utterances Import API

To import the ML Utterances into a bot. Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/mlimport Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Utterances Import Admin Console: Test > Utterances Import and Train Query Parameters Parameter Description Mandate host The environment URL.…

ML Utterance Train Status API

To get the ML training status. Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/ml/train/status?language={{lang}}&state={{state}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Train ML Admin Console: Test and Train > Train ML Path Parameters Parameter Description Mandate host The environment URL. For example,…

ML Utterances Train API

To initiate the ML training for a bot. Method POST Endpoint https://{{host}}/api/public/bot/{{BotID}}/ml/train Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Train ML Admin Console: Test and Train > Train ML Query Parameters Parameter Description Mandate host The environment URL.…

Role Management

Roles and Permissions help in organizing the developer community based on the scope of their work. By default the roles of Master Admin, Bot Owner, Bot Developer and Bot Tester are created by the system. Each role has set of permissions allowed. You can edit the permission settings for Bot…

Event Based Bot Actions

Events are triggered when specific actions occur during conversation with the Virtual Assistant or when specific events are triggered on any active channels. For example, when a user clicks the Get Started button to initiate a chat with your FB Messenger VA, it triggers the Facebook Welcome event. You can…

Implementing Custom Authentication

You can implement custom authentication for your VA by providing a URL from the service node to an external application that manages the authentication. The platform provides the necessary functionality to handle successful and failed authentication scenarios and manage the corresponding task flows. Implementing custom authentication involves the following steps:…