Skip to main content

QCOS REST API Reference

Complete REST API documentation for the Quantum Circuit Optimization Service.

Version: 2.1.0 · Base URL: https://api.softquantus.com · Endpoints: 293 · Auth: Authorization: Bearer sk-...

Authentication​

curl -H "Authorization: Bearer $QCOS_API_KEY" \
     -H "Content-Type: application/json" \
     https://api.softquantus.com/api/v2/jobs
StatusMeaning
401Invalid API key
403Insufficient permissions
422Validation error
429Rate limited (Retry-After header)
500Server error

Jobs​

MethodPathDescription
POST/api/v2/jobsSubmit a job
GET/api/v2/jobsList jobs
GET/api/v2/jobs/{job_id}Get job details
GET/api/v2/jobs/{job_id}/resultsGet results
DELETE/api/v2/jobs/{job_id}Cancel job
GET/api/v2/jobs/{job_id}/evidenceGet evidence
GET/api/v2/jobs/{job_id}/bundleGet full bundle
POST/api/v2/jobs/{job_id}/verifyVerify evidence

Submit Job​

curl -X POST https://api.softquantus.com/api/v2/jobs \
  -H "Authorization: Bearer $QCOS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"qasm": "OPENQASM 2.0; ...", "shots": 1024, "backend": "aer_simulator"}'

Response (201):

{
  "job_id": "job-abc123",
  "status": "queued",
  "backend": "aer_simulator",
  "shots": 1024,
  "created_at": "2025-02-01T12:00:00Z"
}

Get Results​

curl https://api.softquantus.com/api/v2/jobs/job-abc123/results \
  -H "Authorization: Bearer $QCOS_API_KEY"
{
  "job_id": "job-abc123",
  "status": "completed",
  "counts": {"00": 512, "11": 512},
  "shots": 1024
}

Circuits​

MethodPathDescription
POST/api/v2/circuitsSubmit circuit
GET/api/v2/circuitsList circuits
GET/api/v2/circuits/{id}Get circuit
DELETE/api/v2/circuits/{id}Delete circuit
POST/api/v2/circuits/validateValidate syntax
POST/api/v2/circuits/convertConvert format
GET/api/v2/circuits/{id}/statsCircuit statistics
POST/api/v2/optimizeOptimize circuit
POST/api/v2/simulateSimulate circuit

Backends (BYOB™)​

User Backends​

MethodPathDescription
GET/api/v2/backends/providersList providers
GET/api/v2/backendsList backends
GET/api/v2/backends/{id}Get backend
POST/api/v2/backendsRegister backend
PUT/api/v2/backends/{id}Update
DELETE/api/v2/backends/{id}Remove
POST/api/v2/backends/validateValidate credentials
POST/api/v2/backends/executeExecute
GET/api/v2/backends/allAll backends

IBM Quantum​

MethodPathDescription
GET/api/v2/ibm/backendsList backends
POST/api/v2/ibm/estimateEstimate cost
POST/api/v2/ibm/executeExecute
GET/api/v2/ibm/status/{id}Job status
DELETE/api/v2/ibm/jobs/{id}Cancel

Azure Quantum​

MethodPathDescription
GET/api/v2/azure/providersProviders
GET/api/v2/azure/targetsTargets
GET/api/v2/azure/backendsBackends
POST/api/v2/azure/estimateEstimate
POST/api/v2/azure/executeExecute
GET/api/v2/azure/status/{id}Status
DELETE/api/v2/azure/jobs/{id}Cancel

AWS Braket​

MethodPathDescription
GET/api/v2/braket/backendsBackends
POST/api/v2/braket/estimateEstimate
POST/api/v2/braket/executeExecute
GET/api/v2/braket/status/{id}Status
DELETE/api/v2/braket/jobs/{id}Cancel

Bench (QCOS Bench™)​

MethodPathDescription
POST/api/v2/bench/runRun benchmark
GET/api/v2/bench/report/{id}Get report
GET/api/v2/bench/report/{id}/downloadDownload PDF
GET/api/v2/bench/suitesList suites
GET/api/v2/bench/suites/{id}Get suite
GET/api/v2/bench/workloadsList workloads
POST/api/v2/bench/verifyVerify evidence
GET/bench/healthService health
GET/bench/selftestSelf-test
GET/bench/metrics/coverageCoverage metrics
GET/bench/metrics/kpisKPI metrics

Calibration (GlassBox™)​

