Vitruvyan
Docs
System CorePlatform APIs

Vitruvyan Docs

๐ŸŒ Veritas Engine API (Quant Engine)

Last Updated: March 23, 2026 17:00 UTC

๐Ÿ“ Location

  • Service: services/api_veritas_engine/
  • Pure core: vitruvyan_core/core/governance/veritas_engine/
  • Module doc: Veritas Engine

๐Ÿšช Base URL / Port

  • Config default: SERVICE_PORT=8013 (services/api_veritas_engine/config.py)
  • Docker external port: 9013 (see infrastructure/docker/docker-compose.yml)

๐Ÿงญ Endpoints (implemented)

Defined in services/api_veritas_engine/api/routes.py:

MethodPathDescription
GET/healthliveness + bus connectivity status
POST/validaterun a full signal quality validation
GET/validate/{run_id}retrieve a past run (501 โ€” not yet implemented)

๐Ÿงพ Request/Response models

See services/api_veritas_engine/models/schemas.py.

POST /validate

Request (ValidationRunRequest):

{
  "entity_ids": ["AAPL", "MSFT", "GOOGL"],
  "features": {
    "AAPL": {
      "completeness": 0.95,
      "z_consistency": 0.88,
      "freshness": 0.90,
      "sample_adequacy": 0.75,
      "outlier_probability": 0.05,
      "value": 185.5,
      "staleness_days": 0
    }
  },
  "domain": "finance",
  "diagnostics_level": "standard"
}

Response (ValidationRunResponse):

{
  "run_id": "ve-20260323T120000Z-a1b2c3d4",
  "profile": "default",
  "entity_count": 3,
  "overall_confidence": 0.872,
  "regime": {
    "regime": "normal",
    "regime_score": 0.21,
    "indicators": {
      "volatility": 0.8,
      "dispersion": 0.1,
      "signal_density": 1.0,
      "batch_freshness": 1.0
    }
  },
  "signal_qualities": [
    {
      "entity_id": "AAPL",
      "quality_score": 0.91,
      "confidence_level": "high",
      "flags": [],
      "quality_components": {
        "completeness": 1.0,
        "z_consistency": 1.0,
        "freshness": 1.0,
        "sample_adequacy": 0.7,
        "non_outlier": 0.63
      }
    }
  ],
  "diagnostics": {"domain": "finance", "diagnostics_level": "standard"},
  "produced_at": "2026-03-23T12:00:00Z"
}

GET /health

Response (HealthCheckResponse):

{
  "status": "healthy",
  "service": "api_veritas_engine",
  "timestamp": "2026-03-23T12:00:00Z",
  "upstream_connected": true,
  "redis_connected": true
}

โš™๏ธ Env vars (service-level)

Loaded in services/api_veritas_engine/config.py:

VariableDefaultDescription
SERVICE_PORT8013HTTP listen port
LOG_LEVELINFOlogging verbosity
QUALITY_PROFILEdefaultthreshold preset (default/strict/relaxed)
NEURAL_ENGINE_URLhttp://neural_engine:8003upstream NE URL (optional)
REDIS_URLredis://redis:6379StreamBus connection
POSTGRES_HOSTpostgresaudit log DB host
POSTGRES_DBvitruvyanaudit log DB name
POSTGRES_USERvitruvyanaudit log DB user
POSTGRES_PASSWORD(secret)audit log DB password

๐Ÿ”„ Redis Streams Listener

services/api_veritas_engine/streams_listener.py runs as a sidecar container.

  • Channel: veritas.validation.requested
  • Consumer group: veritas_engine
  • Trigger: deserializes payload โ†’ calls VeritasBusAdapter.run_validation()
  • ACK: acknowledges event after successful processing

๐Ÿ—„๏ธ Audit Log (optional)

services/api_veritas_engine/adapters/persistence.py writes to:

TABLE veritas_audit_log (
  run_id        TEXT PRIMARY KEY,
  profile       TEXT,
  entity_count  INTEGER,
  overall_confidence FLOAT,
  regime        TEXT,
  produced_at   TIMESTAMPTZ,
  diagnostics   JSONB
)

Insert is ON CONFLICT DO NOTHING โ€” idempotent. Postgres wiring is optional: if PostgresAgent is unavailable the audit log silently skips.

๐Ÿณ Docker

# infrastructure/docker/docker-compose.yml (excerpt)
veritas_engine:
  build: services/api_veritas_engine
  ports:
    - "9013:8013"
  environment:
    - QUALITY_PROFILE=default
    - REDIS_URL=redis://redis:6379
# Build + deploy
docker compose build veritas_engine
docker compose up -d veritas_engine