GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
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
Node Types
Overview
Intent Node
Dialog Node
Dynamic Intent Node
GenAI Node
GenAI Prompt
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections
Node Connections Setup
Sub-Intent Scoping
Entity Types
Entity Rules
User Prompts or Messages
Voice Call Properties
Knowledge AI
Introduction
Knowledge Graph
Introduction
Terminology
Build a Knowledge Graph
Manage FAQs
Knowledge Extraction
Import or Export Knowledge Graph
Prepare Data for Import
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Knowledge Graph Analysis
Answer from Documents
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Session and Context Variables
Context Object
Intent Discovery
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Introduction
LLM Integration
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Intelligence
Introduction
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Default Standard Responses
Ignore Words & Field Memory
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Conversation Testing Overview
Create a Test Suite
Test Editor
Test Case Assertion
Test Case Execution Summary
Glossary
Health and Monitoring
NLP Health
Flow Health
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
LLM and Generative AI Logs
NLP Insights
Task Execution Logs
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Team Collaboration
Plan & Usage
Overview
Usage Plans
Templates
Support Plans
Invoices
Authorization
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data
Overview
Data Table
Table Views
App Definitions
Data as Service
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
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
Migrate External Bots
Google Dialogflow Bot
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
SDK Security
SDK Registration
Web Socket Connect and RTM
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
SDK Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
Widget SDK Tutorial
Web SDK Tutorial
ADMINISTRATION
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Data Tables and Views
Assistant Management
Enrollment
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On (SSO)
Two-Factor Authentication (2FA)
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. API Guide
  5. Using XO Platform APIs

Using XO Platform APIs

The XO Platform allows you to develop Virtual Assistants using secured APIs. All key developer activities like creation, import and export, training, and publishing are available using these APIs. Key account management activities like managing XO Platform access, managing admin, and roles can also be performed via secured public APIs. For a complete list of APIs and usage instructions, refer here.

Authentication of the API requests involves the following two steps:

  1. Create an App: An App helps you create secure authentication credentials to access the XO Platform features. You can associate the app for enabling BotKit, APIs, SDKs, and Channels.
  2. Assign API Scopes to an App: Assigning API scopes to the app allows the app to access the Platform APIs securely:
    • XO Platform API Scopes: Developers can assign appropriate API Scopes to the app to access respective Platform features for a virtual assistant.
    • Bot Admin Console API Scopes: Account administrators can assign API Scopes to the app to access respective features in any virtual assistants built into their accounts on the Platform.

Creating and Managing Apps in XO Platform

Steps to create a Client App from the XO Platform:

  1. Go to Deploy > APIs & Extensions > Manage Apps.
  2. If you are creating an app for the first-time, click the Create App button. Otherwise, click the New App button.
  3. On the Create Client App page, enter a name for the app.
  4. Select Enforce JTI, JWE, or both as per your requirements to secure the connections with the Platform:
    • Enforce JTI (JWT ID) Claim – Once enabled, the Platform accepts the requests only from calls with the JTI Claim in the requests and those without JTI Claim are rejected.
    • Enforce JWE Encryption (Generating JWT token) – To access the XO Platform’s public APIs, the application making the API request requires authentication. Kore.ai uses the JWT (JSON Web Token) mechanism to handle the authentication. For a quick overview of the JWT token, read Introduction to JWT tokens.
  5. Click Next and Done.
    You are directed to the Manage Apps page, which lists all the apps associated with this virtual assistant.
     
  6. Click the app name or anywhere in the row to see the app’s details, such as Bot Name, Bot ID, Client ID, and Client Secret. Also, the App Usage column lists where this app is used – Web SDK, BotKit, APIs, WebHook and IVR Channels.
    Note: Use the Client ID and Client Secret of the client app from above to generate a JWT token. This token must be passed as a part of each API request for authorization.
  7. To delete apps, click the Delete icon against the respective app.
    Note: Only the Bot Owner can delete an app.

Creating and Managing Apps in Bots Admin Console

