Developer resources

Public interfaces, documented.

The public HTTP surface is intentionally small. OpenAPI is the canonical operation contract; the resources below expose bounded inspection telemetry, transport, public identity and site structure without creating a second product layer.

HTTP operations

Current public contract.

Operation IDs, typed request and response schemas, evidence limits and error codes are published in the OpenAPI document.

  • GET/api/inspect?url={absolute-public-url}Return bounded symptom-only telemetry across six public signal vectors, including a readiness index and at most five evidence traces.
  • GET/api/scan?url={absolute-public-url}Fetch a bounded public representation used by inspection clients. This transport does not itself diagnose architecture or prescribe remediation.
  • POST/api/scanSubmit an explicit inspection record and the contact details required by the existing delivery or follow-up flow.
  • POST/api/contactSubmit a qualified project enquiry.
Quickstart

Inspect one public URL.

The telemetry endpoint accepts only public HTTP or HTTPS targets and returns six signal states, anomaly counts and a bounded evidence sample. It does not expose prescriptive fixes.

curl -sS -G 'https://brittek.net/api/inspect' \
  --data-urlencode 'url=https://example.com/'
Abbreviated success shape
{
  "inspectionId": "insp_…",
  "targetDomain": "example.com",
  "readinessIndex": 72,
  "signalVectors": { "retrieval": { "status": "PASS" }, "…": "…" },
  "metrics": { "…": "…" },
  "evidenceTraces": [{ "id": "…", "vector": "…", "summary": "…" }]
}
Error example
{
  "error": "Target did not return an inspectable public response",
  "code": "TARGET_UNAVAILABLE",
  "message": "Target did not return an inspectable public response",
  "hint": "Provide an absolute public http(s) URL that returns HTML."
}

Success payloads stay descriptive: an inspection identifier, readiness index, six signal vectors, metrics and at most five evidence traces. Failures use stable code and message fields rather than free-form text alone.