| METHOD | POST |
|---|---|
| Endpoint | https://{{host}}/agentai/api/v1/public/{{streamid}}/acrules/list |
| 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 |
Request Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | Integer | No | Number of records returned per page. |
page | Integer | No | Page number to retrieve. |
sortBy | String | No | Sort order for results. Supported values: asc, desc. |
Sample Request
curl --location --max-time 15 'https://{{host}}/agentai/api/v1/public/{{streamid}}/acrules/list' \
--header 'auth: {{JWT_TOKEN}}' \
--header 'accountid: {{accountId}}' \
--header 'Content-Type: application/json' \
--data '{
"limit": 20,
"page": 1,
"sortBy": "asc"
}'
Sample Response
{
"results": [
{
"_id": "acr-30ca1bc3-7383-5175**********cff3325f",
"name": "Churn risk",
"description": "",
"tags": [],
"channels": [
"voice",
"chat"
],
"isActive": false,
"default": false,
"deletable": true,
"lModOn": "2026-07-17T11:24:04.338Z"
}
],
"skip": 0,
"limit": 20,
"hasMore": true,
"totalPages": 3,
"totalResults": 44,
"allowPublish": true
}
Response Parameters
| Field | Type | Description |
|---|---|---|
_id | String | Unique identifier of the assessment category. |
name | String | Name of the assessment category. |
description | String | Description of the assessment category. Returns an empty string if no description is defined. |
tags | Array | List of tags associated with the assessment category. |
channels | Array | Channels for which the assessment category is applicable. Possible values include voice and chat. |
isActive | Boolean | Indicates whether the assessment category is currently active. |
default | Boolean | Indicates whether the assessment category is configured as the default category. |
deletable | Boolean | Indicates whether the assessment category can be deleted. |
lModOn | String (ISO 8601 Date-Time) | Date and time when the assessment category was last modified. |
skip | Integer | Number of records skipped before returning the current result set. Used for pagination. |
limit | Integer | Maximum number of records returned in a single response. |
hasMore | Boolean | Indicates whether additional records are available beyond the current page. |
totalPages | Integer | Total number of pages available based on the current page size. |
totalResults | Integer | Total number of assessment categories that match the request criteria. |
allowPublish | Boolean | Indicates whether publishing operations are permitted for the current user or account. |