HomeDocsLearnCoursesAPIExtensionsPublicationsBlogEventsContributeFAQ
API Reference

REST API & SDK Reference

Full API reference for the Olewin Studio REST API (v2) and Python SDK. Build integrations, automate workflows, and connect quantum circuits to your applications.

● API v2.5 · Live
Base URL: https://api.olewin.studio/v2

Authentication

All API requests must include your Olewin API key in the Authorization header.

Authorization: Bearer YOUR_OLEWIN_API_KEY

# Python SDK
from olewin import OlewinClient
client = OlewinClient(api_key="YOUR_OLEWIN_API_KEY")

# Environment variable (recommended)
export OLEWIN_API_KEY="your_key_here"
POST/api/v2/circuits/run
Execute Quantum Circuit

Submit a quantum circuit for execution on a specified backend.

Request Body
{
  "circuit": "OPENQASM 3.0; ...",
  "backend": "ibm_eagle",
  "shots": 1024,
  "optimization_level": 2,
  "error_mitigation": true
}
Response
{
  "job_id": "qjob_8f2a3b91c",
  "status": "QUEUED",
  "estimated_time": 42,
  "backend": "ibm_eagle_127",
  "qubits_used": 20
}
GET/api/v2/jobs/{job_id}
Get Job Status & Results

Poll the status of a submitted quantum job and retrieve results.

Response
{
  "job_id": "qjob_8f2a3b91c",
  "status": "COMPLETED",
  "counts": {"0000": 489, "1111": 535},
  "execution_time": 38.2,
  "fidelity": 0.962,
  "error_rate": 0.038
}
POST/api/v2/simulate/vqe
Run VQE Optimization

Execute Variational Quantum Eigensolver for molecular energy minimization.

Request Body
{
  "molecule": "H2O",
  "basis_set": "sto-3g",
  "ansatz": "UCCSD",
  "optimizer": "COBYLA",
  "max_iterations": 200,
  "backend": "aer_simulator"
}
Response
{
  "ground_state_energy": -76.243,
  "unit": "Hartree",
  "convergence": true,
  "iterations": 147,
  "final_parameters": [0.234, -0.891, 1.204, ...]
}
POST/api/v2/chemistry/molecular-sim
Molecular Simulation

Run full quantum chemistry simulation for drug discovery and materials science.

Request Body
{
  "smiles": "CC(=O)Oc1ccccc1C(=O)O",
  "target_protein": "ACE2",
  "qubits": 20,
  "simulation_type": "vqe",
  "noise_model": "ibm_eagle"
}
Response
{
  "binding_energy": -8.34,
  "unit": "kcal/mol",
  "docking_score": 0.874,
  "quantum_advantage": 234.5,
  "recommended": true
}
GET/api/v2/backends
List Available Backends

Retrieve a list of all available quantum hardware backends and their current status.

Response
{
  "backends": [
    {"name": "ibm_eagle", "qubits": 127, "status": "online", "queue": 3},
    {"name": "ionq_aria", "qubits": 25, "status": "online", "queue": 0},
    {"name": "google_sycamore", "qubits": 53, "status": "maintenance"},
    {"name": "local_simulator", "qubits": 32, "status": "online", "queue": 0}
  ]
}
POST/api/v2/qkd/bb84
Quantum Key Distribution

Simulate BB84 or E91 quantum key distribution protocol.

Request Body
{
  "protocol": "BB84",
  "key_length": 256,
  "channel_noise": 0.02,
  "eavesdropping_detection": true
}
Response
{
  "shared_key": "a3f8...",
  "key_length": 256,
  "qber": 0.018,
  "secure": true,
  "quantum_random": true
}