Steps to create a Client App from the Bot Admin Console:

  1. Log in to the Admin Console.
  2. Go to Security & Control > API Scopes.
  3. On the API Scopes page, click New.
  4. Click the Manage Apps link to create a new app.
  5. Click New App and then do the following:
    • Enter a name.
    • Select Enforce JTI, JWE, or both as per your requirements.
  6. Click Save.

Data Tables

Access control from the Data Tables module is different from the XO Platform and Bot Admin Console access controls.

You can define apps to securely access the data from data tables and data views.

  • You can create one or more apps, Learn more.
  • These apps can be used for:
    • Accessing the data tables and views over public APIs.
    • Accessing the data tables and views using Service Node.
    • Accessing the export and import API for the definition of data table and views.
  • You can grant this app read, write, and delete permissions to each table and view separately, Learn more.

Associating API Scopes

Once you create a client app, you can associate it with API scopes.

Adding API Scopes in the XO Platform

Steps to associate API Scopes to a Client App from the XO Platform:

  1. Go to Deploy > API & EXTENSIONs > API Scopes and click Create API Scope.
  2. On the New API Scope Mapping page, from the App drop-down list, select an existing client app for authentication.
  3. The app’s Client ID and Client Secret are displayed on the screen. Copy these values.

  4. Under the Scopes section, select the appropriate scopes to allow the client app to access the respective APIs. (If appropriate scopes are not selected, then the client apps cannot access the APIs).
  5. Click Save.

Adding API Scopes in the Bots Admin Console

Steps to associate API Scopes to a Client App from the Bot Admin Console:

  1. Log in to the Admin Console.
  2. Go to Security & Control > API Scopes.
  3. On the API Scopes page, click New.
  4. On the New API Scope Mapping page, from the App drop-down list, select an existing client app for authentication.
  5. Click the Manage Apps link to create a new app.
  6. Once you select an app, the Client ID and Client Secret appear. Copy these values.
  7. Under the Scopes section, select the appropriate Scopes to allow the client app to access the respective APIs.Learn more.
  8. Click Save. The app and associated scopes are listed on the API Scopes page.
  9. If you want to delete an app and its associated API Scope, click the Delete icon against the respective app.

List of Available API Scopes

SCOPE DESCRIPTION
Intent and Entity Detection Assign this scope to allow intent and entity detection from an utterance using secured APIs.
User Engagement Trend To retrieve the user engagement trend.
Batch Tests Execution To execute Batch Test Suites and get results.
Batch Tests Management To create, modify and delete Batch Test Suites and results.
Chat History Assign this scope to retrieve chat transcripts of this assistant using secured APIs.
Debug Logs Assign this scope to retrieve debug logs of this assistant using secured APIs.
Bot Export Export definition of a selected assistant.
Import Variables Assign this scope to import variables of this assistant using secured APIs.
Export Variables Assign this scope to export variables of this assistant using secured APIs.
Proactive Messages To proactively send messages to the end-users via the supported channels.
Train ML To match a given utterance against the NL model to identify possible intents and entities present in the utterance.
Train FAQ To match a given FAQ against the FAQ model.
Utterances Import To import utterances for a task.
Utterances Export To export utterances for a task.
Logs History To retrieve the change logs for the particular assistant.
Bot Sessions Assign this scope to retrieve conversation sessions.
Billing Sessions Assign this scope to retrieve billing sessions.
Custom Reports To retrieve the data associated with custom widgets and reports.
RCS Message Events Assign this scope for opting in users to RCS Business Messaging channel and sending broadcast messages.
Metrics Assign this scope to retrieve Metrics information related to Intents Found, Intents not Found, Failed Tasks, Successful Tasks and Performance Logs.
Manage Knowledge Graph To export the complete definition of the Knowledge Graph of this assistant.
NLP Configurations Assign this scope to update the NLP thresholds and configurations.
Update FAQs Assign this scope to update the FAQ Responses and FAQ Status.
Note: Once enabled, the API Scopes must be Published. Follow the Publish process to ensure that the API Scopes are selected.

Generating the JWT Token

