Delete a bot instance
This API is planned for future retirement. Therefore, MicroStrategy recommends that you transition to the Question with Bot Routing API for bot-related workflows.
Using the Question with Bot Routing API:
- You do not need to manually create or manage bot instances. The API automatically creates and manages bot instances.
- It offers ongoing support and updates, ensuring compatibility with new bot-related features.
- It provides enhanced functionality, such as intelligent bot selection and flexible bot routing.
This workflow sample demonstrates how to create a bot instance.
This workflow sample demonstrates how to delete a bot instance.
Obtain the authorization token needed to execute the request using POST /api/auth/login.
Delete a bot instance
Endpoint: DELETE /api/bots/{botId}/instances/{instanceId}
Replace {botId}
in DELETE /api/bots/{botId}/instances/{instanceId}
with the chatbot ID and {instanceId}
with your bot instance ID created with POST /api/bots/{botId}/instances
in your environment.
Sample Request Header:
"X-MSTR-AuthToken": "evvk84kcucn8abon6c1qfbud7"
"X-MSTR-ProjectID": "B7CA92F04B9FAE8D941C3E9B7E0CD754"
Sample Request Body: No request body.
Sample Curl:
curl 'https://demo.microstrategy.com/MicroStrategyLibrary/api/bots/6C6D314E4C881C01BFD79084DD5B2D42/instances/5B1EB48585F04384A97F3D831D7C7416' \
-X 'DELETE'
-H 'accept: */*' \
-H 'X-MSTR-AuthToken: evvk84kcucn8abon6c1qfbud7' \
-H 'X-MSTR-ProjectID: B7CA92F04B9FAE8D941C3E9B7E0CD754'
Sample Response:
Response Code | Status |
---|---|
200 | Successfully delete the bot instance |
400 | Error in deleting the bot isntance |
401 | Authorization failed |
404 | Bot or bot instance does not exist |
Sample Response Body on success: No response body