Cloud BOT API Documentation
This is the complete API documentation for connecting to the Cloud BOT 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 Cloud BOT: Cloud BOT is a fully cloud-based RPA service that records browser operations and exposes BOT execution, job, subscription, file, and contract APIs. Keep reading to get started.
Quickstart
Before you run your first Cloud BOT 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 Cloud BOT connection — create or choose one in Connections. Note its
connectionId.
Every Cloud BOT action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/cloudBOT/latest/actions/{actionSlug}You need a MindCloud API Key and a Cloud BOT connection. Then call an action such as List Contracts:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/cloudBOT/latest/actions/list-contracts" \
--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.
Authenticate with a MindCloud API Key plus a connectionId for your Cloud BOT account. See Cloud BOT API Authentication for the full flow and how to get your connection credentials.
Cloud BOT actions
All 12 published actions for this Cloud BOT version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Bot Subscription
- DELETEDelete Bot Subscription
- GETExport Bot Definition
- GETGet Bot Details
- GETGet Job
- GETIssue WS Token
- GETList Bot Jobs
- GETList Bot Subscriptions
- GETList Bots
- GETList Contracts
- POSTRun Bot
- DELETESuspend Job
Related apps
More apps on the Universal API, behind the same REST shape. Or browse all apps.