Idempotent, read-only. Returns every function the POST accepts. Not paginated: the full array is returned (catalog size is bounded by the build).

{
  "ok": true,
  "kind": "catalog",
  "data": { "functions": [ { "id": "table", "category": "primitive", "params": ["key"], "arity": 1, "description": "Read a dataset as a 2D matrix." }, ... ] }
}Copy

When the engine is not built the answer is honest: 503 { "ok": false, "kind": "error", "error": { "code": "not_built", "hint": "app/js/core/api/ecbtScienceRegistry.js" } }.

Request

{ "fn": "shannon", "args": [ "[10, 20, 30]" ] }
{ "fn": "table", "key": "dataset-id" }

• fn is required — missing/blank → 400 { "ok": false, "kind": "error", "error": { "code": "bad_args" } }.
• Arguments are coerced to the spreadsheet string model (numbers/booleans/objects are stringified) before reaching the engine.
• Idempotency: the call is a pure computation — the same {fn,args} returns the same envelope; there is no server-side state to duplicate. Domain errors are returned with HTTP 200 and ok:false (the spreadsheet cell decides); transport/build errors use 503/500.
• Tabular primitives (table, sum, value, meta) answer key_not_found until a dataset loader is wired — documented stub, not a hidden fake.

Response

{
  "success": true,
  "data": {
    "browserConnected": true,
    "uptime": 142,
    "actionsCount": 196,
    "pendingRequests": 0
  }
}Copy

Returns the complete model state as built by buildModel(). Equivalent to exporting the model as JSON.

Response

{
  "selectedElement": "el_abc123",
  "elementCount": 12,
  "campaignCount": 3,
  "sceneCount": 2,
  "language": "en",
  "activeRibbonTab": "modeling"
}Copy

Runs a visual audit of the UI. Checks icon hydration, font families, open modals, button styling, theme variables, and form input classes.

Returns all elements with their data (excluding Three.js mesh references). Each element has: id, family, name, visible, label, color, data, stamps.

Parameters

Request Body

{ "familyId": "well" }Copy

Valid family IDs: plume, well, lake, river, spring, building, tank, waste, boundary, sensor, or any custom family.

Request Body

{
  "updates": {
    "name": "MW-01",
    "coordinates": { "easting": 350000, "northing": 7400000 }
  }
}Copy

Removes the element and all associated observations, stamps, and edges.

Returns the observations[] array from the element's data.

Returns governance, context, and reporting stamps attached to the element.

Returns all edges (incoming + outgoing) connected to the element.

Returns all campaigns with their date, team, and visibility state.

Creates a new sampling campaign with default values. No request body required.

Request Body

{
  "field": "name",
  "value": "Q1 2026 Sampling"
}Copy

Removes the campaign. Observations linked to this campaign are NOT removed.

Returns all saved scene (camera view) snapshots.

Creates a new scene with default camera position.

Removes the saved camera view.

Returns built-in and custom families with id, name, icon, code, enabled state.

Request Body

{ "id": "piezometer", "name": "Piezometer", "icon": "gauge" }Copy

Removes a custom family. Built-in families cannot be deleted.

Returns all edges with source, target, type, and metadata.

Parameters

Returns stamps grouped by element. Each entry includes elementId, elementName, family, and stamps[].

Returns the full groups state: elementGroups[], familyGroups[], elementGroupMap, familyGroupMap.

Returns a single group object with id, name, color, collapsed, order.

Response

{
  "user": { "email": "user@example.com", "provider": "google" },
  "loggedIn": true,
  "email": "user@example.com",
  "role": "admin",
  "observerMode": "disabled",
  "accessControlActive": true,
  "owner": "admin@example.com"
}Copy

Returns the array of access rules. Each rule has: email, role (owner/admin/editor/viewer/observer), areas[].

Returns the complete access configuration: owner, observerMode, rules[].

Returns the full ticker config: visible, speed, separator, items[]. Each item has filters[], calculation, label, unitId, precision, color.

Returns the live computed values for all enabled ticker items. Each entry has: id, text, color.

Response

{
  "active": true,
  "scenario": "tailings_dam",
  "tier": "recommended",
  "matrices": ["agua", "solo", "ar"],
  "parameterCounts": { "agua": { "essential": 15, "recommended": 28, "total": 45 } }
}Copy

