ChatBot API Documentation

This is the complete API documentation for connecting to the ChatBot 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 ChatBot: Manage ChatBot stories, users, training, and conversation data. Keep reading to get started.

Quickstart

Before you run your first ChatBot 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 ChatBot connection — create or choose one in Connections. Note its connectionId.

Every ChatBot action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/chatBot/actions/{actionSlug}/run

You need a MindCloud API Key and a ChatBot connection. Then call an action such as List Stories:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/chatBot/actions/list-stories/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

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.

Authenticate with a MindCloud API Key plus a connectionId for your ChatBot account. See ChatBot API Authentication for the full flow and how to get your connection credentials.

ChatBot actions

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

• PUTAdd segments to User
• PUTBan or Unban User
• POSTCreate Segment
• POSTCreate Story
• POSTCreate User
• POSTCreate User Entity
• GETExport Users
• GETGet Chat
• GETGet Conversations Report
• GETGet Story
• GETGet User
• GETGet User Entity
• GETList Chats
• GETList Phrases
• GETList Segments
• GETList Stories
• GETList User Entities
• GETList Users
• PUTTrain Phrases
• PUTTrain with Custom Text
• PUTUpdate Story
• PUTUpdate User
• PUTUpdate User Entity
• PUTUpdate User Segments

Related apps

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

Google FormsMailchimpCalendlyWebflowGoogle AdsActiveCampaignBrevoMailerLite