ChipBot API Documentation

This is the complete API documentation for connecting to the ChipBot 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 ChipBot: ChipBot combines video experiences, live chat, help-desk content, and reporting for customer-facing websites. This connector focuses on the currently documented HTTP API surface for domain-level video, messaging, help-desk, and reporting workflows. Keep reading to get started.

Quickstart

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

Every ChipBot action uses the same URL pattern:

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

You need a MindCloud API Key and a ChipBot connection. Then call an action such as Connect Domain:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/chipBot/latest/actions/connect-domain" \
  --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 ChipBot account that should run the action. MindCloud stores and refreshes the ChipBot 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.

ChipBot actions

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

• GETConnect Domain
• DELETEDelete Video
• GETGet Detailed Unique Hits Report
• GETGet Detailed Video Analytics
• GETGet Thread
• GETGet Unique Hits Report
• GETGet Video
• GETGet Video Analytics Summary
• GETGet Video Analytics Views by URL
• GETList Articles
• GETList Videos
• POSTReply to Message
• GETRequest Video Service Token
• POSTRequest Video Upload Token

Related apps

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

TrelloClickUpZendeskQuoIntercomEventbriteTickTickLinear