SoftQCOS™ SDK v3.5

Typed, synchronous Python client for the SoftQuantus QCOS™ API Gateway. Covers the documented product surface; it is not a wrapper over every mounted route.

pip install softqcos-sdk

Quick Start

from softqcos_sdk import QCOSClient

client = QCOSClient(api_key="sk-...")

# Submit a quantum job
job = client.jobs.submit(qasm="OPENQASM 2.0; ...", shots=1024)
result = client.jobs.wait(job["job_id"])
print(result["result"]["counts"])

# Or use the blocking shortcut
result = client.jobs.execute(qasm="OPENQASM 2.0; ...", shots=1024)

Product APIs

Async Client

Not available. There is no AsyncQCOSClient; importing it raises ImportError. Every method on QCOSClient is synchronous.

QCOSClient does define __aenter__ / __aexit__, so async with QCOSClient(...) enters without complaint — but the first await client.jobs.submit(...) fails, because submit is not a coroutine. Do not rely on that context manager as evidence of async support.

Run the client in a thread if you need it off the event loop:

import asyncio
from softqcos_sdk import QCOSClient

client = QCOSClient(api_key="sk-...")
result = await asyncio.to_thread(
    client.jobs.execute, qasm="OPENQASM 2.0; ...", shots=1024
)

Configuration

Examples

# Calibration
devices = client.calibration.devices()
state = client.calibration.device_state("ibm_brisbane")

# Benchmarking
report = client.bench.run(backend="aer_simulator", suite="standard")
client.bench.verify(report["benchmark_id"])

# DRI — Device Reliability Index
dri = client.dri.run(backend="ibm_brisbane")
proof = client.dri.proof_run(backend="ibm_brisbane")

# Billing & ROI
estimate = client.billing.calculate(backend="ibm_brisbane", shots=10000)
plans = client.billing.plans()

# NavCore — GNSS/PNT
#
# Post-quantum signatures work: liboqs 0.16.0 is built into the API image, and
# navcore.algorithms() reports per scheme what the deployment can sign with.
# The keys are client-held — pqc_keypair returns the private key once, the
# server keeps no copy, and pqc_sign takes it back as a request field.
kp = client.navcore.pqc_keypair(algorithm="ml-dsa-65")
sig = client.navcore.pqc_sign(
    message=b64_message, private_key=kp["private_key"], key_id=kp["key_id"]
)
ok = client.navcore.pqc_verify(
    message=b64_message,
    signature=sig["signature"],
    public_key=kp["public_key"],
    algorithm=sig["mechanism"],   # the exact mechanism, matched exactly
)["valid"]
#
# Two calls were listed here that do not work against the deployed service and
# have been removed rather than left as examples:
#   navcore.navigate(...)      -> the route does not exist (404)
#   navcore.qrng_bytes(...)    -> 503, the QRNG backend is not configured
# The read-only NavCore endpoints under /api/v1/navcore/* respond normally.

# Network — Multi-QPU
topo = client.network.topology()
# network.teleport(...) is omitted deliberately: the endpoint accepts a request
# but does not complete a teleport against real nodes. Do not build on it yet.

# Error handling
from softqcos_sdk import QCOSError, AuthenticationError, RateLimitError

try:
    result = client.jobs.submit(qasm="invalid")
except RateLimitError as e:
    print(f"Rate limited — retry after {e.retry_after}s")
except AuthenticationError:
    print("Invalid API key")
except QCOSError as e:
    print(f"API error: {e}")

License

Copyright © 2024-2026 SoftQuantus innovative OÜ. All Rights Reserved.

QCOS™ is a trademark of SoftQuantus innovative OÜ. Registry Code: 17048927 | Tallinn, Estonia

• License: https://softquantus.com/legal/license
• EULA: https://softquantus.com/legal/eula
• Portal: https://platform.softquantus.com