Skip to content

Commit 0c96c7c

Browse files
author
zhe
committed
Update
1 parent b29470f commit 0c96c7c

File tree

50 files changed

+3912
-665
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+3912
-665
lines changed

docs/common-workflows/administration/distribution-services/manage-subscriptions/mobile-subscriptions.md

Lines changed: 183 additions & 84 deletions
Large diffs are not rendered by default.
Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
---
2-
title: Next-Gen AI
3-
description: This page contains a summary of REST APIs for the "auto bots" endpoint. You can use REST API requests to interact with Auto Bots.
2+
title: Auto Agent APIs
3+
description: This page contains a summary of REST APIs for the "agent" endpoint. You can use REST API requests to interact with Auto Agents.
44
---
55

66
<Available since="Strategy ONE (March 2025)" />
77

8-
With the release of Strategy ONE (March 2025), we have introduced an enhanced set of APIs designed to leverage the capabilities of Next-Gen AI. These APIs are built on top of the existing question APIs and are compatible with both the Next-Gen AI and the legacy Auto Bots.
8+
Strategy One (March 2025) introduces an enhanced set of APIs designed to leverage the agent capabilities.
99

10-
The Next-Gen AI APIs provide a seamless way to interact with Next-Gen AI, allowing you to ask questions, retrieve answers, and get historical chat messages from specific bots. Additionally, the APIs offer the ability to get suggested questions, enhancing the user experience by providing relevant queries and answers efficiently.
10+
The Auto Agent APIs provide a seamless way to interact with agents, allowing you to ask questions, retrieve answers, and get historical chat messages from agents. Additionally, the APIs offer the ability to get suggested questions, enhancing the user experience by providing relevant queries and answers efficiently.
1111

12-
Starting from Strategy ONE (June 2025), we've added support for retrieving images within answers, allowing for richer, more visual responses from the Next-Gen AI system. This feature includes customizable resolution settings to optimize image quality based on your specific needs.
12+
Strategy One (June 2025) adds support for retrieving images within answers, allowing for richer, more visual responses from the Auto Agent system. This feature includes customizable resolution settings to optimize image quality based on your specific needs.
13+
14+
If you do not specify an Agent in your API requests, the system will automatically route your questions to the most appropriate Agent based on the context of your query. This intelligent routing ensures that users receive the most relevant responses without needing to manually select an Agent.
1315

1416
### Key Features
1517

16-
- **Ask a question to a specific bot**: Submit a question to the specific Auto Bot. This API has been enhanced from the existing question API.
17-
- **Get answer by the question ID**: Retrieve the answer to a specific question using its ID. This API has been enhanced from the existing question API.
18-
- **Get chat history from a specific bot**: Obtain all historical chat messages from a specific bot.
19-
- **Get suggested questions from a specific bot**: Get recommended questions based on the context from a specific bot.
20-
- **Image support in answers**: Request and retrieve images as part of answers from Next-Gen AI, with customizable resolution settings. (Available from Strategy ONE (June 2025))
21-
- **Get attributes and metrics from a specific bot**: Fetch the column information (attributes and metrics) from a specific bot, which can be used for auto-complete functionality in user inputs. (Available from Strategy ONE (July 2025))
18+
- **Ask a question to the agent**: Submit a question to the agent. This API has been enhanced from the existing question API.
19+
- **Get answer by the question ID**: Retrieve the answer to a question using its ID. This API has been enhanced from the existing question API.
20+
- **Get chat history from the agent**: Obtain all historical chat messages from the agent.
21+
- **Get suggested questions from the agent**: Get recommended questions based on the context from the agent.
22+
- **Image support in answers**: Request and retrieve images as part of answers from agents, with customizable resolution settings. (Available from Strategy One (June 2025))
23+
- **Get attributes and metrics from the agent**: Fetch the column information (attributes and metrics) from the agent, which can be used for auto-complete functionality in user inputs. (Available from Strategy ONE (July 2025))
2224

2325
For further details on how to use these APIs, please refer to the following sections of this manual:
2426

