API Reference

Endpoint, request, response, error codes, and provenance schema for the live service at api.quantumsecuregateway.com.

Endpoints

Entropy

POST
/v1/entropy

Hardware-derived entropy with signed provenance per draw.

Reference

Verify

POST
/v1/verify

Verify entropy proofs against recorded provenance. Verified and Enterprise tiers only.

Audit Lookup

GET
/v1/audit/:id

Retrieve a single provenance record by ID. Verified and Enterprise tiers only.

Health Check

GET
/health

Service availability and status. No authentication required.

Encrypted Draw

POST
/v1/entropy/encrypted

Hybrid KEM (X25519 + ML-KEM-1024) with encrypted entropy payload. Private beta — contact us to join.

Request Access

POST
/v1/access/request

Submit a sandbox access request with workload details.

Provenance Schema (Summary)

The full schema reference ships with the API client SDKs. Field summary:

FieldTypeDescription
successbooleanDraw status
request_idstring (UUID)Unique request identifier
timestampstringISO 8601 response timestamp
data.formatstringOutput format (e.g. hex, base64)
data.lengthintegerBytes requested
data.entropystringThe drawn entropy payload
data.encodingstringPayload encoding
provenance.source_classstringSource class (e.g. hardware-derived)
provenance.source_idstringBackend source identifier
provenance.backend_classstringBackend class (e.g. quantum)
provenance.entropy_scorenumberEstimated min-entropy score
provenance.conditioningstringConditioning method applied
provenance.unique_statesintegerUnique quantum states
provenance.job_epochstringJob epoch identifier
fallback.is_fallbackbooleantrue when CSPRNG fallback engaged
fallback.reasonstring | nullFallback trigger reason, if any
audit.reservoir_remaining_bitsintegerRemaining reservoir bits
tierstringAuthenticated tier
rate_limit.remainingintegerRequests remaining in window
billingobjectUnits, weight, charged_units (Builder+)

Billing Model

Draws are billed per unit. A unit weight is computed from length (bytes requested) and the draw's source class:

Source ClassUnit WeightBilling Multiplier
hardware-derived1.0×Standard rate per tier
csprng-fallback0.25×Discounted — 25% of standard rate

Size weight: each draw is billed at ceil(length / 32) base units. A 32-byte draw is 1 unit; a 256-byte draw is 8 units.

Overage: when monthly usage exceeds the included units, additional draws are billed at the tier's published overage rate. See Pricing for tier breakdown.

Authentication

Authenticated endpoints accept a bearer token in the Authorization header:

Authorization: Bearer qsg_live_…

API keys are scoped to a single tier and a single billing account. Tier upgrades do not invalidate existing keys; new keys are issued and old keys remain valid until rotation.

For mTLS with customer-managed certificates, contact [email protected].

Get started

Sandbox keys provisioned automatically. Full response shape, full audit chain.