MethodPathDescription
GET/api/v2/glassbox/healthHealth
GET/api/v2/glassbox/infoService info
GET/api/v2/glassbox/devicesList devices
GET/api/v2/glassbox/devices/{name}/stateDevice state
GET/api/v2/glassbox/devices/{name}/qubits/{id}Qubit data
POST/api/v2/glassbox/compileCompile circuit
GET/api/v2/glassbox/compile/{id}Compile status
POST/api/v2/glassbox/evidence/createCreate evidence
GET/api/v2/glassbox/evidence/{id}Get evidence
POST/api/v2/glassbox/evidence/verifyVerify
POST/api/v2/glassbox/evidence/{id}/signSign
POST/api/v2/glassbox/evidence/{id}/finalizeFinalize
GET/api/v2/glassbox/evidence/{id}/audit-trailAudit trail

Get Device State​

curl https://api.softquantus.com/api/v2/glassbox/devices/ibm_brisbane/state \
  -H "Authorization: Bearer $QCOS_API_KEY"
{
  "device_name": "ibm_brisbane",
  "num_qubits": 127,
  "t1": 245.3,
  "t2": 178.9,
  "readout_error": 0.012,
  "gate_errors": {"cx": 0.008, "sx": 0.0003},
  "last_calibration": "2025-02-01T08:00:00Z"
}

Billing (ROI Engine™)​

MethodPathDescription
GET/api/v2/roi/providersList providers
GET/api/v2/roi/pricebookFull pricebook
GET/api/v2/roi/plansSubscription plans
POST/api/v2/roi/calculateCost estimate
POST/api/v2/roi/calculate/scenariosMulti-scenario
GET/api/v2/roi/compare-providersCompare providers
POST/api/v2/roi/report/dataReport data
POST/api/v2/roi/report/pdfReport PDF
POST/api/v2/roi/report/latexReport LaTeX

Network (QuantumNet™)​

MethodPathDescription
GET/api/v1/network/healthHealth
GET/api/v1/network/statusStatus
GET/api/v1/network/topologyTopology
GET/api/v1/network/backendsBackends
POST/api/v1/network/entangleEntangle qubits
POST/api/v1/network/teleportTeleport state
POST/api/v1/network/remote-cnotRemote CNOT
POST/api/v1/network/barrierBarrier
GET/api/v1/network/phase0/ion-speciesIon species
POST/api/v1/network/phase0/sweepPhase 0 sweep
POST/api/v1/network/phase0b/analyzePhase 0b analyze
POST/api/v1/network/phase0b/recommendPhase 0b recommend
GET/api/v1/network/jobsList jobs
GET/api/v1/network/jobs/{id}/statusJob status
GET/api/v1/network/jobs/{id}/resultJob result
GET/api/v1/network/jobs/{id}/evidenceJob evidence
GET/api/v1/network/evidence/{id}Evidence
GET/api/v1/network/evidence/bundle/{id}Evidence bundle

QEC Runtime™​

MethodPathDescription
GET/api/v1/qec/healthHealth
GET/api/v1/qec/codes/catalogList codes
GET/api/v1/qec/codes/{id}Get code
POST/api/v1/qec/codes/createCreate code
POST/api/v1/qec/decoder/decodeDecode syndrome
POST/api/v1/qec/syndrome/extractExtract syndrome
POST/api/v1/qec/pbc/compileCompile PBC
POST/api/v1/qec/pipelineFull pipeline
GET/api/v1/qec/isolation/zonesList zones
GET/api/v1/qec/isolation/zones/{id}Get zone
POST/api/v1/qec/isolation/zonesCreate zone
DELETE/api/v1/qec/isolation/zones/{id}Delete zone
POST/api/v1/qec/isolation/certifyCertify
GET/api/v1/qec/isolation/evidence/{id}Evidence
GET/api/v1/qec/isolation/certificatesCertificates

Isolation (ZoneGuard™)​

MethodPathDescription
GET/api/v1/isolation/healthHealth
GET/api/v1/isolation/crosstalkCrosstalk matrix
GET/api/v1/isolation/zonesList zones
GET/api/v1/isolation/zones/{id}Get zone
POST/api/v1/isolation/allocateAllocate zone
POST/api/v1/isolation/executeExecute in zone
DELETE/api/v1/isolation/zones/{id}Delete zone
GET/api/v1/isolation/evidence/{id}Evidence

DRI™​