25-
- [Ask a question to a specific bot](./post-question.md)
27+
- [Ask a question to the agent](./post-question.md)
2628
- [Get answer by the question ID](./get-question-by-id.md)
27-
- [Get chat history from a specific bot](./get-questions-by-bot.md)
28-
- [Get suggested questions from a specific bot](./post-suggestion.md)
29+
- [Get chat history from the agent](./get-questions-by-bot.md)
30+
- [Get suggested questions from the agent](./post-suggestion.md)
2931
- [Get image from an answer](./get-image-of-answer.md)
30-
- [Get attributes and metrics from a specific bot](./get-columns.md)
32+
- [Get attributes and metrics from the agent](./get-columns.md)

docs/common-workflows/analytics/auto-bot-api/get-columns.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
---
2-
title: Get attributes forms and metrics from a specific bot
3-
description: This page describes how to fetch the column information (attributes and metrics) from a specific bot.
2+
title: Get attributes forms and metrics from a specific agent
3+
description: This page describes how to fetch the column information (attributes and metrics) from a specific agent.
44
---
55

66
<Available since="Strategy ONE (July 2025)" />
77

8-
This API is used to get the column information (attributes forms and metrics) from a specific bot. This information is essential for understanding what data elements the bot can access and use in its answers. The column information can be used to provide auto-complete functionality for user inputs, helping users formulate more accurate questions by suggesting relevant data elements as they type.
8+
This API is used to get column information (attributes forms and metrics) from a specific agent. This information is essential to understand what data elements the agent can access and use in its answers. The column information can be used to provide auto-complete functionality for user inputs, helping users formulate more accurate questions by suggesting relevant data elements as they type.
99

1010
:::info
1111

1212
Obtain the authorization token needed to execute the request using [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin).
1313

1414
:::
1515

16-
## Get attributes forms and metrics from a specific bot
16+
## Get attributes forms and metrics from a specific agent
1717

1818
Endpoint: [GET /api/v2/bots/\{botId}/columns](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Next-Gen%20AI/getBotColumns)
1919

2020
Request Parameters:
2121

2222
| Name | Located in | Description | Required | Type |
2323
| ---------------- | ---------- | -------------------- | -------- | ------ |
24-
| botId | path | ID of the bot | Yes | string |
24+
| botId | path | ID of the agent | Yes | string |
2525
| X-MSTR-AuthToken | header | Authentication token | Yes | string |
2626
| X-MSTR-ProjectID | header | Project ID | Yes | string |
2727

@@ -46,21 +46,21 @@ Sample Response:
4646

4747
Notes:
4848

49-
- This API is useful for understanding the data elements that a bot has access to.
50-
- Column information is essential for developers who want to build integrations that utilize specific data from bots.
49+
- This API is useful for understanding the data elements that a agent has access to.
50+
- Column information is essential for developers who want to build integrations that utilize specific data from agents.
5151

5252
## Use Cases
5353

5454
Auto-Complete Functionality:
5555

5656
One of the main purposes of this API is to enable auto-complete functionality for user input:
5757

58-
1. When a user starts typing a question to the bot, your application can retrieve column information to suggest relevant attributes and metrics.
58+
1. When a user starts typing a question to the agent, your application can retrieve column information to suggest relevant attributes and metrics.
5959
1. As the user types, match their input against column names and descriptions to provide real-time suggestions.
60-
1. This improves user experience by helping users formulate better questions and increases the accuracy of bot responses by ensuring users reference valid data elements.
60+
1. This improves user experience by helping users formulate better questions and increases the accuracy of agent responses by ensuring users reference valid data elements.
6161

6262
Example implementation:
6363

64-
- Cache the column information at application startup or when a bot is selected
64+
- Cache the column information at application startup or when an agent is selected
6565
- Implement a suggestion engine that matches partial user input against attribute and metric names
6666
- Display matching columns as suggestions, possibly with their descriptions for additional context

docs/common-workflows/analytics/auto-bot-api/get-image-of-answer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Get an image in the answer of a specific question
44
description: This workflow sample demonstrates how to get an image in the answer of a specific question.
55
---
66

7-
<Available since="Strategy ONE (June 2024)" />
7+
<Available since="Strategy ONE (June 2025)" />
88

99
This workflow sample demonstrates how to get an image in the answer of a specific question.
1010

