BotStar API Documentation

This is the complete API documentation for connecting to the BotStar API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet BotStar: Build chatbots and manage bot content and audiences. Keep reading to get started.

Quickstart

Before you run your first BotStar request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one BotStar connection — create or choose one in Connections. Note its connectionId.

Every BotStar action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/botStar/latest/actions/{actionSlug}

You need a MindCloud API Key and a BotStar connection. Then call an action such as Get Bot:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/botStar/latest/actions/get-bot" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected BotStar account that should run the action. MindCloud stores and refreshes the BotStar credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

BotStar actions

All 24 published actions for this BotStar version. Each page documents the endpoint, arguments, and response controls.

• POSTCreate Bot
• POSTCreate Bot Attribute
• POSTCreate CMS Entity
• POSTCreate CMS Entity Fields
• POSTCreate CMS Entity Item
• POSTCreate User Attribute
• DELETEDelete Bot Attribute
• DELETEDelete CMS Entity
• DELETEDelete CMS Entity Fields
• DELETEDelete CMS Entity Item
• GETGet Bot
• GETGet CMS Entity
• GETGet CMS Entity Item
• GETGet User Info
• GETList Bot Attributes
• GETList Bots
• GETList CMS Entities
• GETList CMS Entity Items
• PUTPublish Bot
• PUTUpdate Bot Attribute
• PUTUpdate CMS Entity
• PUTUpdate CMS Entity Fields
• PUTUpdate CMS Entity Item
• PUTUpdate User Attributes

Related apps

More Support apps on the Universal API, behind the same REST shape. Or browse all apps.

TrelloClickUpZendeskQuoIntercomEventbriteTickTickLinear