Skip to main content

API Reference

Comprehensive API documentation for all Softquantus products.

QCOS API

Circuit orchestration and deployment

Base URL
https://api.softquantus.com/softqcos/v2

Endpoints

POST/circuits

Submit a new circuit

GET/circuits/{id}

Get circuit status

GET/circuits/{id}/results

Get execution results

DELETE/circuits/{id}

Cancel circuit execution

GET/providers

List available providers

GET/providers/{id}/status

Get provider status

Current Version

v2.5

Official SDKs

Python
v2.5.0
JavaScript/TypeScript
v2.5.0
Go
v2.4.0
Rust
v2.3.0
View all SDKs →

Quick Start

example.py
from softquantus import QCOS

# Initialize client
client = QCOS(api_key="your-api-key")

# Submit a circuit
result = client.circuits.create(
    qasm="""
    OPENQASM 3.0;
    qubit[2] q;
    h q[0];
    cx q[0], q[1];
    measure q;
    """,
    provider="ibm",
    shots=1000
)

# Get results
print(result.counts)
# {'00': 512, '11': 488}