Organization API

This reference covers your organization: workspaces, the webhook, usage and limits, erasure and the audit log. Everything a workspace does (imports, jobs, search, saved views, tags) is in the API Reference. Call those endpoints with your organization key and name the workspace, as described in Working in a workspace.

Base URL

https://api.clustr-ai.com/api/org/v1

Authentication

Every call needs an organization API key, which starts with clo_:

curl https://api.clustr-ai.com/api/org/v1/tenants \
  -H "Authorization: Bearer $CLUSTR_ORG_KEY"

Each organization key carries scopes, and a call that needs a scope your key lacks answers 403. Each endpoint page names the scope it needs. See Organization API keys.

Names in the API

The API says tenant where these docs say workspace: the /tenants paths, the X-Clustr-Tenant header and fields such as tenant_id all refer to one of your workspaces.

Errors

Every error has the same shape. Branch on error.code; error.message is written for people.

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Erasure not found"
  }
}

A workspace id that is not one of yours answers 404.

Retrying safely

Requesting an erasure accepts an Idempotency-Key header: repeating the call with the same key returns the first erasure. Imports you start for a workspace accept the same header on the public API; see Bulk jobs.

Guides