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 Node (v2, BETA)
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
Guardrails
Intelligence
Introduction
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentiment 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
Guidelines
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
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
Web SDK
How the Web SDK Works
SDK Security
SDK Registration
Web Socket Connect and RTM
Tutorials
Widget SDK Tutorial
Web SDK Tutorial
BotKit SDK
BotKit SDK Deployment Guide
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
Installing Botkit in AWS
Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer

ADMINISTRATION
Intro to Bots Admin Console
Administration Dashboard
User Management
Managing Your Users
Managing Your Groups
Role Management
Manage Data Tables and Views
Bot Management
Enrollment
Inviting Users
Sending Bulk Invites to Enroll Users
Importing Users and User Data
Synchronizing Users from Active Directory
Security & Compliance
Using Single Sign-On
Two-Factor Authentication for Platform Access
Security Settings
Cloud Connector
Analytics for Bots Admin
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. API Guide
  5. Get Roles API

Get Roles API

To retrieve the list of the bot or admin roles available in an account.

This API requires JWT generated by an application created only from the Bot Admin Console.

Method GET
Endpoint https://{{host}}/api/public/roles?roleType=bot&limit=2
Content Type application/json
Authorization auth: {{JWT}}

See How to generate the JWT Token.

API Scope
  • Bot Builder: Not Applicable
  • Admin Console: Profile Management > Role Management

Path Parameters

Parameter Required/Optional Description
host Required Environment URL, for example, https://bots.kore.ai
roleType Required The role type:

  • admin or
  • bot
limit Optional The number of records to fetch. The maximum applicable limit is 50.

Sample Request

curl -X GET \
  'https://{{host}}/api/public/roles?roleType=bot&limit=2' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

Sample Response (Admin)

{
    "total": 2,
    "availableMore": false,
    "roles": [
        {
            "roleType": "admin",
            "role": "admin",
            "rDesc": "Master administration role with full control on account activity",
            "permissions": {
                "Invite": "YES",
                "Import Users / Sync": "YES",
                "Directory Sync": "YES",
                "Manage User Profile Fields": "YES",
                "Manage Groups": "YES",
                "Manage Deployment": "YES",
                "Enterprise Bots": "YES",
                "Password Policies": "YES",
                "Single Sign On": "YES",
                "Domain Management": "YES",
                "Kore.ai Connector": "YES",
                "Manage Built-In Admin Roles": "YES",
                "Manage Custom Admin Roles": "YES",
                "View and Run Audit Reports": "YES",
                "Consumer Bots": "YES",
                "View and Run Bot Chat History": "YES",
                "Manage Bot Roles": "YES",
                "Preferences": "YES",
                "Smart Bots": "YES",
                "API Scopes": "YES",
                "Enterprise Key": "YES"
            }
        },
        {
            "roleType": "admin",
            "role": "sample admin",
            "permissions": {
                "Invite": "YES",
                "Import Users / Sync": "NO",
                "Directory Sync": "NO",
                "Manage User Profile Fields": "YES",
                "Manage Groups": "YES",
                "Manage Deployment": "YES",
                "Enterprise Bots": "YES",
                "Smart Bots": "YES",
                "Preferences": "YES",
                "Single Sign On": "YES",
                "Kore.ai Connector": "YES",
                "Manage Built-In Admin Roles": "YES",
                "Manage Bot Roles": "YES",
                "Manage Custom Admin Roles": "YES",
                "View and Run Audit Reports": "YES",
                "View and Run Bot Chat History": "YES",
                "Consumer Bots": "YES",
                "API Scopes": "YES",
                "Enterprise Key": "YES"
            },
            "rDesc": ""
        }
    ]
}

Sample Response (bot)