Once you have associated the API scopes with a client app, you must generate the JWT token for API requests.

Steps to generate the token:

  1. Visit https://developer.kore.ai/tools/jwt/.
  2. In the Algorithm drop-down list, select HS256.
  3. Scroll down to the Decoded section, and update the Playload and the Secret.
      1. Replace the content of the Payload field with the code block shown below, and add the Client ID of the app copied in the previous section.
        {
        "sub": "1234567890",
        "appId": "add-Client-ID-here"
        }
    Note: The XO Platform validates the token only when it is entered exactly as “appId”. Don’t use “App ID”, “appid”, or “app ID”.
  4. In the Verify Signature field, replace your-256-bit-secret with the Client Secret copied in the previous section.
  • Click Copy JWT to copy the generated token. You can pass this token as a part of the API request for authorization.

Using XO Platform APIs

The XO Platform allows you to develop Virtual Assistants using secured APIs. All key developer activities like creation, import and export, training, and publishing are available using these APIs. Key account management activities like managing XO Platform access, managing admin, and roles can also be performed via secured public APIs. For a complete list of APIs and usage instructions, refer here.

Authentication of the API requests involves the following two steps:

  1. Create an App: An App helps you create secure authentication credentials to access the XO Platform features. You can associate the app for enabling BotKit, APIs, SDKs, and Channels.
  2. Assign API Scopes to an App: Assigning API scopes to the app allows the app to access the Platform APIs securely:
    • XO Platform API Scopes: Developers can assign appropriate API Scopes to the app to access respective Platform features for a virtual assistant.
    • Bot Admin Console API Scopes: Account administrators can assign API Scopes to the app to access respective features in any virtual assistants built into their accounts on the Platform.

Creating and Managing Apps in XO Platform

Steps to create a Client App from the XO Platform:

  1. Go to Deploy > APIs & Extensions > Manage Apps.
  2. If you are creating an app for the first-time, click the Create App button. Otherwise, click the New App button.
  3. On the Create Client App page, enter a name for the app.
  4. Select Enforce JTI, JWE, or both as per your requirements to secure the connections with the Platform:
    • Enforce JTI (JWT ID) Claim – Once enabled, the Platform accepts the requests only from calls with the JTI Claim in the requests and those without JTI Claim are rejected.
    • Enforce JWE Encryption (Generating JWT token) – To access the XO Platform’s public APIs, the application making the API request requires authentication. Kore.ai uses the JWT (JSON Web Token) mechanism to handle the authentication. For a quick overview of the JWT token, read Introduction to JWT tokens.
  5. Click Next and Done.
    You are directed to the Manage Apps page, which lists all the apps associated with this virtual assistant.
     
  6. Click the app name or anywhere in the row to see the app’s details, such as Bot Name, Bot ID, Client ID, and Client Secret. Also, the App Usage column lists where this app is used – Web SDK, BotKit, APIs, WebHook and IVR Channels.
    Note: Use the Client ID and Client Secret of the client app from above to generate a JWT token. This token must be passed as a part of each API request for authorization.
  7. To delete apps, click the Delete icon against the respective app.
    Note: Only the Bot Owner can delete an app.

Creating and Managing Apps in Bots Admin Console

Steps to create a Client App from the Bot Admin Console:

  1. Log in to the Admin Console.
  2. Go to Security & Control > API Scopes.
  3. On the API Scopes page, click New.
  4. Click the Manage Apps link to create a new app.
  5. Click New App and then do the following:
    • Enter a name.
    • Select Enforce JTI, JWE, or both as per your requirements.
  6. Click Save.

Data Tables

Access control from the Data Tables module is different from the XO Platform and Bot Admin Console access controls.

You can define apps to securely access the data from data tables and data views.

  • You can create one or more apps, Learn more.
  • These apps can be used for:
    • Accessing the data tables and views over public APIs.
    • Accessing the data tables and views using Service Node.
    • Accessing the export and import API for the definition of data table and views.
  • You can grant this app read, write, and delete permissions to each table and view separately, Learn more.

Associating API Scopes

