API Guide

To execute and get results for managing an account’s SSO configurations with the following APIs: Fetch the SSO Meta API Enable SSO API Disable SSO API Update the SSO Configuration API Note: The APIs support SAML, WSFED, and OpenID Connect protocols. Fetch the SSO Meta API If SSO is enabled,…

For managing the SDK push notifications, the platform provides the following APIs: Device Subscription API Subscribed User Devices API Device Unsubscription API Note: To receive push notifications, each user’s device must be registered and subscribed via the mobile or WebSDK app. Device Subscription API This API manages SDK push message…

This API provides a summary of the billing usage specific to an account or bot for a given period. Method POST and GET Endpoint POST For Bot Builder: https://{{host}}/api/public/bot/{{BotID}}/billingsessionsummary For BAC: https://{{host}}/api/public/billingsessionsummary  Important: First, use the POST method to set filters, then use the following GET method to retrieve the…

This task-wise Containment Report offers a comparative analysis of the impact of task executions on overall containment. It breaks down task-wise successes and failures by containment type, including Drop-off, Self-service, and Agent Hand-off, providing a detailed overview for better understanding and decision-making. Method POST and GET Endpoint It’s a combination…

This API lets you get the LLM & Generative AI Usage Logs for both Co-Pilot and Dynamic Conversation features. Method POST End Point https://{{host}}/api/1.1/public/bot/{{botId}}/getLLMUsageLogs Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Fetch Gen AI and LLM Usage Logs Admin Console:…

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 prevent a single user or service from consuming disproportionate resources that could degrade the service for others. Requests are monitored against both 60-second and…

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…

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…

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. Important: Testers can’t run conversation test suites…

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…