Skip to content
Open
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ In the example above, the project status of `"MicroStrategy Tutorial"` was chang

## Update status for a specific project on all cluster nodes

<Available since="Strategy ONE (June 2025)" />
<Available since="Strategy (June 2025)" />

Endpoint: [PATCH /api/monitors/projects/status](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Monitors/updateProjectStatusOnAllNodes)

Expand Down Expand Up @@ -346,7 +346,7 @@ This API will accept the request and start processing to execute based on the re

## Get status for a specific project on all cluster nodes

<Available since="Strategy ONE (June 2025)" />
<Available since="Strategy (June 2025)" />

Endpoint: [GET /api/monitors/projects/status](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Monitors/getProjectStatusOnAllNodes)

Expand Down Expand Up @@ -413,7 +413,7 @@ By default, the endpoint will delete a project only if the project has unloaded

The project status can be changed using the `PATCH /api/monitors/iServer/nodes/{nodeName}/projects/{projectId}` endpoint. The client can delete the project if it is administrator or owner of the project.

<Available since="Strategy ONE (June 2025)" />
<Available since="Strategy (June 2025)" />

You can provide a `deleteSessions` query parameter which will help to automatically close all active sessions across all the clustered nodes and then delete the project. The exemplary call is listed below:

Expand Down
10 changes: 5 additions & 5 deletions docs/common-workflows/analytics/auto-bot-api/auto-bot-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ title: Auto Agent APIs
description: This page contains a summary of REST APIs for the "agent" endpoint. You can use REST API requests to interact with Auto Agents.
---

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

Strategy One (March 2025) introduces an enhanced set of APIs designed to leverage the agent capabilities.
Strategy (March 2025) introduces an enhanced set of APIs designed to leverage the agent capabilities.

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.

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.
Strategy (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.

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.

Expand All @@ -19,8 +19,8 @@ If you do not specify an Agent in your API requests, the system will automatical
- **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.
- **Get chat history from the agent**: Obtain all historical chat messages from the agent.
- **Get suggested questions from the agent**: Get recommended questions based on the context from the agent.
- **Image support in answers**: Request and retrieve images as part of answers from agents, with customizable resolution settings. (Available from Strategy One (June 2025))
- **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))
- **Image support in answers**: Request and retrieve images as part of answers from agents, with customizable resolution settings. (Available from Strategy (June 2025))
- **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 (July 2025))

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Get attributes forms and metrics from a specific agent
description: This page describes how to fetch the column information (attributes and metrics) from a specific agent.
---

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

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Get an image in the answer of a specific question
description: This workflow sample demonstrates how to get an image in the answer of a specific question.
---

<Available since="Strategy ONE (June 2025)" />
<Available since="Strategy (June 2025)" />

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Get answer by the question ID
description: This workflow sample demonstrates how to get a question's answer by the question ID.
---

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

This workflow sample demonstrates how to get a question's answer by the question ID.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Get chat history from a specific agent
description: This workflow sample demonstrates how to get the historical chat messages from a specific agent.
---

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

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Ask the agent a question
description: Submit a question to the agent and receive a question ID.
---

<Available since="Strategy ONE (June 2025)" />
<Available since="Strategy (June 2025)" />

Use this API to submit a question to the agent and receive an question ID.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Get suggested questions from the agent
description: This workflow sample demonstrates how to get suggested questions from the agent.
---

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

This workflow sample demonstrates how to get suggested questions from the agent.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Create unstructured data
description: This page describes how to create unstructured data by uploading a file to a specific folder.
---

<Available since="Strategy ONE (April 2026)" />
<Available since="Strategy (April 2026)" />

Use this API to create unstructured data by uploading a file. When you add a new knowledge source for agents, call this endpoint to upload the file and create an unstructured data item that can be indexed and used to answer questions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Get categories for an unstructured data
description: This page explains how to retrieve categories (tags) for a specific unstructured data item that helps agents better understand and use the data.
---

<Available since="Strategy ONE (March 2026)" />
<Available since="Strategy (March 2026)" />

This API is used to retrieve the categories for unstructured data. Categories are tags that describe the data within the unstructured data, helping agents better understand the context and content of the data source. By retrieving the categories, you can see which descriptive tags have been assigned to the data and use this information to understand how agents will interpret and utilize the data source when answering questions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: Unstructured Data APIs
description: This page contains a summary of REST APIs for managing unstructured data. You can use REST API requests to update and configure unstructured data that agents use to answer questions.
---

<Available since="Strategy ONE (March 2026)" />
<Available since="Strategy (March 2026)" />

Strategy ONE (March 2026) introduces a set of public APIs designed to manage unstructured data that power agent capabilities.
Strategy (March 2026) introduces a set of public APIs designed to manage unstructured data that power agent capabilities.

