API Guide

Rate Limits

The Platform enforces rolling rate limits to restrict the number of API requests a user, application, or service can make within a dynamic timeframe. It helps to prevent any single user or service from consuming disproportionate resources that could degrade the service for others.  The requests are checked against both…

Import Bot Functions API

This API allows you to import bot functions from a specified file. Method POST Endpoint https://{{host}}/api/public/bot/botId/import/botfunctions Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console: Bot Definition > Bot Import Query Parameters Parameter Required Description host Required The…

Get the Execution Status and Summary of a Test Suite API

To get the status of the Conversation Test Suite Execution request against a unique testSuiteId if the request is in progress, and provide the download link for the results file after the test execution is complete. Method GET Endpoint https://{{host}}/api/public/stream/:streamId/conversation/testsuite/:testSuiteName/:testRunId/status Content Type application/json Authorization auth: {{JWT}} See How to generate…

Execute a Test Suite API

To execute Conversation Test Suites and get results. This API only initiates the test process and returns the execution status and testRunId to track the execution status. Please look at the Conversation Test Suite Execution Status API for the results of the test. Method POST Endpoint https://{{host}}/api/public/stream/:streamId/conversation/testsuite/:testSuiteName/run Content Type application/json…

Delete a Test Suite API

To delete an existing conversation test suite. Method DELETE Endpoint https://{{host}}/api/public/stream/:streamId/conversation/testsuite Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Conversation Tests Management Admin Console: Conversation Tests Management Query Parameters Parameter Description Mandate host Environment URL. For example,https://bots.kore.ai Required StreamID The  Stream…

Create (Import) a Test Suite API

To create a conversation test suite by importing the test cases from a given file. This API returns dsId, the ID to check the import status. Method POST Endpoint https://{{host}}/api/public/stream/:streamId/conversation/testsuite/import Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Conversation Tests Management…

Get the Creation Status of a Test Suite API

To get the creation/import request status of the Conversation Test Suite against a unique Import ID and provide the download link for the results file after the test execution is complete. Please refer to Create (Import) a Test Suite API  to learn more. Method GET Endpoint https://{{host}}/api/public/stream/:streamId/conversation/testsuite/import/:dsId/status Content Type application/json…

Conversation Details and Summary API

To fetch the conversational details and conversation summary data between the bot and the user. This API supports pagination. You can specify skip and limit parameters to retrieve a certain number of messages at a time. Method POST Endpoint https://{{host}}/api/public/bot/{{botId}}/conversationDetails Content Type application/json Authorization auth: {{JWT}} API Scope Bot Builder:…

Conversation Summary API (Beta)

The API summarizes the conversation between a user and an agent. The agent can be a virtual agent or a human agent. The API accepts the conversation Id or the transcripts as input and provides an auto-generated conversation summary. The API uses a fine-tuned Flan-T5 model, an open-source LLM hosted…

Language Updation API

To update for an existing language’s configuration for a virtual assistant.   Method PUT Endpoint https://{{host}}/api/{{version-Id}}/public/bot/{{botId}}/language Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Language Configuration Admin Console: Language Settings > Language Management   Path Parameters Parameter Description Mandate host The…
Menu