Diagnostic

Runs the preliminary self-reported readiness diagnostic. The scores and verdict are rule-based; the written report is generated by a language model grounded on dxpert's knowledge base, so its wording can vary between calls. Every response is scope: preliminary. Authentication is optional via API key; it uses no entitlement, trial run, billing, email, or persistent state, but is quota/rate limited. 502 llm_error when the model provider fails.

post/api/diagnostic

Request

  • Base URL: https://opwhcervi3.execute-api.ca-central-1.amazonaws.com
  • URL: https://opwhcervi3.execute-api.ca-central-1.amazonaws.com/api/diagnostic
  • Auth: one of:
    • none
    • API key in header X-Api-Key

Query parameters

tokenstring nullable

Headers

X-Api-Keystring nullable
X-Access-Tokenstring nullable

Request body

common_model'none' | 'per_system' | 'partial' | 'unified' required
data_off_floor'manual' | 'scada_only' | 'opcua' | 'mqtt_sparkplug' | 'mixed' required
data_ownership'tribal' | 'unclear' | 'owned_governed' required
data_ready_for_use_case'no' | 'partial' | 'yes' required
edge_vs_poll'poll' | 'mixed' | 'edge_push' required
historian_depth'none' | 'local' | 'central_untrusted' | 'central_trusted' required
otit_security'ad_hoc' | 'partial' | 'governed' required
personal_stakesstring required
politically_usefulstring required
prior_attemptsstring required
realtime_visibility'none' | 'on_request' | 'partial' | 'single_pane' required
sector'discrete_mfg' | 'automotive' | 'process' | 'pharma' | 'food_bev' | 'energy' | 'other' required
site_countinteger required
uns_state'none' | 'point_to_point' | 'partial' | 'governed_uns' required
who_they_truststring required

Response

Successful Response

report_markdownstring required
scopestring

Changes

No recorded changes to this operation across all 1 revision of this API.