{
    "total": 5,
    "availableMore": true,
    "roles": [
        {
            "roleType": "bot",
            "_id": "6495a4d56ca3571b556cf163",
            "role": "Bot Owner",
            "rDesc": "Role of bot owners with full access to bot definition",
            "permissions": {
                "Tasks": [
                    "FULL"
                ],
                "Natural Language": [
                    "FULL"
                ],
                "Knowledge Graph": [
                    "FULL"
                ],
                "Testing": [
                    "FULL"
                ],
                "Bot Developers": [
                    "FULL"
                ],
                "Bot Settings": [
                    "FULL"
                ],
                "Bot Import": [
                    "YES"
                ],
                "Integrations & Extensions": [
                    "YES"
                ],
                "Bot Builder API Scopes": [
                    "YES"
                ],
                "Publish bot": [
                    "YES"
                ],
                "Channels": [
                    "YES"
                ],
                "Dashboard": [
                    "YES"
                ],
                "Bot Analytics": [
                    "YES"
                ],
                "Custom Dashboards": [
                    "FULL"
                ],
                "Storyboard": [
                    "FULL"
                ],
                "IntentDiscovery": [
                    "FULL"
                ]
            }
        },
        {
            "roleType": "bot",
            "_id": "6495a4d56ca3571b556cf164",
            "role": "Bot Developer",
            "rDesc": "Role for bot co-developers",
            "permissions": {
                "Tasks": [
                    "FULL"
                ],
                "Natural Language": [
                    "FULL"
                ],
                "Knowledge Graph": [
                    "FULL"
                ],
                "Bot Developers": [
                    "VIEW"
                ],
                "Bot Settings": [
                    "FULL"
                ],
                "Bot Import": [
                    "YES"
                ],
                "Publish bot": [
                    "YES"
                ],
                "Channels": [
                    "YES"
                ],
                "Dashboard": [
                    "YES"
                ],
                "Bot Analytics": [
                    "YES"
                ]   
            }
        },
        {
            "roleType": "bot",
            "_id": "6495a4d56ca3571b556cf165",
            "role": "Bot Tester",
            "rDesc": "Role for bot testers with read-only access to bot definition",
            "permissions": {
                "Tasks": [
                    "VIEW"
                ],
                "Natural Language": [
                    "VIEW"
                ],
                "Knowledge Graph": [
                    "VIEW"
                ],
                "Bot Developers": [
                    "VIEW"
                ],
                "Bot Settings": [
                    "NO"
                ],
                "Bot Import": [
                    "NO"
                ],
                "Publish bot": [
                    "NO"
                ],
                "Channels": [
                    "NO"
                ],
                "Dashboard": [
                    "YES"
                ],
                "Bot Analytics": [
                    "YES"
                ]
            }
        }
    ]
}

Get Roles API

To retrieve the list of the bot or admin roles available in an account.

This API requires JWT generated by an application created only from the Bot Admin Console.

Method GET
Endpoint https://{{host}}/api/public/roles?roleType=bot&limit=2
Content Type application/json
Authorization auth: {{JWT}}

See How to generate the JWT Token.

API Scope
  • Bot Builder: Not Applicable
  • Admin Console: Profile Management > Role Management

Path Parameters

Parameter Required/Optional Description
host Required Environment URL, for example, https://bots.kore.ai
roleType Required The role type:

  • admin or
  • bot
limit Optional The number of records to fetch. The maximum applicable limit is 50.

Sample Request

curl -X GET \
  'https://{{host}}/api/public/roles?roleType=bot&limit=2' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

Sample Response (Admin)

