Botster API Documentation
This is the complete API documentation for connecting to the Botster 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 Botster: Run Botster bots and manage scraping jobs and results. Keep reading to get started.
Quickstart
Before you run your first Botster 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 Botster connection — create or choose one in Connections. Note its
connectionId.
Every Botster action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/botster/latest/actions/{actionSlug}You need a MindCloud API Key and a Botster connection. Then call an action such as Get Credits:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/botster/latest/actions/get-credits" \
--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 Botster account that should run the action. MindCloud stores and refreshes the Botster 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.
Botster actions
All 28 published actions for this Botster version. Each page documents the endpoint, arguments, and response controls.
- PUTArchive Job
- DELETEDelete Job
- DELETEDelete Run
- GETGet Credits
- GETGet Job
- GETGet Run
- GETList Bots
- GETList Jobs
- PUTRestart Job
- POSTRun Bulk DNS Lookup
- POSTRun Bulk Whois Lookup
- POSTRun Company Website Finder
- POSTRun Contact Data Scraper
- POSTRun Find Subdomains
- POSTRun Google Maps Places Scraper
- POSTRun Google Maps Reviews Scraper
- POSTRun Google Pagespeed Bulk Checker
- POSTRun Google Rank Checker
- POSTRun Google Search Scraper
- POSTRun Google Search Suggestions Scraper
- POSTRun LinkedIn Company Finder
- POSTRun LinkedIn Profile to URL Finder
- POSTRun Search Volume and CPC Finder
- POSTRun TikTok Profile Extractor
- POSTRun Website Traffic Checker
- POSTRun YouTube Search Scraper
- GETSearch Bots
- PUTUnarchive Job
Related apps
More Business Intelligence apps on the Universal API, behind the same REST shape. Or browse all apps.