Skip to main content
Introducing The Quantum Infrastructure Cloud Learn more
API reference

Two HTTP APIs, one header to authenticate

QCOS runs algorithms and error correction. QuantumLock signs and verifies artifacts and evaluates cryptographic inventories. Both take an API key in the X-API-Key header.

QCOS
api.softquantus.com
QuantumLock
quantumlock.softquantus.com
Authentication
X-API-Key header

Authentication

A key, a header, a status code

  1. 01

    Create a key

    Keys are created on the Softquantus Research Platform. A key for QuantumLock needs the quantumlock:use scope.

  2. 02

    Send it with the request

    Authenticated routes read the key from the X-API-Key header.

  3. 03

    Read the status

    A request without a key is answered 401, and nothing runs.

Follow one call

What happens to a request

The call below is the error correction request from further down this page. Switch off the key to see where it stops.

The client posts one JSON body to the QEC pipeline.

POST /api/v1/qec/pipeline

The response values come from the example run on the error correction page, on a CPU simulator.

QCOS

https://api.softquantus.com

MethodRouteWhat it does
POST/api/v1/qec/pipelineBuild an error-correcting code, extract its syndrome on a simulator and decode it with BP+OSD
POST/api/v1/algorithms/hybrid/runRun a hybrid quantum-classical algorithm, such as a portfolio QUBO
POST/api/v1/runtime/evidence/verifyVerify an evidence bundle
GET/api/v1/providers/healthReport provider health. Answers without a key

These are the routes the worked examples on this site use, not the complete reference. The full QCOS reference is at api.softquantus.com/docs and needs a key.

QuantumLock

https://quantumlock.softquantus.com

MethodRouteWhat it does
POST/api/v1/artifacts/signSign an artifact
POST/api/v1/artifacts/verifyVerify a signed artifact
POST/api/v1/cbomImport a CycloneDX 1.6 cryptographic bill of materials
POST/api/v1/cbom/{cbom_id}/evaluateEvaluate an imported inventory against a versioned policy pack
POST/api/v1/kms/sign/hybridSign with a classical and a post-quantum algorithm. Both signatures must verify
POST/api/v1/licenses/validateCheck that a licence exists, matches the customer, has not expired and has not been revoked

QuantumLock has no encryption or key-establishment API.

A full request

One call to the QEC pipeline

This request builds a distance-3 surface code, flips data qubit 4 and decodes the syndrome. The error correction page prints the response and explains each field.

Requestbash
curl -X POST https://api.softquantus.com/api/v1/qec/pipeline \
  -H "X-API-Key: $QCOS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "code_family": "surface",
    "code_distance": 3,
    "shots": 1024,
    "inject_error": { "type": "x", "qubit": 4 }
  }'

Beyond raw HTTP

Where to go next

Python client

Install the QCOS client with pip install softqcos-sdk.

SDKs and tools

Worked examples

Requests and answers for portfolio optimisation and error correction, with their limits stated.

Portfolio optimisation

SynapseX LLM API

SynapseX language models have their own API, keys and usage on the SynapseX LLM Console.

platform.synapsex.ai

Start with one request

Create a key, run the QEC pipeline on a simulator and check the residual syndrome yourself.