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

Applications

List applications

get
/api/v1/workspaces/{wsId}/applications

Lists the applications in the workspace. Paginated (limit, cursor). Deployed copies of an application are not listed; only the applications themselves. The builder graph, trigger and type configuration are not part of the public shape.

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
Query parameters
limitnumber · min: 1 · max: 1000Optional

Page size (1-1000, default 50).

Example: 1
cursorstringOptional

Opaque cursor from a previous response's pagination.cursor.

Example: example
Responses
200

Successful response

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

{
  "data": [
    {
      "id": "text",
      "workspaceId": null,
      "organisationId": "text",
      "name": "text",
      "date": null,
      "lastSaved": null,
      "metadataSavedAt": null,
      "pagesRevision": 1,
      "description": null,
      "access": "public",
      "parentId": null,
      "version": null,
      "deployedAt": null,
      "building": null,
      "status": "Running",
      "isLive": null,
      "kind": "user",
      "slug": null,
      "lifecycleStatus": "draft",
      "publish": {
        "slug": null,
        "publishedAt": null,
        "publishedVersion": null,
        "surfaces": [
          "rest"
        ],
        "consumerAccess": "private",
        "allowedEmailDomains": [
          "text"
        ],
        "embedOrigins": [
          "text"
        ],
        "notes": null
      },
      "settings": {
        "publishDraft": {
          "version": null,
          "notes": null,
          "embedOriginsText": null,
          "restrictEmbedding": null,
          "subAppOn": null
        },
        "description": null,
        "icon": null,
        "color": null,
        "exposedTerminals": [
          {
            "moduleId": null,
            "portId": null,
            "widgetId": "text",
            "direction": "in",
            "kind": "dataframe",
            "label": "text"
          }
        ],
        "embeddablePages": [
          "text"
        ],
        "emittedEvents": [
          {
            "name": "text",
            "payloadSchema": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "description": ""
          }
        ],
        "agent": {
          "enabled": false,
          "instructions": "",
          "tools": [
            "app_describe"
          ],
          "canPress": [
            "text"
          ],
          "pressWithoutConfirm": [
            "text"
          ],
          "knowledge": [
            "text"
          ],
          "model": null
        }
      },
      "theme": {
        "backgroundMode": "light",
        "accentColor": "text",
        "backgroundColor": "text",
        "fontPreset": "default"
      }
    }
  ],
  "pagination": {
    "cursor": "text",
    "hasMore": true,
    "total": 1
  }
}

Get application

get
/api/v1/workspaces/{wsId}/applications/{id}

Returns the application by id from platform MongoDB. Must belong to the workspace; deployed copies are not addressable. The builder graph, trigger and type configuration are not part of the public shape.

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
idstringRequired

Path parameter: id

Example: 123
Responses
200

Successful response

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

{
  "data": {
    "id": "text",
    "workspaceId": null,
    "organisationId": "text",
    "name": "text",
    "date": null,
    "lastSaved": null,
    "metadataSavedAt": null,
    "pagesRevision": 1,
    "description": null,
    "access": "public",
    "parentId": null,
    "version": null,
    "deployedAt": null,
    "building": null,
    "status": "Running",
    "isLive": null,
    "kind": "user",
    "slug": null,
    "lifecycleStatus": "draft",
    "publish": {
      "slug": null,
      "publishedAt": null,
      "publishedVersion": null,
      "surfaces": [
        "rest"
      ],
      "consumerAccess": "private",
      "allowedEmailDomains": [
        "text"
      ],
      "embedOrigins": [
        "text"
      ],
      "notes": null
    },
    "settings": {
      "publishDraft": {
        "version": null,
        "notes": null,
        "embedOriginsText": null,
        "restrictEmbedding": null,
        "subAppOn": null
      },
      "description": null,
      "icon": null,
      "color": null,
      "exposedTerminals": [
        {
          "moduleId": null,
          "portId": null,
          "widgetId": "text",
          "direction": "in",
          "kind": "dataframe",
          "label": "text"
        }
      ],
      "embeddablePages": [
        "text"
      ],
      "emittedEvents": [
        {
          "name": "text",
          "payloadSchema": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "description": ""
        }
      ],
      "agent": {
        "enabled": false,
        "instructions": "",
        "tools": [
          "app_describe"
        ],
        "canPress": [
          "text"
        ],
        "pressWithoutConfirm": [
          "text"
        ],
        "knowledge": [
          "text"
        ],
        "model": null
      }
    },
    "theme": {
      "backgroundMode": "light",
      "accentColor": "text",
      "backgroundColor": "text",
      "fontPreset": "default"
    }
  }
}

Delete application

delete
/api/v1/workspaces/{wsId}/applications/{id}

Deletes the application, its schedules, its published versions, its module data and any deployed copies of it, and releases the datasets and twins it maintained. Deployed copies are not deletable on their own. This is the same deletion the workspace UI performs. Requires applications:delete and full permission.

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
idstringRequired

Path parameter: id

Example: 123
Responses
204

No Content

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

No content
PreviousREST API Reference
NextCatalog

Last updated