# Platform API

Manage organizations, dedicated Minds, services, and usage through the correct Minds API surface.

Source: https://docs.minds.sh/docs/api/platform



Use the platform API to manage the infrastructure around a Mind: its organization, dedicated instance, enabled services, backups, and usage. Use the instance API to work with the information inside that Mind.

## Choose the right connection [#choose-the-right-connection]

| Surface                   | What it does                                                                                  | How you connect                                                                                            |
| ------------------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| Minds dashboard           | Select an organization and instance, provision a Mind, work with Helm, and open billing flows | Same-origin `/api/...` requests using the signed-in browser session                                        |
| Management service        | Manage tenant, service, instance, region, backup, and token resources                         | Your deployment's management origin plus `/api/v1/...`; use the authentication configured for that service |
| Dedicated Mind            | Read and write memory, query graphs, run retrieval, and use enabled engine services           | The dedicated HTTPS endpoint returned for your Mind; use an instance credential with the required scope    |
| Auxiliary API application | Health, metrics, authentication integration, and incoming webhooks                            | Its separately configured origin; these are operational endpoints                                          |

These applications do not share one universal base URL or credential. A Minds browser session cookie is not an instance capability token. The same-looking path on two applications can have a different contract.

## Start with a read [#start-with-a-read]

For a browser integration already running on the signed-in Minds origin:

```typescript
const response = await fetch('/api/organizations', {
  credentials: 'same-origin',
  cache: 'no-store',
});
if (!response.ok) throw new Error(`Organizations: HTTP ${response.status}`);
const { organizations, activeOrganizationId } = await response.json();
```

For an integration using an issued management API key, point `MINDS_MANAGEMENT_URL` at your actual management deployment and send its key in `x-api-key`:

```bash
curl --fail-with-body \
  --header "x-api-key: $MINDS_MANAGEMENT_API_KEY" \
  "$MINDS_MANAGEMENT_URL/api/v1/tenants?org_id=$MINDS_ORG_ID"
```

This request lists accessible tenant records; it does not create infrastructure. Do not copy a dashboard origin into this example unless your deployment explicitly routes management endpoints there.

## Follow a workflow [#follow-a-workflow]

* [Authentication](/docs/api/platform/authentication): sessions, API keys, scoped tokens, and organization access.
* [Organizations and active Mind](/docs/api/platform/organizations): establish the browser's working context.
* [Provision a dedicated Mind](/docs/api/platform/provisioning): create, check readiness, and upgrade an instance.
* [Management resources](/docs/api/platform/management): tenant, service, region, and backup operations.
* [Usage, billing, and webhooks](/docs/api/platform/billing-usage): understand reporting and payment boundaries.
* [Proxy behavior](/docs/api/platform/proxies): know what the dashboard forwards and when it returns a fallback.
* [Errors and responses](/docs/api/platform/errors): handle validation, access failures, and asynchronous operations.

The [complete endpoint catalog](/docs/api/platform/endpoints) covers 68 route files and 108 HTTP exports in the source snapshot. [Schema reference](/docs/api/platform/schemas) includes field types, defaults, and validation bounds. Reference pages are source evidence, not confirmation that every route is exposed or enabled on a particular deployment.