Returns all currently active parameters based on the selected scenario, tier, and matrices. When SAO is inactive, returns all CONFIG.PARAMETERS.

Returns the governance section of the model: contracts, WBS items, parties, disbursements, and EVA calculations. Returns null if no governance data exists.

Fetches live data for a sensor-family element via its 3-stage pipeline (JSONPlaceholder, FakerAPI, OpenWeatherMap). Element must be of family sensor.

Timeout: 30 seconds (async operation)

Returns all agents (6 system + user-created). Each agent has: id, name, description, systemPromptAddition, system (boolean).

Response

{ "id": "default" }Copy

Returns the agent object. System agents: default, regulatory-br, regulatory-us, regulatory-intl, campaign, hse.

Returns visible modal overlays with their ID, title, and structure info.

Returns detailed structure: header, body, footer presence, button audit, dimensions.

Closes all visible modals including SAO, stamp, and edge modals.

Returns panel visibility, docking state, and dimensions for left, right, and analytics panels.

Query Parameters

Returns the conversation history from the AI assistant chat panel.

Returns all currently visible toast notifications with their text, type (success, error, warning, info), and timestamp.

Request Body

{ "tabId": "analysis" }Copy

Switches the active ribbon tab. Common tab IDs: modeling, analysis, tools, view.

Returns the full model state as a JSON object.

Returns the model encoded as an ECBT key string. Timeout: 30 seconds.

Request Body

{ "model": { /* full model object */ } }Copy

Request Body

{ "key": "ECBT.A0000001..." }Copy

Query Parameters

Returns PNG image binary (Content-Type: image/png).

Query Parameters

Example

curl "localhost:4000/api/dom?selector=%23app&props=style,box"Copy

Requires a local control session cookie plus X-ECBYTS-Control-Token. Bootstrap by opening http://localhost:4000/ and then calling GET /api/local-control/token.

Request Body

{
  "expr": "document.title",
  "timeout": 5000
}Copy

Evaluates a JavaScript expression in the browser context. Default timeout: 30s. Use for testing and automation — wrap async imports in (async () => { ... })().

Sends a reload signal to the connected browser tab. The WebSocket bridge reconnects automatically after reload.

Returns all registered pipelines with their ID, name, steps, and status.

Request Body

{
  "id": "my-pipeline",
  "name": "Data Quality Check",
  "steps": [...]
}Copy

Saves a pipeline definition. If id matches an existing pipeline, it is updated.

Parameters

Parameters

Parameters

Executes the pipeline steps sequentially. Rate limited: returns 409 Conflict if the pipeline is already running. Timeout: 30s.

Query Parameters

Response

{
  "success": true,
  "data": {
    "id": "tool-123",
    "name": "Soil Analysis",
    "records": [...]
  }
}Copy

Query Parameters

Runs diagnostic analysis on the aerial/satellite image. Timeout: 30s.

Query Parameters

Request Body (optional)

{ "calibration": { ... } }Copy

Runs aerial recognition and automatically imports detected features as elements. Timeout: 30s.

Query Parameters

Auto-calibrates recognition thresholds from the boundary image. Timeout: 30s.

Removes all elements that are not of the boundary family. Used to clean up after recognition runs.

Returns raw SegFormer model output for debugging purposes. Timeout: 30s.

Returns the current LLM provider, model, and connection status.

Request Body

{
  "provider": "openai",
  "apiKey": "sk-...",
  "model": "gpt-4o"
}Copy

All fields are optional. Only provided fields are updated.

Tests the LLM connection with the current configuration. Timeout: 30s.

Request Body

{
  "filePath": "C:/path/to/file.pdf",
  "pages": "1-5"
}Copy

Response

{
  "success": true,
  "data": {
    "tables": [...],
    "meta": { "cache": "miss" }
  }
}Copy

Extracts tables from PDF via Python pdfplumber. Requires Python 3 with pip install pdfplumber. Results cached for 15 minutes. Timeout: 30s.

Returns the ACTION_REGISTRY — array of all registered actions with name, params[], and cat (category).

Request Body

{
  "action": "handleAddObservation",
  "args": ["el_abc123"]
}Copy

Executes any window.* function matching the handler pattern. The args array is spread as function arguments.

Request Body

{
  "actions": [
    { "action": "handleAddElement", "args": ["well"] },
    { "action": "handleAddElement", "args": ["plume"] }
  ],
  "stopOnError": true
}Copy