GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Working with the Builder
Building a Virtual Assistant
Using Workspaces
Release Notes
Current Version
Previous Versions
Deprecations

CONCEPTS
Design
Storyboard
Dialog Tasks
Overview
Dialog Builder
Node Types
Intent Node
Dialog Node
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Group Node
Agent Transfer
User Prompts
Voice Call Properties
Dialog Task Management
Connections & Transitions
Component Transition
Context Object
Event Handlers
Knowledge Graph
Introduction
Knowledge Extraction
Build Knowledge Graph
Add Knowledge Graph to Bot
Create the Graph
Build Knowledge Graph
Add FAQs
Run a Task
Build FAQs from an Existing Source
Traits, Synonyms, and Stop Words
Manage Variable Namespaces
Update
Move Question and Answers Between Nodes
Edit and Delete Terms
Edit Questions and Responses
Knowledge Graph Training
Knowledge Graph Analysis
Knowledge Graph Import and Export
Importing Knowledge Graph
Exporting Knowledge Graph
Creating a Knowledge Graph
From a CSV File
From a JSON file
Auto-Generate Knowledge Graph
Alert Tasks
Small Talk
Digital Skills
Digital Forms
Views
Introduction
Panels
Widgets
Train
Introduction
ML Engine
Introduction
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
NLP Configurations
NLP Guidelines
Intelligence
Introduction
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Sentinment Management
Tone Analysis
Test & Debug
Talk to Bot
Utterence Testing
Batch Testing
Conversation Testing
Deploy
Channels
Publish
Analyze
Introduction
Conversations Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Meta Tags
Dashboards and Widgets
Conversation Flows
NLP Metrics
Containment Metrics
Usage Metrics
Smart Bots
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Plan & Usage
Overview
Usage Plans
Support Plans
Invoices
Authorization
Multilingual Virtual Assistants
Masking PII Details
Variables
IVR Settings
General Settings
Assistant Management
Data Table
Table Views
App Definitions
Sharing Data Tables or Views

HOW TOs
Build a Flight Status Assistant
Design Conversation Skills
Create a Sample Banking Assistant
Create a Transfer Funds Task
Create a Update Balance Task
Create a Knowledge Graph
Set Up a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Add Data to Data Tables
Update Data in Data Tables
Add Data from Digital Forms
Train the Assistant
Use Traits
Use Patterns for Intents & Entities
Manage Context Switching
Deploy the Assistant
Configure an Agent Transfer
Use Assistant Functions
Use Content Variables
Use Global Variables
Web SDK Tutorial
Widget SDK Tutorial
Analyze the Assistant
Create a Custom Dashboard
Use Custom Meta Tags in Filters

APIs & SDKs
API Reference
API Introduction
API List
API Collection
koreUtil Libraries
SDK Reference
SDK Introduction
SDK Security
SDK Registration
Web Socket Connect and RTM
Using the BotKit SDK

ADMINISTRATION
Introduction
Assistant Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Assistant Management
Enrollment
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Compliance
Using Single-Sign On
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  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.

To upload utterances in ML Utterances Import API, bot roles, admin roles for Import Roles API, Import Batch Test Suite details and Extraction from file or URL to extract FAQs.

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 Channel Management
Proactive Notification To send proactive notifications to the configured channel in bot. NA Proactive Notification enabled for Bot Builder and BAC Console.
Proactive Notification Status To send proactive notifications to the configured channel in bot. NA Proactive Notification enabled for Bot Builder and BAC Console.
Publish Bot To initiate a publish request for a bot. NA Publish under Bot Publish
Bot Publish Status Gets the publish status of the ongoing bot or the last completed status request of the bot. Refer here for initiating Publish Bot API NA Publish under Bot Publish
Bot Variables Import To import global and content variables into the bot. Import Variables NA
Batch Test Execution To invoke the execution of a Batch Test suite. Batch Tests Execution NA
Batch Test Execution Status To know the status of the of the execution against a unique Test Request Id Batch Tests Execution NA
Get Batch Test Suites To get the list of Batch Test Suites available for a bot Batch Tests Management Batch Tests Management
Export Batch Test Suite To export the test cases of a given Batch Test Suite Batch Tests Management Batch Tests Management
Import Batch Test Suite To import a batch test suite Batch Tests Management Batch Tests Management
Delete Batch Test Suite To delete a Batch Test Suite Batch Tests Management Batch Tests Management
Delete Batch Test Suite Execution To delete a specific execution of a Batch Test Suite Batch Tests Management Batch Tests Management

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 Intent and Entity Detection under
Intent Detection
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