GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Help & Learning Resources
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Using Workspaces
Release Notes
Current Version
Previous Versions
Deprecations
Request a Feature
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Nodes & Connections
Overview
Node Types
Intent Node
Dialog Node
Entity Node
Entity Rules
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections Setup
Context Object
Sub-Intent Scoping
User Prompts
Voice Call Properties
Dialog Task Management
Event Handlers
Supported Entity Types
Supported Company Names
Supported Colors
Knowledge Graph
Introduction
Knowledge Extraction
Build Knowledge Graph
Create Node Structure
Build the Graph
Add FAQs
Add FAQs from an Existing Source
Run a Task
Traits, Synonyms, and Stop Words
Manage Variable Namespaces
Update Knowledge Graph
Introduction
Move Question and Answers Between Nodes
Edit and Delete Terms
Edit Questions and Responses
Knowledge Graph Analysis
Knowledge Graph Import and Export
Prepare Data for Import
From a CSV File
From a JSON File
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
Intelligence
Introduction
Default Standard Responses
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Health and Monitoring
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
NLP Insights
Conversations History
Conversation Flows
Analytics Dashboard Filters
Usage Metrics
Containment 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
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data as Service
Data Table
Table Views
App Definitions
Sharing Data Tables or Views
HOW TOs
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Configure Agent Transfer
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking 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
Composite Entities
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
Intent Scoping using Group Node
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
BotKit SDK Tutorial - Blue Prism
Widget SDK Tutorial
Web SDK Tutorial
ADMINISTRATION
Introduction to 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 & Control
Using Single-Sign On
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. API Guide
  5. APIs List

APIs List

Following is the list of APIs available from the Kore.ai XO 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 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
XO PLATFORM ADMIN CONSOLE
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 the 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 Definition > Bot Import
Import Bot as a New Bot To create a new assistant in the account owner’s XO Platform using the File IDs generated when uploading the files. NA Bot Definition > Bot Import
Import Bot into an Existing Bot To import the bot definition file into an existing assistant for upgrading to a new version or restoring to an earlier version NA Bot Definition > Bot Import
Bot Import Status To get the status of the bot import request. NA Bot Definition > Bot Import
Install Sample Bot To install a sample assistant . NA Bot Definition > Bot Create
Bot Export To export a bot definition and all associated components. Bot Export Bot Definition > Bot Export
Bot Export – Status To get the status of the Bot Export request and also provides the download link of the export copy after the export is completed. Bot Export Bot Definition > Bot Export
Enable Channel To enable or update a channel for an assistant. NA Channel Management
Add and Enable a New Language To add and enable a new language for a virtual assistant. Languages Configuration. API Scopes > Language Settings
Enable an existing Language To enable an existing language for a virtual assistant. Languages Configuration. API Scopes > Language Settings
Disable an existing Language To disable an existing language for a virtual assistant that is currently enabled. Languages Configuration. API Scopes > Language Settings
Update a Language Configuration To update the configuration of an existing language for a virtual assistant. Languages Configuration. API Scopes > Language Settings
Proactive Notification To send proactive notifications to the configured channel. NA Channel Management > Proactive Messages
Proactive Notification Status To send proactive notifications to the configured channel. NA Channel Management > Proactive Messages
Publish Bot To initiate a bot publish request. NA Bot Publish > Publish
Bot Publish Status Gets the publish status of the ongoing assistant or the last completed status request of the assistant.  NA Bot Publish > Publish
Bot Variables Import To import global and content variables into the assistant. 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 execution against a unique Test Request Id Batch Tests Execution NA
Get Batch Test Suites To get the list of Batch Test Suites available 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
XO PLATFORM ADMIN CONSOLE
ML Utterances Import To import ML Utterances into an assistant. Utterances Import Test > Utterances Import & Train
ML Utterances Import Status To get the status of the ML utterances import request made through Import ML Utterances API. Utterances Import Test > Utterances Import & Train
ML Utterance Train To initiate ML training of an assistant. Train ML Test > Train ML & Train
ML Utterance Train Status To get the status of the ML training. Train ML Test > Train ML & Train
ML Utterances Export To export the ML utterances of an assistant. Utterances Export Test > Utterances Export & Train
ML Utterances Export Status To get the download link of the ML Utterances export copy. Utterances Export Test > Utterances Export & Train
FAQ Training To initiate the training of the knowledge graph. Train Faq Test > Train FAQ & Train
FAQ Training Status To get the status of the FAQ training. Train Faq Test > Train FAQ & Train
Extraction from file or URL To extract FAQs using a file or URL. Manage Knowledge Graph Manage Knowledge Graph
Get Extractions History To get a list of KG Extractions history. Manage Knowledge Graph Manage Knowledge Graph
Get Extraction Question To get a list of KG Extraction Questions. Manage Knowledge Graph Manage Knowledge Graph
Get KnowledgeTasks To get a listing of knowledge Tasks along with the nodes. Manage Knowledge Graph Manage Knowledge Graph
Add Questions from Extraction To add specific questions from extraction to the Knowledge Graph. Manage Knowledge Graph Manage Knowledge Graph
Get FAQs To get a list of questions and nodes under the Knowledge task. Manage Knowledge Graph Manage Knowledge Graph
Update NLP Configurations To update the NLP thresholds and configurations. NLP Configurations Test > NLP Configurations & Train

Analytics APIs

API DESCRIPTION ASSOCIATED APP SCOPE
XO PLATFORM ADMIN CONSOLE
Find Intent To obtain the intent recognition result and the scoring from NLP and ML engines. Intent and Entity Detection

Intent Identification > Intent and Entity Detection

Conversation History To fetch the conversational messages between the assistant and user in reverse chronological order. Chat History Bot Analytics > Chat History
Debug Logs To get debug logs of a specific conversation. Debug Logs NA
Get ChangeLogs To get the list of changes made to the assistant definition for a given date period. Logs History Logs > Bot Audit Logs
Sessions History To retrieve the conversation sessions created. Bot Sessions Bot Analytics > Bot Sessions
Get Dashboard Widget Data To get the data result of a widget from a specific Custom Dashboard added to an assistant. Custom Reports Custom Reports > 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 assistant 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 Profile Management > Role Management
Import Roles To import bot or admin roles into an account Profile Management > Role Management
Get Roles To retrieve the list of bot or admin roles available in an account. Profile Management > Role Management
Get User Roles Details To get full information on all users and their associated roles in the account Profile Management > Role Management
Get Groups To get the list of groups and group members available in the account Profile Management > Role Management
Export Roles To export bot or admin roles from an account Profile Management > Role Management
Assign BT Roles To assign a bot role to a set of users in a specific assistant Profile Management > Role Management
Assign Admin Roles To add or remove users or groups from admin roles Profile Management > Role Management
Update User Access To add or remove the ability to access XO Platform, create new assistants Profile Management > Role Management
Create Users To add users to an account User Management
Get Users Information To retrieve the user details User Management
Update Users To update user details User Management
Remove Users from Account To remove users from an account User Management
Delete Customer Data To delete customer data Profile Management > Delete Users Data
Delete Customer Data Status API To get the status of the Customer Data Delete request Profile Management > Delete Users Data
Admin Console Audit Logs To get admin console audit logs Logs Admin > Admin Console Audit Logs

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