Chatbot Overview
Conversational Bots
Intents & Entities
Intelligent Bots
Kore.ai's Approach
Kore.ai Conversational Platform
Bot Concepts and Terminology
Natural Language Processing (NLP)
Bot Types
Bot Tasks
Starting with Kore.ai Platform
How to Access Bot Builder
Working with Kore.ai Bot Builder
Building your first Bot
Getting Started with Building Bots
Using the Dialog Builder Tool
Creating a Simple Bot
Release Notes
Latest Updates
Older Releases
Deprecations
Bot Builder
Creating a Bot
Design
Develop
Storyboard
Dialog Task
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Time Zones
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Managing Dialogs
User Prompts
Alert Tasks
Alert Tasks
Ignore Words and Field Memory
Digital Forms
Digital Views
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Small Talk
Action & Information Task
Action Tasks
Information Tasks
Establishing Flows
Natural Language
Overview
Machine Learning
ML Model
Fundamental Meaning
NLP Settings and Guidelines
Knowledge Graph Training
Traits
Ranking and Resolver
NLP Detection
Advanced NLP Configurations
Bot Intelligence
Overview
Context Management
Session and Context Variables
Context Object
Dialog Management
Sub-Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Default Conversations
Default Standard Responses
Channel Enablement
Test & Debug
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Publishing your Bot
Analyzing your Bot
Overview
Dashboard
Custom Dashboard
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
Data Table
Universal Bots
Defining
Creating
Training
Customizing
Enabling Languages
Smart Bots
Defining
Sample Bots
Github
Asana
Travel Planning
Flight Search
Event Based Bot Actions
koreUtil Libraries
Bot Settings
Bot Functions
General Settings
PII Settings
Customizing Error Messages
Manage Sessions
Bot Management
Bot Versioning
Using Bot Variables
API Guide
API Overview
API List
API Collection
SDKs
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
Installing
Configuring
Events
Functions
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
Bot Administration
Bots Admin Console
Dashboard
User Management
Managing Users
Managing Groups
Managing Role
Bots Management
Enrollment
Inviting Users
Bulk Invites
Importing Users
Synchronizing Users from AD
Security & Compliance
Using Single Sign-On
Security Settings
Cloud Connector
Analytics
Billing
How Tos
Creating a Simple Bot
Creating a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure Digital Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
  1. Home
  2. Docs
  3. Bots
  4. API Guide
  5. API List

API List

Following is the list of APIs available from the Kore.ai Bots Platform. For details on the API functioning and usage instructions refer here.

These APIs are available for testing in your Postman setup, for configuration details see here.

Based on the functionality addressed, the APIs can be categorized as:

  1. APIs related to the Bot Definition functionality, more
  2. APIs related to NLP training, more
  3. APIs aiding in Analyzing the bot performance and behavior, more
  4. APIs related to the Admin Console functionality, more
  5. APIs related to the data access from Data Tables, more

Bot Definition APIs

API Description Associated App Scope
Bot Builder Bot Admin
Upload File To upload the botdefinition, botconfig, and botfunction file (if any) as well as the bot icon to the local server and get the file ID to be used in Import Bot API. NA Bot Import under Bot Definition
Import Bot as a New Bot To create a new bot in the account owner’s Builder Tool using the File IDs generated by uploading the files. NA Bot Import under Bot Definition
Import Bot into an Existing Bot To import bot definition file into an existing bot for upgrading to a new version or restoring to an earlier version NA Bot Import under Bot Definition
Bot Import Status To get the status of the bot import request. NA Bot Import under Bot Definition
Install Sample Bot To install a sample bot. NA Bot Create under Bot Definition
Bot Export To export a bot definition and all associated components. Bot Export Bot Export under Bot Definition
Bot Export – Status To get the status of Bot Export request and also provides the download link of the bot export copy after the export is completed. Bot Export Bot Export under Bot Definition
Enable Channel To enable or update a channel for a bot. NA Channel Management under ChannelManagement
Publish Bot To initiate a publish request for a bot. NA Publish under Bot Publish
Bot Variables Import To import global and content variables into the bot. Import Variables NA
Bot Variables Export To export global and content variables from a bot. Export Variables NA

NLP Training APIs

