REFERENCE API CONTRACT

QuantumSafe Circuit Studio
Technology Preview

JavaScript reference API and circuit-file schema published.

RESOURCE MODEL

Named endpoints aligned to the product workflow.

MethodEndpointPurpose
JSloadCircuit(source)Parse the documented circuit syntax
JSrunCircuit(options)Execute within the browser limit
JSgetStateVector()Return amplitudes and probabilities
JSexportResult(format)Export JSON or teaching report

COMMON HEADERS

Authorization: Bearer <token>
X-Correlation-Id: <uuid>
Idempotency-Key: <uuid>
X-Request-Timestamp: <RFC3339>
Content-Type: application/json

REQUEST ENVELOPE

{
  "profileId": "QS-CS-2026.07",
  "requestId": "5fda47cb-55c8-45a8-81a6-2dd1d1938b47",
  "mode": "controlled-evaluation",
  "evidenceRequired": true
}

ERROR MODEL

  • 400 — Invalid schema or unsupported profile
  • 401/403 — Authentication or policy denial
  • 409 — Idempotency or state conflict
  • 422 — Evidence or compatibility requirement not met
  • 503 — Protected dependency unavailable; fail-closed unless approved otherwise

VERSIONING

  • Major version in path for incompatible change.
  • Profile ID and evidence schema are versioned independently.
  • Deprecation requires notice, replacement path and project review.
  • Exact authentication and request-signature policy is deployment-specific.

IMPLEMENTATION PATH

QuantumSafe Circuit Studio

Validate the API contract together with the test corpus and readiness passport.