The Unstructured Data APIs provide comprehensive control over unstructured data, allowing you to update data content, manage categories (tags) that describe the data, and retrieve category information. Unstructured data serves as knowledge sources that agents use to provide contextual and accurate answers to user questions. Categories are descriptive tags that help agents understand the nature and content of each data source, enabling them to provide more relevant and accurate responses. These APIs enable you to keep your data up-to-date and well-described, ensuring optimal agent performance.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Update categories for an unstructured data
description: This page explains how to retrieve categories (tags) for a specific unstructured data item that helps agents better understand and use the data.
---

<Available since="Strategy ONE (March 2026)" />
<Available since="Strategy (March 2026)" />

This API is used to update the categories for unstructured data. Categories are tags that describe the data within the unstructured data, helping agents better understand the context and content of the data source. By assigning appropriate categories (tags), you enable agents to provide more accurate and contextually relevant answers to user questions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Update unstructured data
description: This page describes how to update unstructured data by re-uploading a file to a specific unstructured data.
---

<Available since="Strategy ONE (March 2026)" />
<Available since="Strategy (March 2026)" />

This API is used to update unstructured data by re-uploading a file. When you need to refresh or replace the content of existing unstructured data, this endpoint allows you to upload a new file that will replace the existing data. The unstructured data's metadata and configuration are preserved while the underlying data source is updated.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: Ask the bot instance a question
description: This workflow sample demonstrates how to ask the bot instance a question.
---

<Deprecated since="Strategy ONE (September 2025)" />
<Deprecated since="Strategy (September 2025)" />

:::caution

The API has been **deprecated** and will be completely unavailable in the near future.

This deprecation is due to the introduction of our new **Auto Agent** technology, which replaces the legacy Auto Bot system. Legacy Auto Bot support will be gradually discontinued after **Strategy One (September 2025)**.
This deprecation is due to the introduction of our new **Auto Agent** technology, which replaces the legacy Auto Bot system. Legacy Auto Bot support will be gradually discontinued after **Strategy (September 2025)**.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: Ask a bot instance for suggested questions
description: This workflow sample demonstrates how to ask a bot instance for suggested questions
---

<Deprecated since="Strategy ONE (September 2025)" />
<Deprecated since="Strategy (September 2025)" />

:::caution

The API has been **deprecated** and will be completely unavailable in the near future.

The API is deprecated due to the introduction of Strategy's new **Auto Agent** technology, which replaces the legacy Auto Bot system. Legacy Auto Bot support will be gradually discontinued after **Strategy One (September 2025)**.
The API is deprecated due to the introduction of Strategy's new **Auto Agent** technology, which replaces the legacy Auto Bot system. Legacy Auto Bot support will be gradually discontinued after **Strategy (September 2025)**.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: Create a bot instance
description: This workflow sample demonstrates how to create a bot instance
---

<Deprecated since="Strategy ONE (September 2025)" />
<Deprecated since="Strategy (September 2025)" />

:::caution

The API has been **deprecated** and will be completely unavailable in the near future.

The API is deprecated due to the introduction of Strategy's new **Auto Agent** technology, which replaces the legacy Auto Bot system. Legacy Auto Bot support will be gradually discontinued after **Strategy One (September 2025)**.
The API is deprecated due to the introduction of Strategy's new **Auto Agent** technology, which replaces the legacy Auto Bot system. Legacy Auto Bot support will be gradually discontinued after **Strategy (September 2025)**.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: Delete a bot instance
description: This workflow sample demonstrates how to delete a bot instance
---

<Deprecated since="Strategy ONE (September 2025)" />
<Deprecated since="Strategy (September 2025)" />

:::caution

The API has been **deprecated** and will be completely unavailable in the near future.

The API is deprecated due to the introduction of Strategy's new **Auto Agent** technology, which replaces the legacy Auto Bot system. Legacy Auto Bot support will be gradually discontinued after **Strategy One (September 2025)**.
The API is deprecated due to the introduction of Strategy's new **Auto Agent** technology, which replaces the legacy Auto Bot system. Legacy Auto Bot support will be gradually discontinued after **Strategy (September 2025)**.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Get a bot's question
description: This workflow sample demonstrates how to get a chat bot's question.
---

<Available since="Strategy ONE (March 2024)" />
<Available since="Strategy (March 2024)" />

This workflow sample demonstrates how to get a chat bot's question.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Get a chat bot's configuration
description: This workflow sample demonstrates how to get a chat bot's configuration.
---

<Available since="Strategy ONE (March 2024)" />
<Available since="Strategy (March 2024)" />

This workflow sample demonstrates how to get a chat bot's configuration.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Get a bot's question list
description: This workflow sample demonstrates how to get a chat bot's question list.
---

