Getting Started

Getting Started

The MindCloud API gives you programmatic read access to the resources you manage in the platform: workflows, runs and their results, connections, users, roles, companies, environments, and task usage. API keys are fully manageable: list, create, and revoke them over the API.

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.

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

Every response uses the same envelope. List endpoints add pagination metadata:

{
  "success": true,
  "data": [{ "id": "wf_123", "name": "Sync invoices" }],
  "meta": { "limit": 10, "offset": 0, "total": 42 }
}

Errors carry a stable code and a readable message:

{
  "success": false,
  "error": { "code": "NOT_FOUND", "message": "Workflow \"wf_999\" was not found." }
}

Next steps

• Authentication covers keys and company scoping.
• Shape your requests covers pagination, filtering, sorting, and field selection, which work the same on every list endpoint.