@@ -14,7 +14,7 @@ Obtain the authorization token needed to execute the request using [POST /api/au
1414

1515
:::
1616

17-
## Get an image of an answer related to a question with bot routing
17+
## Get an image of an answer
1818

1919
Endpoint: [GET /api/questions/\{questionsId}/answers/images/\{imageId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Next-Gen%20AI/getMessageImage)
2020

docs/common-workflows/analytics/auto-bot-api/get-question-by-id.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ curl 'https://demo.microstrategy.com/MicroStrategyLibrary/api/questions/91613866
3535

3636
Sample Response Code:
3737

38-
| Response Code | Status |
39-
| ------------- | ------------------------------------------------------------------------------ |
40-
| 200 | Successfully returned the question from the bot that has been answered |
41-
| 202 | Successfully returned the question from the bot which is still being processed |
42-
| 400 | Error in getting the question from the bot |
43-
| 401 | Authorization failed |
44-
| 404 | Question does not exist |
38+
| Response Code | Status |
39+
| ------------- | --------------------------------------------------------------------------------- |
40+
| 200 | Successfully returned the answered question from the agent |
41+
| 202 | Successfully returned the question from the agent, which is still being processed |
42+
| 400 | Error getting the question from the agent |
43+
| 401 | Authorization failed |
44+
| 404 | Question does not exist |
4545

4646
## Response Body on Success
4747

docs/common-workflows/analytics/auto-bot-api/get-questions-by-bot.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
sidebar_label: Get chat history from a specific bot
3-
title: Get chat history from a specific bot
4-
description: This workflow sample demonstrates how to get the historical chat messages from a specific bot.
2+
sidebar_label: Get chat history from a specific agent
3+
title: Get chat history from a specific agent
4+
description: This workflow sample demonstrates how to get the historical chat messages from a specific agent.
55
---
66

77
<Available since="Strategy ONE (March 2025)" />
88

9-
This API is used to get the historical questions from a specific bot for the current user, which can be used as the `history` parameter in the `Ask a question to a specific bot` API.
9+
This API is used to get the historical questions from a specific agent for the current user, which can be used as the `history` parameter in the `Ask a question to a specific agent` API.
1010

1111
:::info
1212

1313
Obtain the authorization token needed to execute the request using [POST /api/auth/login](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Authentication/postLogin).
1414

1515
:::
1616

17-
## Get Questions by Bot
17+
## Get Questions by Agent
1818

1919
Endpoint: [GET /api/questions/](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Next-Gen%20AI/getChats_1)
2020

@@ -28,9 +28,9 @@ Sample Request Headers:
2828

2929
Sample Request Query Strings:
3030

31-
| Query String | Required | Description | Sample Value |
32-
| ------------ | -------- | ---------------------------------------------------------- | -------------------------------- |
33-
| botId | Yes | The ID of the bot whose chat history you want to retrieve. | 065B007500614D158B41B0D020C96966 |
31+
| Query String | Required | Description | Sample Value |
32+
| ------------ | -------- | ------------------------------------------------------------ | -------------------------------- |
33+
| botId | Yes | The ID of the agent whose chat history you want to retrieve. | 065B007500614D158B41B0D020C96966 |
3434

3535
Sample Curl:
3636

@@ -43,16 +43,16 @@ curl 'https://demo.microstrategy.com/MicroStrategyLibrary/api/questions?botId=06
4343

4444
Sample Response Code:
4545

46-
| Response Code | Status |
47-
| ------------- | ------------------------------------------------ |
48-
| 200 | Successfully returned the questions from the bot |
49-
| 400 | Error in getting the questions from the bot |
50-
| 401 | Authorization failed |
51-
| 404 | Bot does not exist |
46+
| Response Code | Status |
47+
| ------------- | -------------------------------------------------- |
48+
| 200 | Successfully returned the questions from the agent |
49+
| 400 | Error getting questions from the agent |
50+
| 401 | Authorization failed |
51+
| 404 | Agent does not exist |
5252

5353
## Response Body on Success
5454

55-
The response is a list of questions and answers from the specific bot.
55+
The response is a list of questions and answers from the specific agent.
5656

5757
### Sample Response
5858

0 commit comments

Comments
 (0)