Once you create a client app, you can associate it with API scopes.

Adding API Scopes in the XO Platform

Steps to associate API Scopes to a Client App from the XO Platform:

  1. Go to Deploy > API & EXTENSIONs > API Scopes and click Create API Scope.
  2. On the New API Scope Mapping page, from the App drop-down list, select an existing client app for authentication.
  3. The app’s Client ID and Client Secret are displayed on the screen. Copy these values.

  4. Under the Scopes section, select the appropriate scopes to allow the client app to access the respective APIs. (If appropriate scopes are not selected, then the client apps cannot access the APIs).
  5. Click Save.

Adding API Scopes in the Bots Admin Console

Steps to associate API Scopes to a Client App from the Bot Admin Console:

  1. Log in to the Admin Console.
  2. Go to Security & Control > API Scopes.
  3. On the API Scopes page, click New.
  4. On the New API Scope Mapping page, from the App drop-down list, select an existing client app for authentication.
  5. Click the Manage Apps link to create a new app.
  6. Once you select an app, the Client ID and Client Secret appear. Copy these values.
  7. Under the Scopes section, select the appropriate Scopes to allow the client app to access the respective APIs.Learn more.
  8. Click Save. The app and associated scopes are listed on the API Scopes page.
  9. If you want to delete an app and its associated API Scope, click the Delete icon against the respective app.

List of Available API Scopes

SCOPE DESCRIPTION
Intent and Entity Detection Assign this scope to allow intent and entity detection from an utterance using secured APIs.
User Engagement Trend To retrieve the user engagement trend.
Batch Tests Execution To execute Batch Test Suites and get results.
Batch Tests Management To create, modify and delete Batch Test Suites and results.
Chat History Assign this scope to retrieve chat transcripts of this assistant using secured APIs.
Debug Logs Assign this scope to retrieve debug logs of this assistant using secured APIs.
Bot Export Export definition of a selected assistant.
Import Variables Assign this scope to import variables of this assistant using secured APIs.
Export Variables Assign this scope to export variables of this assistant using secured APIs.
Proactive Messages To proactively send messages to the end-users via the supported channels.
Train ML To match a given utterance against the NL model to identify possible intents and entities present in the utterance.
Train FAQ To match a given FAQ against the FAQ model.
Utterances Import To import utterances for a task.
Utterances Export To export utterances for a task.
Logs History To retrieve the change logs for the particular assistant.
Bot Sessions Assign this scope to retrieve conversation sessions.
Billing Sessions Assign this scope to retrieve billing sessions.
Custom Reports To retrieve the data associated with custom widgets and reports.
RCS Message Events Assign this scope for opting in users to RCS Business Messaging channel and sending broadcast messages.
Metrics Assign this scope to retrieve Metrics information related to Intents Found, Intents not Found, Failed Tasks, Successful Tasks and Performance Logs.
Manage Knowledge Graph To export the complete definition of the Knowledge Graph of this assistant.
NLP Configurations Assign this scope to update the NLP thresholds and configurations.
Update FAQs Assign this scope to update the FAQ Responses and FAQ Status.
Note: Once enabled, the API Scopes must be Published. Follow the Publish process to ensure that the API Scopes are selected.

Generating the JWT Token

Once you have associated the API scopes with a client app, you must generate the JWT token for API requests.

Steps to generate the token:

  1. Visit https://developer.kore.ai/tools/jwt/.
  2. In the Algorithm drop-down list, select HS256.
  3. Scroll down to the Decoded section, and update the Playload and the Secret.
      1. Replace the content of the Payload field with the code block shown below, and add the Client ID of the app copied in the previous section.
        {
        "sub": "1234567890",
        "appId": "add-Client-ID-here"
        }
    Note: The XO Platform validates the token only when it is entered exactly as “appId”. Don’t use “App ID”, “appid”, or “app ID”.
  4. In the Verify Signature field, replace your-256-bit-secret with the Client Secret copied in the previous section.
  • Click Copy JWT to copy the generated token. You can pass this token as a part of the API request for authorization.
Menu