Chatling API Documentation
This is the complete API documentation for connecting to the Chatling 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 Chatling: Manage AI chatbots, contacts, conversations, and knowledge base content. Keep reading to get started.
Quickstart
Before you run your first Chatling 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 Chatling connection — create or choose one in Connections. Note its
connectionId.
Every Chatling action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/chatling/actions/{actionSlug}/runYou need a MindCloud API Key and a Chatling connection. Then call an action such as List Settings:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/chatling/actions/list-settings/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 Chatling account. See Chatling API Authentication for the full flow and how to get your connection credentials.
Chatling actions
All 23 published actions for this Chatling version. Each page documents the endpoint, arguments, and response controls.
- GETChat With Knowledge Base AI
- POSTCreate Contact
- POSTDuplicate Chatbot
- GETGet AI Credits Usage
- GETGet Chatbots Usage
- GETGet Email Credits Usage
- GETGet Knowledge Base Usage
- GETGet User Seats Usage
- GETList AI Languages
- GETList AI Models
- GETList Chatbot Templates
- GETList Chatbots
- GETList Contacts
- GETList Conversation Messages
- GETList Conversations
- GETList Settings
- PUTRate AI Answer
- GETRetrieve Chatbot
- GETRetrieve Contact
- GETRetrieve Conversation
- PUTUpdate Chatbot Settings
- PUTUpdate Conversation
- PUTUpdate Settings
Related apps
More Artificial Intelligence apps on the Universal API, behind the same REST shape. Or browse all apps.