Openlayer API Documentation
This is the complete API documentation for connecting to the Openlayer 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 Openlayer: Openlayer API integration for workspace, project, monitoring, rules, and model-management workflows. Keep reading to get started.
Quickstart
Before you run your first Openlayer 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 Openlayer connection — create or choose one in Connections. Note its
connectionId.
Every Openlayer action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/openlayer/latest/actions/{actionSlug}You need a MindCloud API Key and a Openlayer connection. Then call an action such as Get Build Info:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/openlayer/latest/actions/get-build-info" \
--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 Openlayer account that should run the action. MindCloud stores and refreshes the Openlayer 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.
Openlayer actions
All 51 published actions for this Openlayer version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Inference Pipeline
- POSTCreate Project User Tag
- POSTCreate Project Version
- POSTCreate Storage Upload URL
- DELETEDelete Project User Tag
- POSTExport Version Data
- GETGet Build Info
- GETGet Framework
- GETGet Framework Document
- GETGet Framework Project Rule Stats
- GETGet Inference Pipeline
- GETGet Inference Pipeline Graph Data
- GETGet Inference Pipeline Session
- GETGet Inference Pipeline User
- GETGet Profile
- GETGet Project Version Upload URL
- GETGet Rule
- GETGet Rule Result
- GETGet Storage Download URL
- GETGet Version
- GETGet Workspace
- GETGet Workspace Public Key
- GETGet Workspace Rule Stats
- GETHealth Check
- GETList Framework Documents
- GETList Framework Projects
- GETList Framework Rules
- GETList Framework Section Rules
- GETList Framework Subsection Rules
- GETList Inference Pipeline Goals
- GETList Inference Pipeline Results
- GETList Inference Pipeline User Sessions
- GETList Inference Pipelines
- GETList Project Goals
- GETList Project Metric Settings
- GETList Project Tests
- GETList Project User Tags
- GETList Project Versions
- GETList Projects
- GETList Rule Result Evidence
- GETList Rule Result Goals
- GETList Rule Results
- GETList Version Goals
- GETList Version Insights
- GETList Version Results
- GETList Workspace Frameworks
- GETList Workspace Invites
- GETList Workspace Rule Results
- GETList Workspace Rule Tags
- GETList Workspace Rules
- PUTUpdate Project User Tag
Related apps
More Artificial Intelligence apps on the Universal API, behind the same REST shape. Or browse all apps.