Sign inGet started
Docs
Get started

Getting Started

Read and change your MindCloud workflows, runs, connections, members, and settings over a versioned REST API.

Getting Started

The MindCloud API gives you programmatic access to what you manage in MindCloud: your organization and its members, connections to other apps, Gravity workflows and their runs, and Cirra Analytics pages. You can read all of it, and change most of it.

How the API is organized

The docs follow MindCloud's products. Pick one with Category in the sidebar; each shows its guides (how it works, and the recommended way to build with it) and, separately, its actions (one reference page per endpoint), both in nested folders.

  • MindCloud: what every product runs on. Your organization, members, roles and API keys (How Access Works), and connections to other apps and the Universal API (How Connections Work).
  • Cirra: the AI workspace. Analytics pages built from your apps' data (Analytics), and governance of what Cirra may do for each role.
  • Gravity: workflow automation. Build, publish and run workflows, and follow their runs and usage (How Workflows Work).
  • Embedded: connect your own end users' apps from your product, and run actions with their accounts (Connect end-user apps).

Base URL

All requests go over HTTPS to:

https://connect.mindcloud.co

Choose an API version in the sidebar. v2 is selected by default, and each endpoint page shows its full versioned path. All Endpoints lists every endpoint on one page, and the Workflow Building Guide is the recommended way to build one, with what trips people up; Build a Workflow covers each part in depth.

Quick start

Create an API key in the platform, then verify it:

curl https://connect.mindcloud.co/v2/me \
  -H "Authorization: Bearer $MINDCLOUD_API_KEY"

List your workflows:

curl "https://connect.mindcloud.co/v2/workflows?limit=10&sort=-createdOn" \
  -H "Authorization: Bearer $MINDCLOUD_API_KEY"

Response envelope

Responses use the same envelope. Paginated list endpoints add pagination metadata:

{
  "success": true,
  "data": [{ "id": "Wq3kZ8pLx2Nb", "name": "Sync invoices" }],
  "meta": {
    "pagination": { "totalCount": 42, "totalCountExact": true, "hasNextPage": true, "hasPreviousPage": false }
  }
}

Errors carry a stable code, a readable message, and, when there is more to say, the specific reason:

{
  "success": false,
  "error": {
    "code": "CONFLICT",
    "message": "Workflow \"Wq3kZ8pLx2Nb\" is disabled. Enable it with PUT /v2/workflows/:workflowId { \"isActive\": true } before running it.",
    "details": { "reason": "WORKFLOW_DISABLED" }
  }
}

Errors lists the codes.

OpenAPI

GET https://connect.mindcloud.co/v2/openapi.json serves an OpenAPI 3.1 document for every /v2 endpoint, with every parameter and response field typed. It needs no API key, so you can feed it straight to a client generator.

Next steps