Skip to content

Developer portal

JSON schemas

Imported from backend/contracts — the docs cannot drift from what the API validates.

Optimize request

optimize-request.schema.json

object
type *stringenum: schedule, routing, allocation
dataobject
array
itemsstring
array
object
array
object
array
object
array
object
array
object

Optimize response

optimize-response.schema.json

object
status *string
summary *string
solution *any
object
constraintViolations *integer
makespanDaysinteger
totalCostinteger | number
savingsEstimate *string
method *stringenum: classical, hybrid
object
solver *string
backend *string
diagnosticsobject
visualizationobject | null

PQC scan request

pqc-scan-request.schema.json

object
scenarioIdstring
useFixtureboolean
targetstring | null
seedinteger
bundleSessionIdstring | null
depthstring | null

PQC scan response

pqc-scan-response.schema.json

object
status *stringenum: success, running, error
scanIdstring
scenarioobject
assetsarray
remediationBacklogarray
scoreboardobject
handshakeProofobject
reportobject
moscaobject
timelinearray
detailsobject

CBOM ingest request

pqc-cbom-ingest-request.schema.json

object
document *object
sourceLabelstring
verificationStatusstringenum: verified, imported, unverified-source

CBOM ingest response

pqc-cbom-ingest-response.schema.json

object
status *stringenum: success
ok *boolean
idempotentboolean
ingestJobIdstring
sourceIdstring
componentCountinteger
newComponentsinteger
dedupedCountinteger
conflictCountinteger

Verify response

pqc-verify-response.schema.json

object
status *stringenum: success
scanIdstring
object
valid *boolean
algstring
keyFingerprintstring
contentHash *string
signedAtstring
reasonstring
object
readinessBandstring
targetDomainstring