Blip API Documentation
This is the complete API documentation for connecting to the Blip 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 Blip: BLiP is a conversational platform for building, operating, and analyzing bots, tickets, contacts, threads, and related messaging workflows over the BLiP command API. Keep reading to get started.
Quickstart
Before you run your first Blip request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Blip connection — create or choose one in Connections. Note its
connectionId.
Every Blip action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/blip/latest/actions/{actionSlug}You need a MindCloud API Key and a Blip connection. Then call an action such as Get Account:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/blip/latest/actions/get-account" \
--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 Blip account that should run the action. MindCloud stores and refreshes the Blip 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.
Blip actions
All 40 published actions for this Blip version. Each page documents the endpoint, arguments, and response controls.
- POSTAdd Contact
- POSTAssociate Answer to Intent
- POSTAssociate Question to Intent
- DELETECancel Scheduling
- POSTCreate Distribution List
- POSTCreate Entity
- POSTCreate Intent
- POSTCreate Scheduling
- DELETEDelete Answer from Intent
- DELETEDelete Contact
- DELETEDelete Distribution List
- DELETEDelete Document
- DELETEDelete Question from Intent
- GETGet Account
- GETGet Call Dashboard Detail
- GETGet Call Dashboard Summary
- GETGet Call Reject Reasons
- GETGet Contact
- GETGet Document
- GETGet Entity
- GETGet Intent
- GETGet Scheduled Message
- GETList Analysis
- GETList Attendants
- GETList Closed Tickets
- GETList Contacts
- GETList Distribution Lists
- GETList Documents
- GETList Entities
- GETList Intent Answers
- GETList Intent Questions
- GETList Intents
- GETList Last Messages
- GETList Logged Messages
- GETList Open Tickets
- GETList Schedules
- GETList Tickets
- GETPing
- POSTStore Custom Document
- PUTToggle Message and Notification Logs
Related apps
More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.