All APIs have rate limits. If the rate limit is exceeded, an API call fails with an error
Rate limit for this API has been reached. Please try again after some time.Bot Definition APIs
| API | Description | Platform Scope | Admin Console Scope |
|---|---|---|---|
| Upload File | Upload botdefinition, botconfig, and botfunction files, as well as the bot icon. Returns file ID used in Import Bot API. Also used for ML Utterances Import, bot roles, admin roles for Import Roles, Import Batch Test Suite, and Extraction from file or URL. | NA | Bot Definition > Bot Import |
| Import Bot as a New Bot | Create a new agent using File IDs generated when uploading files. | NA | Bot Definition > Bot Import |
| Import Bot into an Existing Bot | Import the bot definition file into an existing agent for upgrading or restoring to an earlier version. | NA | Bot Definition > Bot Import |
| Bot Import Status | Get the status of the bot import request. | NA | Bot Definition > Bot Import |
| Install Sample Bot | Install a sample agent. | NA | Bot Definition > Bot Create |
| Bot Export | Export a bot definition and all associated components. | Bot Export | Bot Definition > Bot Export |
| Bot Export - Status | Get the status of the Bot Export request and the download link after export completes. | Bot Export | Bot Definition > Bot Export |
| Enable Channel | Enable or update a channel for an AI Agent. | NA | Channel Management |
| Add and Enable a New Language | Add and enable a new language for an AI Agent. | Languages Configuration | API Scopes > Language Settings |
| Enable an existing Language | Enable an existing language for an AI Agent. | Languages Configuration | API Scopes > Language Settings |
| Disable an existing Language | Disable an existing language for an AI Agent. | Languages Configuration | API Scopes > Language Settings |
| Update a Language Configuration | Update the configuration of an existing language for an AI Agent. | Languages Configuration | API Scopes > Language Settings |
| Change the Default language | Change the default language of the app. | Languages Configuration | API Scopes > Language Settings |
| Proactive Notification | Send proactive notifications to the configured channel. | NA | Channel Management > Proactive Messages |
| Proactive Notification V2 | Send proactive notifications to users via IVR and Hangout channels. | NA | Channel Management > Proactive Messages |
| Proactive Notification Status | Get status of proactive notifications. | NA | Channel Management > Proactive Messages |
| Proactive Notification Status V2 | Fetch the status of a proactive notification triggered via the async webhook channel. | NA | Channel Management > Proactive Messages |
| Publish Bot | Initiate a bot publish request. | NA | Bot Publish > Publish |
| Bot Publish Status | Get the publish status of the current application or the last completed status request. | NA | Bot Publish > Publish |
| Bot Variables Import | Import global and content variables into a bot. | Import Variables | NA |
| Bot Variables Export | Export all global, content (locale), and collection variables from a bot. | Export Variables | NA |
| Batch Test Execution | Invoke the execution of a Batch Test suite. | Batch Tests Execution | NA |
| Batch Test Execution Status | Get the status of the execution against a unique Test Request Id. | Batch Tests Execution | NA |
| Get Batch Test Suites | Get the list of Batch Test Suites available. | Batch Tests Management | Batch Tests Management |
| Export Batch Test Suite | Export the test cases of a given Batch Test Suite. | Batch Tests Management | Batch Tests Management |
| Import Batch Test Suite | Import a batch test suite. | Batch Tests Management | Batch Tests Management |
| Delete Batch Test Suite | Delete a Batch Test Suite. | Batch Tests Management | Batch Tests Management |
| Delete Batch Test Suite Execution | Delete a specific execution of a Batch Test Suite. | Batch Tests Management | Batch Tests Management |
| Create (Import) a Conversation Test Suite | Create or import a Conversation Test Suite. | Conversation Tests Management | Conversation Tests Management |
| Conversation Test Suite Creation Status | Get the creation status of a Conversation Test Suite. | Conversation Tests Management | Conversation Tests Management |
| Conversation Test Suite Execution | Execute a Conversation Test Suite. | Conversation Tests Execution | Conversation Tests Execution |
| Conversation Test Suite Execution Status | Get the execution status and summary of a Conversation Test Suite. | Conversation Tests Execution | Conversation Tests Execution |
| Delete Conversation Test Suite | Delete a Conversation Test Suite. | Conversation Tests Management | Conversation Tests Management |
| Manage SDK Push Notifications | Subscribe and unsubscribe a user’s device(s) to SDK push notifications, and list all subscribed devices. | SDK Push Notifications | NA |
| Get Linked Apps | Retrieve all apps linked to a universal or parent app. | Get linked App details. | Getlinkedbotdetails |
| Delete Conversations | Delete specific conversations by conversation IDs within the defined retention period, or delete all conversations associated with a specific channel user. | Delete Conversations | NA |
NLP Training APIs
| API | Description | Platform Scope | Admin Console Scope |
|---|---|---|---|
| ML Utterances Import | Import ML Utterances into an agent. | Utterances Import | Test > Utterances Import & Train |
| ML Utterances Import Status | Get the status of the ML utterances import request. | Utterances Import | Test > Utterances Import & Train |
| ML Utterance Train | Initiate ML training of an agent. | Train ML | Test > Train ML & Train |
| ML Utterance Train Status | Get the status of the ML training. | Train ML | Test > Train ML & Train |
| ML Utterances Export | Export the ML utterances of an agent. | Utterances Export | Test > Utterances Export & Train |
| ML Utterances Export Status | Get the download link of the ML Utterances export. | Utterances Export | Test > Utterances Export & Train |
| FAQ Training | Initiate the training of the knowledge graph. | Train Faq | Test > Train FAQ & Train |
| FAQ Training Status | Get the status of the FAQ training. | Train Faq | Test > Train FAQ & Train |
| Extraction from file or URL | Extract FAQs using a file or URL. | Manage Knowledge Graph | Manage Knowledge Graph |
| Get Extractions History | Get a list of KG Extractions history. | Manage Knowledge Graph | Manage Knowledge Graph |
| Get Extraction Question | Get a list of KG Extraction Questions. | Manage Knowledge Graph | Manage Knowledge Graph |
| Get KnowledgeTasks | Get a listing of knowledge Tasks along with the nodes. | Manage Knowledge Graph | Manage Knowledge Graph |
| Add Questions from Extraction | Add specific questions from extraction to the Knowledge Graph. | Manage Knowledge Graph | Manage Knowledge Graph |
| Get FAQs | Get a list of questions and nodes under the Knowledge task. | Manage Knowledge Graph | Manage Knowledge Graph |
| Get FAQs V2 | Get a list of questions and nodes under the Knowledge task (v2). | Manage Knowledge Graph | Manage Knowledge Graph |
| Update NLP Configurations | Update the NLP thresholds and configurations. | NLP Configurations | Test > NLP Configurations & Train |
Analytics APIs
| API | Description | Platform Scope | Admin Console Scope |
|---|---|---|---|
| Find Intent | Obtain intent recognition results and scoring from NLP and ML engines. | Intent and Entity Detection | Intent Identification > Intent and Entity Detection |
| Conversation History | Fetch conversational messages between the AI Agent and user in reverse chronological order. | Chat History | Bot Analytics > Chat History |
| Conversation History-Lightweight | Fetch high-volume conversation summarization without metadata overhead. | Chat History | Bot Analytics > Chat History |
| Conversation Summary | Summarize the conversation between a user and an agent. | Conversation Summary | NA |
| Feedback Analytics | Fetch Feedback Survey Response Data and push it to the Feedback Analytics Dashboard. | Feedback Survey | Bot Analytics > Feedback Analytics |
| Debug Logs | Get debug logs of a specific conversation. | Debug Logs | NA |
| Get ChangeLogs | Get the list of changes made to the agent definition for a given date period. | Logs History | Logs > Bot Audit Logs |
| Sessions History | Retrieve the conversation sessions created. | Bot Sessions | Bot Analytics > Bot Sessions |
| Billing Sessions | Retrieve the list of individual billing sessions created for an app. | Billing Sessions | Billing > Usage > Billing Sessions |
| Billing Usage Summary | Get a summary of the billing usage for an account or bot for a given period. | Billing Sessions | Billing > Usage > Billing Sessions |
| Get Dashboard Widget Data | Get the data result of a widget from a specific Custom Dashboard. | Custom Reports | Custom Reports > Custom Reports |
| Get Analytics | Extract metrics data related to intent detection and task performance. | Metrics | NA |
| Task Execution-based Containment Report | Extract task execution details across all conversation sessions for containment types. | Metrics | NA |
| User Engagement Trend | Get the number of users who interacted with the AI Agent in a given period. | User Engagement Trend | NA |
| User Engagement Trend (v2) | Retrieve engagement metrics for a specific app including unique, new, returning, and average user counts. | User Engagement Trend | NA |
| Conversation Details and Summary | Fetch conversational details and summary between the bot and the user. | Conversation History | NA |
| LLM and Generative AI Usage Logs API | Fetch the LLM & Generative AI usage logs. | Gen AI and LLM Usage Logs | API Scopes > Gen AI and LLM Usage Logs |
| Translation Logs | Fetch translation request and response logs for a bot conversation. | Debug Logs | NA |
Admin APIs
| API | Description | Associated Bot Admin App Scope |
|---|---|---|
| Get Bots | Retrieve the list of agents available in an account. | Profile Management > Role Management |
| Import Roles | Import bot or admin roles into an account. | Profile Management > Role Management |
| Get Roles | Retrieve the list of bot or admin roles available in an account. | Profile Management > Role Management |
| Get User Roles Details | Get full information on all users and their associated roles in the account. | Profile Management > Role Management |
| Get Groups | Get the list of groups and group members available in the account. | Profile Management > Role Management |
| Export Roles | Export bot or admin roles from an account. | Profile Management > Role Management |
| Assign BT Roles | Assign a bot role to a set of users in a specific agent. | Profile Management > Role Management |
| Assign Admin Roles | Add or remove users or groups from admin roles. | Profile Management > Role Management |
| Update User Access | Add or remove the ability to access AI for Service Platform, create new AI Agents. | Profile Management > Role Management |
| Create Users | Add users to an account. | User Management |
| Get Users Information | Retrieve the user details. | User Management |
| Update User | Update user details. | User Management |
| Remove Users from Account | Remove users from an account. | User Management |
| Delete Customer Data | Delete customer data. | Profile Management > Delete Users Data |
| Delete Customer Data Status API | Get the status of the Customer Data Delete request. | Profile Management > Delete Users Data |
| Get Admin Console Audit Logs | Get admin console audit logs. | Logs Admin > Admin Console Audit Logs |
Data (Data Table) Access APIs
| API | Description | Associated App Scope |
|---|---|---|
| Insert Data | Insert data into Data Table. | Write access to the Data Table |
| Insert Bulk Data | Insert bulk data into Data Table. | Write access to the Data Table |
| Update Data | Update data in Data Table. | Read and Write access to the Data Table |
| Delete Data | Delete data from Data Table. | Read and Delete access to the Data Table |
| Get Table Data | Get data from Data Table. | Read access to the Data Table |
| Get View Data | Get data from Data View. | Read access to the Table View |