<Available since="Strategy ONE (March 2024)" />
<Available since="Strategy (March 2024)" />

This workflow sample demonstrates how to get a chat bot's question list.

Expand Down
4 changes: 2 additions & 2 deletions docs/common-workflows/analytics/use-bot-api/use-bot-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Bot APIs
description: This page contains a summary of REST APIs for the "bots" endpoint. You can use REST API requests to consume the chat bots.
---

<Available since="Strategy ONE (March 2024)" />
<Available since="Strategy (March 2024)" />

:::caution
The following Bot APIs have been **deprecated** and will be completely unavailable in the near future.
Expand All @@ -13,7 +13,7 @@ The following Bot APIs have been **deprecated** and will be completely unavailab
- [Ask a bot question](./ask-bot-instance-question.md)
- [Delete a bot instance](./delete-a-bot-instance.md)

The API is deprecated due to the introduction of Strategy's new **Auto Agent** technology, which replaces the legacy Auto Bot system. Legacy Auto Bot support will be gradually discontinued after **Strategy One (September 2025)**.
The API is deprecated due to the introduction of Strategy's new **Auto Agent** technology, which replaces the legacy Auto Bot system. Legacy Auto Bot support will be gradually discontinued after **Strategy (September 2025)**.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Create a scope filter object
description: This workflow sample demonstrates how to create a new scope filter object using the Modeling service.
---

<Available since="Strategy ONE (November 2025)" />
<Available since="Strategy (November 2025)" />

:::tip

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Manage scope filter objects
description: You can use REST API requests to retrieve, create, and update scope filter objects using the Modeling service.
---

<Available since="Strategy ONE (November 2025)" />
<Available since="Strategy (November 2025)" />

:::tip

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Retrieve a scope filter's definition within a changeset
description: This workflow sample demonstrates how to retrieve a scope filter's definition within a changeset.
---

<Available since="Strategy ONE (November 2025)" />
<Available since="Strategy (November 2025)" />

:::tip

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Retrieve a scope filter's definition
description: This workflow sample demonstrates how to retrieve a scope filter's definition.
---

<Available since="Strategy ONE (November 2025)" />
<Available since="Strategy (November 2025)" />

:::tip

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Update a scope filter's definition
description: This workflow sample demonstrates how to update a scope filter's definition using the Modeling service.
---

<Available since="Strategy ONE (November 2025)" />
<Available since="Strategy (November 2025)" />

:::tip

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Manage the system hierarchy
description: You can use REST API requests to manage the system hierarchy.
---

<Available since="Strategy ONE (November 2025)" />
<Available since="Strategy (November 2025)" />

:::tip

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Retrieve all relationships stored in the system hierarchy
description: This workflow demonstrates how to retrieve all the relationships stored in the system hierarchy using REST API.
---

<Available since="Strategy ONE (November 2025)" />
<Available since="Strategy (November 2025)" />

This workflow sample demonstrates how to retrieve all relationships stored in the system hierarchy using the REST API with and without a changeset.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Create a data model from scratch
description: This workflow demonstrates how to create a data model from scratch using the REST API.
---

<Available since="Strategy ONE (October 2025)" />
<Available since="Strategy (October 2025)" />

This workflow sample demonstrates how to create a data model from scratch using the REST API.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Edit an existing data model
description: This workflow demonstrates how to edit an existing data model using the REST API.
---

<Available since="Strategy ONE (October 2025)" />
<Available since="Strategy (October 2025)" />

This workflow sample demonstrates how to edit an existing data model using the REST API.

Expand Down
2 changes: 1 addition & 1 deletion docs/common-workflows/mosaic/end-to-end/end-to-end.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Data model end-to-end management
description: Use REST APIs to manage data models from end to end.
---

<Available since="Strategy ONE (October 2025)" />
<Available since="Strategy (October 2025)" />

:::tip

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Create a data model attribute
description: This workflow sample demonstrates how to create a data model attribute through the Modeling service.
---

<Available since="Strategy ONE (October 2025)" />
<Available since="Strategy (October 2025)" />

:::tip

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Create and update smart attributes
description: This workflow demonstrates how to create and update smart attributes using REST API.
---

<Available since="Strategy ONE (October 2025)" />
<Available since="Strategy (October 2025)" />

This workflow sample demonstrates how to create and update smart attributes using the REST API.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Delete a data model attribute
description: This workflow sample demonstrates how to delete a data model attribute through the Modeling service.
---

<Available since="Strategy ONE (October 2025)" />
<Available since="Strategy (October 2025)" />

:::tip

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Manage data model attribute objects
description: You can use REST API requests to retrieve an attribute's elements in a data model.
---

<Available since="Strategy ONE (August 2025)" />
<Available since="Strategy (August 2025)" />

:::tip

Expand Down
Loading
Loading