API REFERENCE

Submit jobs, run experiments, and query backends programmatically.

Authentication

All API requests require a Bearer token. Get your API key from your dashboard Settings > Security page.

bash

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://qubitboost.io/api/v1/jobs

Python SDK

bash

pip install qubitboost-sdk

Submit a quantum circuit and get governed results:

python

from qubitboost import QubitBoost

qb = QubitBoost(api_key="your-key-here")  # or set QUBITBOOST_API_KEY env var

# Submit a job
job = qb.submit(
    circuit=qasm_string,
    backend="ibm_fez",
    doom_threshold=0.25,
    shots=1000,
)
print(f"Job {job.id} submitted")

# Wait for results
result = job.wait(timeout=300)

print(f"Status: {result.status}")
print(f"Doom rate: {result.doom_rate}")
print(f"Cost: ${result.cost_usd:.4f}")

Qiskit Integration

Submit Qiskit circuits directly — QubitBoost handles OpenQASM conversion automatically. Both OpenQASM 2.0 and 3.0 formats are supported.

python

from qubitboost import QubitBoost
from qiskit import QuantumCircuit

qb = QubitBoost()

# Build your circuit in Qiskit
qc = QuantumCircuit(4)
qc.h(0)
for i in range(1, 4):
    qc.cx(0, i)
qc.measure_all()

# Submit directly — Qiskit circuits are auto-converted
job = qb.submit_qiskit(qc, backend="ibm_fez", shots=4000)
result = job.wait()
print(f"Doom rate: {result.doom_rate:.3f}")
print(f"Counts: {result.counts}")

Adversarial Testing

Test QEC decoder resilience against adversarial attack patterns. Multiple built-in and custom attack patterns are available.

Create custom attacks in the Research tab of your dashboard.

python

from qubitboost import QubitBoost

qb = QubitBoost()

# Run a QEC experiment with adversarial testing
exp = qb.experiment(
    decoder="pymatching",
    backend="ibm_fez",
    code_distance=5,
    episodes=1000,
    attack=True,
    attack_intensity=0.5,
)

print(f"Doom rate: {exp.doom_rate:.3f}")
print(f"Decoder vulnerability: {exp.decoder_vulnerability:.2f}")
print(f"Source: {exp.source}")

Endpoints

METHOD	PATH	DESCRIPTION
POST	/api/v1/jobs	Submit a quantum job for governed execution
GET	/api/v1/jobs/:id	Get job status and results
GET	/api/v1/jobs	List your recent jobs
POST	/api/v1/experiments	Run a research experiment (digital twin)
GET	/api/v1/experiments	List your experiments
GET	/api/v1/backends	List available backends and health
GET	/api/v1/health	Backend API health check

Rate Limits

TIER	REQUESTS	JOBS	BUDGET
Free	60/min	10/day	$1/mo
Pro	300/min	100/day	$100/mo
Academic	300/min	100/day	$500/mo
Enterprise	1000/min	Unlimited	Unlimited

Back to Documentation