Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/add-enable-new-language.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To initiate the addition and enablement of a new language for an AI Agent.

## Sample Request

```json
```json expandable=true
curl -X POST 'https://{{host}}/api/{{version-Id}}/public/bot/{{botId}}/language' \
--header 'Content-Type: application/json' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To add specific questions to the Knowledge Graph.

## Sample Request

```json
```json expandable=true
curl --location 'https://platform.kore.ai/api/public/bot/botID/faqs/bulk?language=en' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'content-type: application/json' \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ No body parameters are passed.

When the test execution is completed:

```json
```json expandable=true
{
"_id": "tr-74d94321-35f8-5066-bdc8-a0863e7axxxx",
"streamId": "st-83a4989c-7f57-59e7-85b8-d6547a91xxxx",
Expand Down Expand Up @@ -88,7 +88,7 @@ When the test execution is completed:

When the test execution is in progress:

```json
```json expandable=true
{
"_id": "tr-beaadxxb-xxxx-xxxe-axfb-xxxxcxbexdxa",
"streamId": "st-xxxxxxxx-cxxd-xcaf-xxax-dxxxxxxffxdxb",
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/billing-session.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ curl --location --request POST 'https://{{host}}/api/public/bots/getBillingSessi

## Sample Response

```json
```json expandable=true
{
"total":5,
"moreAvailable": true,
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/billing-usage-summary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ curl --location 'https://{{HOST}}/api/public/bots/billingsessionsummary/status?t

**Monthly Billing Session Summary**

```json
```json expandable=true
{
"_id": "ds-df7dbe18-9028-59db-8d12-cda96xxxxxx",
"status": "success",
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/bot-export-status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ curl --location 'https://{{host}}/api/public/bot/{{BotID}}/export/status' \

## Sample Response

```json
```json expandable=true
{
"_id": "ber-xxxxx-xxx-xxx-xxx-xxxxx",
"botId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/bot-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This API only initiates the export process. Use the [Export Status API](/ai-for-

## Sample Request

```json
```json expandable=true
curl --location 'https://{host}/api/public/bot/{BotID}/export' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'content-type: application/json' \
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/bot-import-status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ No body parameters are passed.

## Sample Response

```json
```json expandable=true
{
"_id": "bir-5fxxxxxx-a0xx-52xx-axxf-f3xxxxxxxxxx",
"status": "success",
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/bot-publish-status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ No body parameters are passed.

## Sample Response

```json
```json expandable=true
{
"_id": "ds-4a1b3e3d-7f55-5d80-acc6-7066e5cxxxxx",
"action": "RUN",
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/bot-variables-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ curl --location --request POST 'https://{{host}}/api/1.1/public/builder/bot/{{bo

## Sample Response

```json
```json expandable=true
[
{
"key": "host_url",
Expand Down
4 changes: 2 additions & 2 deletions ai-for-service/apis/automation/bot-variables-import.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Import environment and content (locale) variables into a bot.

## Sample Request

```json
```json expandable=true
curl --location 'https://{{host}}/api/1.1/public/builder/bot/{{botId}}/variables/import' \
--header 'Content-Type: application/json' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
Expand Down Expand Up @@ -66,7 +66,7 @@ curl --location 'https://{{host}}/api/1.1/public/builder/bot/{{botId}}/variables

## Sample Request When Collections Are Enabled

```json
```json expandable=true
curl -X POST \
https://{{host}}/api/1.1/public/builder/bot/{{botId}}/variables/import \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
Expand Down
4 changes: 2 additions & 2 deletions ai-for-service/apis/automation/bulk-data-insert.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Used to insert bulk data into a Data Table.

## Sample Request

```bash
```bash expandable=true
curl -X POST 'https://{{host}}/api/public/tables/{{tableName}}/bulk' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
-H 'content-type: application/json' \
Expand Down Expand Up @@ -57,7 +57,7 @@ The maximum payload size is 50 MB. To ensure the payload is within the limit, pa

## Sample Response

```json
```json expandable=true
{
"records": [
{
Expand Down
8 changes: 4 additions & 4 deletions ai-for-service/apis/automation/change-default-language.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,20 +65,20 @@ curl --location 'https://{{host}}/api/1.1/public/bot/st-5ac72231-5a37-5b71-bb1e-

**Scenario 2**: Language not configured.

```
```text
Can't set default language. The language '{{language code}}' isn't currently configured.
Please configure the language and publish the app at least once before setting it as the default.
```

**Scenario 3**: Language already set as default.

```
```text
Permission denied. The language '{{language code}}' is already set as the default language.
```

**Scenario 4**: Language is disabled.

```
```text
Unable to change the default language. The language '{{language code}}' is currently disabled.
Please enable the language before setting it as the default.
```
Expand All @@ -94,7 +94,7 @@ Please enable the language before setting it as the default.

**Scenario 6**: Invalid language code.

```
```text
Error message: Please provide the valid language code.
```

Expand Down
6 changes: 3 additions & 3 deletions ai-for-service/apis/automation/channel-enablement.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To enable a channel for an AI Agent.

**Web/Mobile channel:**

```bash
```bash expandable=true
curl --location --request POST 'https://{{host}}/api/public/channels' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
Expand Down Expand Up @@ -64,7 +64,7 @@ curl --location --request POST 'https://{{host}}/api/public/channels' \

**WebHook channel:**

```json
```json expandable=true
curl --location --request POST 'https://{{host}}/api/public/channels' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
Expand All @@ -88,7 +88,7 @@ curl --location --request POST 'https://{{host}}/api/public/channels' \

**Slack channel:**

```json
```json expandable=true
curl --location --request POST 'https://{{host}}/api/public/channels' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ If the session ID is available, the call ID isn't mandatory and vice versa. If b

## Sample Response

```json
```json expandable=true
{
"conversationInfo": {
"userId": "u-c8c61885-85bb-xxxx-xxxx-6fd4a97c58f9",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ curl --location --request GET \

**Query by `userId`**

```bash
```bash expandable=true
curl --location 'https://{{host}}/api/public/bot/{{botId}}/messages-lite' \
--header 'accept: application/json' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
Expand Down Expand Up @@ -141,7 +141,7 @@ curl --location 'https://{{host}}/api/public/bot/{{botId}}/messages-lite' \

## Sample Response

```json
```json expandable=true
{
"total": 8,
"moreAvailable": false,
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/conversation-history.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ The duration between `dateTo` and `dateFrom` must be less than 7 days.

**GET method:**

```json
```json expandable=true
{
"total": 14,
"moreAvailable": false,
Expand Down
4 changes: 2 additions & 2 deletions ai-for-service/apis/automation/create-users.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This API requires a JWT generated by an application created only from the Admin

## Sample Request

```bash
```bash expandable=true
curl -X POST \
https://{{host}}/api/public/users \
-H 'Content-Type: application/json' \
Expand Down Expand Up @@ -111,7 +111,7 @@ curl -X POST \

**Failure:**

```json
```json expandable=true
{
"failedUserDetails": [
{
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/data-update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Used to update data in a Data Table.

## Sample Request

```bash
```bash expandable=true
curl -X PUT \
https://{{host}}/api/public/tables/{{tableName}} \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
Expand Down
4 changes: 2 additions & 2 deletions ai-for-service/apis/automation/delete-conversations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ The response includes the deleted records with the status as queued. After the j

**When a job is queued**

```json
```json expandable=true
{
"jobId": "cdj-2e5c62ad-df3a-542b-a59e-c72768xxxxx",
"status": "queued",
Expand All @@ -201,7 +201,7 @@ The response includes the deleted records with the status as queued. After the j

**When a job is completed**

```json
```json expandable=true
{
"jobId": "cdj-2e5c62ad-df3a-542b-a59e-c72768bxxxxx",
"status": "completed",
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/delete-users.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ curl -X DELETE \

**Failure:**

```json
```json expandable=true
{
"failedUserDetails": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ Disables an existing language for an AI Agent.

## Sample Response

```
```text
Disabled Spanish language successfully
```
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Configures the BotKit URL, app, and events for agent transfer.

## Sample Request

```bash
```bash expandable=true
curl -X PUT \
https://{{host}}/api/bot/{{BotID}}/sdkSubscription \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/export-roles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ curl -X GET \

## Sample Response

```json
```json expandable=true
[
{
"roleType": "admin",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ curl --location 'https://{{host}}/api/1.1/public/bot/{{botId}}/saveFeedback' \

## Sample Response

```json
```json expandable=true
{
"botId": "st-053cd130-f983-577a-8aad-2504xxxxxxxx",
"channel": "rtm",
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/find-intent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ curl -X POST \

## Sample Response

```json
```json expandable=true
{
"request": {
"input": "book a ticket",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ curl --location --request GET \

## Sample Response

```json
```json expandable=true
{
"total": 3,
"auditlogs": [
Expand Down
4 changes: 2 additions & 2 deletions ai-for-service/apis/automation/get-analytics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Retrieves metrics data related to intent detection and task performance, includi
The following sample request shows how to retrieve unhandled utterance analytics data with specific filters. You can modify the type and filters parameters to retrieve different types of analytics data as needed.


```json
```json expandable=true
curl --location --request POST 'https://{{host}}/api/public/bot/{{streamId}}/getAnalytics' \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'content-type: application/json' \
Expand Down Expand Up @@ -89,7 +89,7 @@ curl --location --request POST 'https://{{host}}/api/public/bot/{{streamId}}/get

## Sample Response

```json
```json expandable=true
{
"moreAvailable": true,
"result": [
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/get-batch-test-suites.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ No body parameters are passed.

## Sample Response

```json
```json expandable=true
{
"count": 36,
"moreAvailable": true,
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/get-bots.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ curl -X GET \

## Sample Response

```json
```json expandable=true
{
"total": 169,
"availableMore": true,
Expand Down
2 changes: 1 addition & 1 deletion ai-for-service/apis/automation/get-change-logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ curl -X GET \

## Sample Response

```json
```json expandable=true
[
{
"_id": "btl-039ca909-5dd2-59ce-a5b7-30c61a3xxxxx",
Expand Down
Loading
Loading