API Description Associated App Scope
Bot Builder Bot Admin
ML Utterances Import To import ML Utterances into a bot. Utterances Import Utterances Import under Test & Train
ML Utterances Import Status To get the status of the ML utterances import request made through Import ML Utterances API. Utterances Import Utterances Import under Test & Train
ML Utterance Train To initiate ML training of a bot. Train ML Train ML under Test & Train
ML Utterance Train Status To get the status of the ML training. Train ML Train ML under Test & Train
ML Utterances Export To export the ML utterances of a bot. Utterances Export Utterances Export under Test & Train
ML Utterances Export Status To get the download link of the ML Utterances export copy. Utterances Export Utterances Export under Test & Train
FAQ Training To initiate the training of the knowledge graph. Train Faq Train Faq under Test & Train
FAQ Training Status To get the status of the FAQ training. Train Faq Train Faq under Test & Train
Extraction from file or URL To extract FAQs using file or URL. Manage Knowledge Graph Manage Knowledge Graph under Manage Knowledge Graph
Get Extractions History To get a list of KG Extractions history. Manage Knowledge Graph Manage Knowledge Graph under Manage Knowledge Graph
Get Extraction Question To get a list of KG Extraction Questions. Manage Knowledge Graph Manage Knowledge Graph under Manage Knowledge Graph
Get KnowledgeTasks To get a listing of knowledge Tasks along with the nodes. Manage Knowledge Graph Manage Knowledge Graph under Manage Knowledge Graph
Add Questions from Extraction To add specific questions from extraction to the Knowledge Graph. Manage Knowledge Graph Manage Knowledge Graph under Manage Knowledge Graph
Get FAQs To get a list of questions and nodes under the Knowledge task. Manage Knowledge Graph Manage Knowledge Graph under Manage Knowledge Graph
Update NLP Configurations To update the NLP thresholds and configurations. NLP Configurations NLP Configurations under Test & Train

Bot Analytics APIs

API Description Associated App Scope
Bot Builder Bot Admin
Find Intent To obtain the intent recognition result and the scoring from NLP and ML engines. Intent and Entity Detection NA
Conversation History To fetch the conversational messages between the bot and user in reverse chronological order. Chat History Chat History under Bot Analytics
Debug Logs To get debug logs of a specific conversation. Debug Logs NA
Get ChangeLogs To get the list of changes made to the bot definition for a given date period. Logs History Bot Audit Logs under Logs Admin
Sessions History To retrieve the conversation sessions created. Bot Sessions Bot Sessions under Logs
Dashboard Widget Data To get the data result of a widget from a specific Custom Dashboard added to a bot. Custom Reports Custom Reports under Custom Reports
Get Analytics To extract the metrics data related to the intent detection and task performance using API Metrics NA
User Engagement Trend To provide the number of users who have interacted with the bot in a given period across different time intervals. User Engagement Trend NA

Admin APIs

API Description Associated Bot Admin App Scope
Get Bots To retrieve the list of bots available in an account Role Management under Profile Management
Import Roles To import bot or admin roles into an account Role Management under Profile Management
Get Roles To retrieve the list of bot or admin roles available in an account. Role Management under Profile Management
Get User Roles Details To get full information of all users and their associated roles in the account Role Management under Profile Management
Get Groups To get the list of groups and group members available in the account Role Management under Profile Management
Export Roles To export bot or admin roles from an account Role Management under Profile Management
Assign BT Roles To assign a bot role to a set of users in a specific bot Role Management under Profile Management
Assign Admin Roles To add or remove users or groups from admin roles Role Management under Profile Management
Update User Access To add or remove the ability to access bot builder, create new bots Role Management under Profile Management
Create Users To add users to an account User Management under User Management
Get Users Information To retrieve the user details User Management under User Management
Update Users To update user details User Management under User Management
Remove Users from Account To remove users from an account User Management under User Management
Delete Customer Data To delete customer data Delete Users Data under Profile Management
Delete Customer Data Status API To get the status of the Customer Data Delete request Delete Users Data under Profile Management
Admin Console Audit Logs To get admin console audit logs Admin Console Audit Logs under Logs Admin

Data (Data Table) Access APIs

API Description Associated App Scope
Insert Data To insert data into Data Table Write access to the Data Table
Insert Bulk Data To insert bulk data into Data Table Write access to the Data Table
Update Data To update data into Data Table Read and Write access to the Data Table
Delete Data To delete data from Data Table Read and Delete access to the Data Table
Get Table Data To get data from Data Table Read access to the Data Table
Get View Data To get data from Data View Read access to the Table View
Menu