DEVELOPER DOCS

REST API

Engine Settings

On this page

Per-workspace on/off switches for each reconstruction engine. Turning an engine off stops its compute and its cost.


Get engine settings

HTTP
GET /v1/observ/orgs/{org}/workspaces/{ws}/engine-settings

Auth: API key or JWT · Role: viewer

Response 200 — not schema-modelled

JSON
{
  "engines": {
    "content_reliability": true,
    "decision_trace": true,
    "decomposition": true,
    "sources": true,
    "alignment": false,
    "correlation": true,
    "savings": true,
    "external_crosscheck": false,
    "fleet_monitor": true
  }
}

Absence means enabled. An engine key missing from the map is ON. The gate is an AND of this setting and any org-level gate, so an engine runs only when both allow it.

Examples

es = evigauge.get("/v1/observ/orgs/{org}/workspaces/{ws}/engine-settings")
for name, on in es["engines"].items():
    print(f"{'✅' if on else '⬜'} {name}")

Set engine settings

HTTP
PUT /v1/observ/orgs/{org}/workspaces/{ws}/engine-settings

Auth: API key or JWT · Role: admin

Request body — EngineSettingsIn

FieldTypeRequiredDescription
enginesobject✅Map of engine name → boolean

Examples

evigauge.put("/v1/observ/orgs/{org}/workspaces/{ws}/engine-settings", json={
    "engines": {
        "alignment": True,
        "external_crosscheck": False,   # ships dark by default
    }
})