Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Workspaces

Introspect the current credential

get
/api/v1/me

Returns what the presented credential is: userId, organisationId, workspaceId (the workspace the credential is pinned to, or null for org-wide), scopes, authType (apiKey | oauth), and rateLimit (requests per minute; null for OAuth connections, which share the fixed OAuth limit). Needs no scopes — any authenticated caller may ask who it is. Use it to fail fast on missing scopes before starting a workflow.

Authorizations
AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Responses
200

Successful response

application/json
get/api/v1/me
GET /api/v1/me HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "userId": "text",
    "organisationId": "text",
    "workspaceId": null,
    "scopes": [
      "text"
    ],
    "authType": "apiKey",
    "rateLimit": null
  }
}

List workspaces

get
/api/v1/workspaces

Lists workspaces the user can access within the organisation. Filtered by resource access: only workspaces where the user has at least read permission (owner, accessRights, or org role) are returned. Not paginated.

Authorizations
AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Responses
200

Successful response

application/json
get/api/v1/workspaces
GET /api/v1/workspaces HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "organisationId": "text",
      "name": "text",
      "createdAt": "text",
      "isOrgLibrary": true
    }
  ]
}

Create workspace

post
/api/v1/workspaces

Creates a new workspace with name and optional description. The caller becomes the owner. Workspace is scoped to the organisation from the auth context.

Authorizations
AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Body
namestring · min: 1Required
Responses
201

Successful response

application/json
post/api/v1/workspaces
POST /api/v1/workspaces HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
{
  "data": {
    "id": "text",
    "organisationId": "text",
    "name": "text",
    "createdAt": "text",
    "isOrgLibrary": true
  }
}

Get workspace

get
/api/v1/workspaces/{wsId}

Returns the workspace by id. wsId is resolved from the request URL; workspace must belong to the organisation and user must have access (enforced by middleware).

Authorizations
AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Path parameters
wsIdstringRequired

Path parameter: wsId

Example: 123
Responses
200

Successful response

application/json
get/api/v1/workspaces/{wsId}
GET /api/v1/workspaces/{wsId} HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": "text",
    "organisationId": "text",
    "name": "text",
    "createdAt": "text",
    "isOrgLibrary": true
  }
}

Delete workspace

delete
/api/v1/workspaces/{wsId}

Permanently deletes the workspace. Requires sources:delete scope and full permission. Does not necessarily delete data in the data-service; workspace-scoped resources may remain until explicitly cleaned.

Authorizations
AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Path parameters
wsIdstringRequired

Path parameter: wsId

Example: 123
Responses
204

No Content

No content
delete/api/v1/workspaces/{wsId}
DELETE /api/v1/workspaces/{wsId} HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update workspace

patch
/api/v1/workspaces/{wsId}

Updates workspace name and/or description. Only these fields are writable. Used for display and organisation.

Authorizations
AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Path parameters
wsIdstringRequired

Path parameter: wsId

Example: 123
Body
namestringOptional
Responses
200

Successful response

application/json
patch/api/v1/workspaces/{wsId}
PATCH /api/v1/workspaces/{wsId} HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
{
  "data": {
    "id": "text",
    "organisationId": "text",
    "name": "text",
    "createdAt": "text",
    "isOrgLibrary": true
  }
}
PreviousSources
NextModels

Last updated