# ChatBot API Documentation

This is the complete API documentation for connecting to the ChatBot API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **ChatBot connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

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

## ChatBot actions

- PUT `add-segments-to-user` Add segments to User
- PUT `ban-or-unban-user` Ban or Unban User
- POST `create-segment` Create Segment
- POST `create-story` Create Story
- POST `create-user` Create User
- POST `create-user-entity` Create User Entity
- GET `export-users` Export Users
- GET `get-chat` Get Chat
- GET `get-conversations-report` Get Conversations Report
- GET `get-story` Get Story
- GET `get-user` Get User
- GET `get-user-entity` Get User Entity
- GET `list-chats` List Chats
- GET `list-phrases` List Phrases
- GET `list-segments` List Segments
- GET `list-stories` List Stories
- GET `list-user-entities` List User Entities
- GET `list-users` List Users
- PUT `train-phrases` Train Phrases
- PUT `train-with-custom-text` Train with Custom Text
- PUT `update-story` Update Story
- PUT `update-user` Update User
- PUT `update-user-entity` Update User Entity
- PUT `update-user-segments` Update User Segments