MethodPathDescription
GET/api/v1/dri/healthHealth
POST/api/v1/dri/runRun assessment
POST/api/v1/dri/probeRun probe
GET/api/v1/dri/listList assessments
GET/api/v1/dri/report/{id}Get report
GET/api/v1/dri/summary/{id}Get summary
GET/api/v1/dri/evidence/{id}Get evidence
POST/api/v1/dri/proof/runProof-of-quantum
GET/api/v1/dri/proof/{id}Get proof
GET/api/v1/dri/proof/{id}/reportProof report
GET/api/v1/dri/proof/{id}/certificate.pdfCertificate PDF
POST/api/v1/dri/proof/compareCompare proofs
GET/api/v1/dri/proof/compare/{id}Comparison result
GET/api/v1/dri/proof/compare/{id}/certificate.pdfComparison PDF

Ledger (QuantumLedger™)​

MethodPathDescription
GET/api/v1/ledger/jobsMetered jobs
GET/api/v1/ledger/jobs/{id}Job details
GET/api/v1/ledger/tenantsList tenants
GET/api/v1/ledger/tenants/{id}Get tenant
POST/api/v1/ledger/tenantsCreate tenant
GET/api/v1/ledger/budgetsList budgets
GET/api/v1/ledger/budgets/{id}Get budget
POST/api/v1/ledger/budgetsCreate budget
GET/api/v1/ledger/projectsList projects
POST/api/v1/ledger/projectsCreate project
GET/api/v1/ledger/pricingPricing
POST/api/v1/ledger/estimateEstimate cost
GET/api/v1/ledger/provenance/{id}Provenance
GET/api/v1/ledger/reports/usageUsage report
POST/api/v1/ledger/reports/auditAudit report
POST/api/v1/ledger/reports/chargebackChargeback

Core Navigation​

MethodPathDescription
GET/api/v1/navcore/statusStatus
GET/api/v1/navcore/algorithmsAlgorithms
POST/api/v1/navcore/navigateCompute position
POST/api/v1/navcore/spoof-detectDetect spoofing
POST/api/v1/navcore/sensor/simulateSimulate sensor

QRNG​

MethodPathDescription
POST/api/v1/quantum-gps/qrng/bytesRandom bytes
GET/api/v1/quantum-gps/qrng/uuidQuantum UUID
GET/api/v1/quantum-gps/qrng/nonceQuantum nonce

PQC​

MethodPathDescription
POST/api/v1/pqc/keypairGenerate keypair
POST/api/v1/pqc/signSign data
POST/api/v1/pqc/verifyVerify signature

RAIM​

MethodPathDescription
GET/api/v1/raim/statusStatus
GET/api/v1/raim/threatsThreats
POST/api/v1/raim/processProcess
POST/api/v1/raim/excludeExclude satellite
GET/api/v1/raim/statisticsStatistics
GET/api/v1/raim/quantum-verificationQuantum verification
GET/api/v1/raim/hybrid-fusionHybrid fusion

Time & Standards​

MethodPathDescription
GET/api/v1/navcore/time/utcUTC time
GET/api/v1/navcore/time/networkNetwork time
POST/api/v1/navcore/time/syncSync time

ACOS-ISA™​

MethodPathDescription
GET/api/v1/acos/healthHealth
GET/api/v1/acos/tiersCertification tiers
GET/api/v1/acos/testsList tests
POST/api/v1/acos/certifyRun certification
POST/api/v1/acos/verifyVerify certificate
GET/api/v1/acos/certificatesList certificates
GET/api/v1/acos/certificates/{id}Get certificate
GET/api/v1/acos/evidence/{id}Evidence

Quantum Macro™​

MethodPathDescription
GET/api/v1/macro/healthHealth
GET/api/v1/macro/market-sizingMarket analysis
POST/api/v1/macro/energy-subsidy-optimizeEnergy optimization
POST/api/v1/macro/risk-analysisRisk analysis

Evidence Portal™​

MethodPathDescription
GET/api/v2/jobs/{id}/artifactsList artifacts
GET/api/v2/jobs/{id}/artifacts/{name}Get artifact
GET/api/v2/jobs/{id}/capabilitiesCapabilities
GET/api/v2/jobs/{id}/evidence/downloadDownload bundle
POST/api/v2/evidence/verifyVerify hash
GET/api/v2/public-keyPublic key (PEM)

Admin​

MethodPathDescription
GET/api/admin/health/readyReadiness
GET/api/admin/health/liveLiveness
GET/api/admin/tenantsList tenants
GET/api/admin/tenants/{id}/usageTenant usage
GET/api/admin/metricsMetrics
GET/api/admin/rate-limitsRate limits
GET/api/admin/circuit-breakersCircuit breakers
POST/api/admin/circuit-breakers/{name}/resetReset breaker
GET/api/admin/backends/statusBackends status
GET/api/admin/backends/{id}/capabilitiesCapabilities

Interactive Documentation​

© 2024-2026 SoftQuantus Innovative OÜ. All Rights Reserved.