{
    "total": 2,
    "availableMore": false,
    "roles": [
        {
            "roleType": "admin",
            "role": "admin",
            "rDesc": "Master administration role with full control on account activity",
            "permissions": {
                "Invite": "YES",
                "Import Users / Sync": "YES",
                "Directory Sync": "YES",
                "Manage User Profile Fields": "YES",
                "Manage Groups": "YES",
                "Manage Deployment": "YES",
                "Enterprise Bots": "YES",
                "Password Policies": "YES",
                "Single Sign On": "YES",
                "Domain Management": "YES",
                "Kore.ai Connector": "YES",
                "Manage Built-In Admin Roles": "YES",
                "Manage Custom Admin Roles": "YES",
                "View and Run Audit Reports": "YES",
                "Consumer Bots": "YES",
                "View and Run Bot Chat History": "YES",
                "Manage Bot Roles": "YES",
                "Preferences": "YES",
                "Smart Bots": "YES",
                "API Scopes": "YES",
                "Enterprise Key": "YES"
            }
        },
        {
            "roleType": "admin",
            "role": "sample admin",
            "permissions": {
                "Invite": "YES",
                "Import Users / Sync": "NO",
                "Directory Sync": "NO",
                "Manage User Profile Fields": "YES",
                "Manage Groups": "YES",
                "Manage Deployment": "YES",
                "Enterprise Bots": "YES",
                "Smart Bots": "YES",
                "Preferences": "YES",
                "Single Sign On": "YES",
                "Kore.ai Connector": "YES",
                "Manage Built-In Admin Roles": "YES",
                "Manage Bot Roles": "YES",
                "Manage Custom Admin Roles": "YES",
                "View and Run Audit Reports": "YES",
                "View and Run Bot Chat History": "YES",
                "Consumer Bots": "YES",
                "API Scopes": "YES",
                "Enterprise Key": "YES"
            },
            "rDesc": ""
        }
    ]
}

Sample Response (bot)

{
    "total": 5,
    "availableMore": true,
    "roles": [
        {
            "roleType": "bot",
            "_id": "6495a4d56ca3571b556cf163",
            "role": "Bot Owner",
            "rDesc": "Role of bot owners with full access to bot definition",
            "permissions": {
                "Tasks": [
                    "FULL"
                ],
                "Natural Language": [
                    "FULL"
                ],
                "Knowledge Graph": [
                    "FULL"
                ],
                "Testing": [
                    "FULL"
                ],
                "Bot Developers": [
                    "FULL"
                ],
                "Bot Settings": [
                    "FULL"
                ],
                "Bot Import": [
                    "YES"
                ],
                "Integrations & Extensions": [
                    "YES"
                ],
                "Bot Builder API Scopes": [
                    "YES"
                ],
                "Publish bot": [
                    "YES"
                ],
                "Channels": [
                    "YES"
                ],
                "Dashboard": [
                    "YES"
                ],
                "Bot Analytics": [
                    "YES"
                ],
                "Custom Dashboards": [
                    "FULL"
                ],
                "Storyboard": [
                    "FULL"
                ],
                "IntentDiscovery": [
                    "FULL"
                ]
            }
        },
        {
            "roleType": "bot",
            "_id": "6495a4d56ca3571b556cf164",
            "role": "Bot Developer",
            "rDesc": "Role for bot co-developers",
            "permissions": {
                "Tasks": [
                    "FULL"
                ],
                "Natural Language": [
                    "FULL"
                ],
                "Knowledge Graph": [
                    "FULL"
                ],
                "Bot Developers": [
                    "VIEW"
                ],
                "Bot Settings": [
                    "FULL"
                ],
                "Bot Import": [
                    "YES"
                ],
                "Publish bot": [
                    "YES"
                ],
                "Channels": [
                    "YES"
                ],
                "Dashboard": [
                    "YES"
                ],
                "Bot Analytics": [
                    "YES"
                ]   
            }
        },
        {
            "roleType": "bot",
            "_id": "6495a4d56ca3571b556cf165",
            "role": "Bot Tester",
            "rDesc": "Role for bot testers with read-only access to bot definition",
            "permissions": {
                "Tasks": [
                    "VIEW"
                ],
                "Natural Language": [
                    "VIEW"
                ],
                "Knowledge Graph": [
                    "VIEW"
                ],
                "Bot Developers": [
                    "VIEW"
                ],
                "Bot Settings": [
                    "NO"
                ],
                "Bot Import": [
                    "NO"
                ],
                "Publish bot": [
                    "NO"
                ],
                "Channels": [
                    "NO"
                ],
                "Dashboard": [
                    "YES"
                ],
                "Bot Analytics": [
                    "YES"
                ]
            }
        }
    ]
}
Menu