| METHOD | GET |
|---|---|
| Endpoint | https://{{host}}/agentai/api/v1/public/{{streamid}}/acrules/{{ruleId}} |
| Content Type | application/json |
| Authorization | auth: {{JWT}} — See How to generate the JWT Token. |
Header Parameters
| Header | Type | Required | Description |
|---|---|---|---|
auth | String | Yes | JWT token used for authentication. |
accountid | String | Yes | Unique account identifier. |
Path Parameters
| Parameter | Description | Type |
|---|---|---|
host | Environment URL. For example, https://platform.kore.ai/ | String, required |
streamId | botId or streamId. Retrieve this from the App Settings page. | string, required |
ruleId | Unique identifier of the coaching rule to retrieve. | String, required |
Sample Request
curl --location --max-time 15 'https://{{host}}/agentai/api/v1/public/{{streamid}}/acrules/{{ruleId}}' \
--header 'auth: {{JWT_TOKEN}}' \
--header 'accountid: {{accountId}}' \
--header 'Content-Type: application/json' \
--data ''
Sample Response
[
{
"_id": "acr-847841ab-92ed-5d*********6a2465090",
"name": "",
"description": "",
"tags": [
"insurance",
"security",
"compliance",
"PII"
],
"channels": [
"chat",
"voice"
],
"isActive": true,
"botId": "st-6165d5c2-171a-54cc-ba5f-48*********e",
"accountId": "6a5a0e195*********34415e",
"createdOn": "2026-08-06T04:45:23.582Z",
"triggers": [
{
"_id": "aat-614678e4-9b4f-5b3a-************68cd8",
"type": "utterance",
"by": "agent",
"when": {
"utteranceCount": 2
},
"frequency": {
"nOccurrences": 1,
"duration": "anyTime"
},
"operator": "and",
"conditions": {
"value": []
},
"default": false
},
{
"_id": "aat-efb90370-3509************553053",
"type": "genai",
"by": "agent",
"frequency": {
"nOccurrences": 1,
"duration": "anyTime"
},
"operator": "and",
"conditions": {
"value": []
},
"default": false,
"triggerDesc": ""
}
],
"actions": [
{
"_id": "aat-65af99a0-f5eb************52ee986",
"type": "hint",
"expression": "critical",
"message": {
"title": "",
"body": "",
"titleDesc": "",
"bodyDesc": "",
"useGenAIForTitle": false,
"useGenAIForBody": false,
"postAction": "auto_close",
"time": 5
},
"emails": [],
"adherence": {
"adType": "ack",
"ackText": "Ok, Got it"
},
"default": false
},
{
"_id": "aat-7b62a************a040df87b94",
"type": "email_manager",
"message": {
"title": "",
"body": ""
},
"emails": [
"john.doe@example.com"
],
"when": "immediately",
"default": false
}
],
"assignees": [],
"status": "ACTIVE",
"state": "configured",
"default": false,
"deletable": true,
"refId": "c966171-d************1c4715c",
"lModOn": "2026-08-06T08:08:49.709Z",
"__v": 0,
"parentId": "acr-2535*********ac01-5c33086b2d88"
}
]
Response Parameters
| Parameter | Type | Description |
|---|---|---|
_id | String | Unique identifier of the alert configuration rule. |
name | String | Name of the alert configuration rule. |
description | String | Description of the alert configuration rule. |
tags | Array | List of tags associated with the rule. |
channels | Array | Channels on which the rule is applicable, such as chat or voice. |
isActive | Boolean | Indicates whether the rule is currently active. |
botId | String | Unique identifier of the bot associated with the rule. |
accountId | String | Unique identifier of the account that owns the rule. |
createdOn | String (ISO 8601) | Date and time when the rule was created. |
triggers | Array | List of trigger conditions that activate the rule. |
type | String | Type of trigger or action. |
by | String | Entity that generates the trigger, such as agent. |
when | String | Defines when a trigger is evaluated or when an action is executed. |
utteranceCount | Integer | Number of utterances after which the trigger is evaluated. |
frequency | Object | Defines how frequently a trigger can occur. |
nOccurrences | Integer | Maximum number of times the trigger can occur within the specified duration. |
duration | String | Time period during which occurrences are tracked. |
operator | String | Logical operator used to evaluate trigger conditions. |
conditions | Object | Collection of conditions associated with the trigger. |
value | Array | List of values used to evaluate the trigger conditions. |
triggerDesc | String | Description of the trigger. |
actions | Array | List of actions executed when the trigger conditions are met. |
expression | String | Expression used to evaluate or categorize the action. |
message | Object | Message configuration associated with the action. |
title | String | Title displayed for the action message. |
body | String | Content displayed for the action message. |
titleDesc | String | Description or prompt used for generating the title. |
bodyDesc | String | Description or prompt used for generating the message body. |
useGenAIForTitle | Boolean | Indicates whether GenAI is used to generate the message title. |
useGenAIForBody | Boolean | Indicates whether GenAI is used to generate the message body. |
postAction | String | Action performed after the message is displayed. |
time | Integer | Duration, in seconds, for which the message remains visible. |
emails | Array | List of email addresses used for email-based actions. |
adherence | Object | Adherence configuration for the action. |
adType | String | Type of adherence acknowledgement required. |
ackText | String | Acknowledgement text displayed to the user. |
assignees | Array | List of assignees associated with the rule. |
status | String | Current status of the rule. |
state | String | Configuration state of the rule. |
default | Boolean | Indicates whether the rule, trigger, or action is a system-defined default. |
deletable | Boolean | Indicates whether the rule can be deleted. |
refId | String | Reference identifier associated with the rule. |
lModOn | String (ISO 8601) | Date and time when the rule was last modified. |
__v | Integer | Internal version number of the document. |
parentId | String | Identifier of the parent rule from which the current rule was derived. |