Read compact workspace state | BCTRL

curl https://api.bctrl.ai/v1/workspaces/id/state \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "artifacts": [
    {
      "contentType": "application/json",
      "createdAt": "2024-06-01T12:00:00Z",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "logicalPath": "configs/settings.json",
      "name": "settings.json",
      "runtime": "nodejs14",
      "runtimeId": "7a9b8c6d-1234-4e56-9f78-9a0b1c2d3e4f",
      "storageObjectId": "9f8e7d6c-5b4a-3c2d-1e0f-123456789abc",
      "type": "configuration",
      "workspaceId": "2b7e1516-28ae-4f5c-9d3a-1f2e3d4c5b6a",
      "operationId": "1c9d4f2e-8b3a-4f7a-9a2e-3d5f7b8c9a12"
    }
  ],
  "bindings": [
    {
      "alias": "dbConnection",
      "createdAt": "2024-05-20T09:30:00Z",
      "id": "binding-001",
      "runtime": "nodejs14",
      "type": "database"
    }
  ],
  "runtimes": [
    {
      "alias": "chrome-main",
      "createdAt": "2024-05-15T08:00:00Z",
      "driver": "chromedriver-95",
      "id": "4e5f6a7b-8c9d-0e1f-2345-6789abcdef01",
      "kind": "browser",
      "status": "active",
      "updatedAt": "2024-06-01T11:45:00Z",
      "workspaceId": "2b7e1516-28ae-4f5c-9d3a-1f2e3d4c5b6a",
      "summary": {
        "browserRunning": true,
        "currentDriver": "chromedriver-95",
        "defaultContextId": "ctx-12345",
        "defaultPageId": "page-67890",
        "launchMode": "profile",
        "profileId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "storageWorkspace": "chrome-profile-01"
      }
    }
  ],
  "workspace": {
    "createdAt": "2024-01-10T10:00:00Z",
    "id": "2b7e1516-28ae-4f5c-9d3a-1f2e3d4c5b6a",
    "mounts": {
      "ai": {
        "allow": [
          "openai",
          "anthropic"
        ],
        "defaults": {
          "anthropic": "claude-v1",
          "google": "vertex-ai",
          "openai": "gpt-4",
          "openai-compatible": "bctrl-gpt"
        }
      },
      "storage": {
        "workspace": "bctrl-storage-01"
      },
      "vault": {
        "allow": [
          "secrets-manager",
          "env-vars"
        ],
        "allowRawReads": false,
        "deny": [
          "private-keys"
        ]
      }
    },
    "name": "Marketing Automation Workspace",
    "updatedAt": "2024-06-01T12:00:00Z"
  }
}

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

Query parameters

runtimestringOptionalformat: "^[A-Za-z][A-Za-z0-9_-]{0,63}$"

Response

Default Response

artifactslist of objects

bindingslist of objects

runtimeslist of objects

workspaceobject