Kazm API Documentation

This is the complete API documentation for connecting to the Kazm 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 Kazm: Kazm, now operating on the current Lightning Rod platform contract, lets teams generate datasets, manage files and file sets, run transform and training jobs, evaluate outputs, inspect organization balance, and call Lightning Rod's OpenAI-compatible endpoints. Keep reading to get started.

Quickstart

Before you run your first Kazm request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Kazm connection — create or choose one in Connections. Note its connectionId.

Every Kazm action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/kazm/latest/actions/{actionSlug}

You need a MindCloud API Key and a Kazm connection. Then call an action such as Estimate Training Cost:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/kazm/latest/actions/estimate-training-cost" \
  --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 Kazm account that should run the action. MindCloud stores and refreshes the Kazm 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.

Kazm actions

All 30 published actions for this Kazm version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd File To Set
• DELETECancel Transform Job
• POSTChat Completions
• POSTCreate Completion
• POSTCreate Dataset
• POSTCreate Evaluation Job
• POSTCreate File Set
• POSTCreate File Upload
• POSTCreate Training Job
• POSTCreate Transform Job
• GETEstimate Training Cost
• GETEstimate Transform Job Cost
• GETGet Dataset
• GETGet Dataset Samples
• GETGet Evaluation Job
• GETGet File Set
• GETGet File Set Status
• GETGet Organization Balance
• GETGet Training Job
• GETGet Transform Job
• GETGet Transform Job Metrics
• GETList Datasets
• GETList Evaluation Jobs
• GETList File Sets
• GETList Files In Set
• GETList Models
• GETList Training Jobs
• GETList Transform Jobs
• POSTRetry Failed Files
• POSTUpload Samples

Related apps

More apps on the Universal API, behind the same REST shape. Or browse all apps.

Google SheetsGmailSlackGoogle CalendarGoogle DriveNotionHubSpotGoogle Forms