Production Quantum API with key lifecycle management and runtime endpoints for simulation and transformation workloads.
Features
- True randomness from quantum measurement
- Simulator-backed requests work without IBM credentials
- BYO IBM credentials unlock hardware workflows
- Interactive endpoint testing from the portfolio page
- Runtime proxy support for production web clients
Plugin & package docs
Use the beginner-friendly guide for specific integration guidance. Every guide has a matching Markdown file that coding agents can read directly.
Endpoints
POST
/v1/gates/run
▶
Gates Run
Requires API key
POST
/v1/circuits/run
▶
Circuits Run
Requires API key
POST
/v1/random
▶
Generate a bounded random integer locally
Requires API key
GET
/v1/list_backends
▶
Get Backends
Requires API key
POST
/v1/transpile
▶
Transpile
Requires API key
POST
/v1/qasm/export
▶
Qasm Export
Requires API key
POST
/v1/qasm/import
▶
Qasm Import
Requires API key
POST
/v1/qasm/run
▶
Qasm Run
Requires API key
POST
/v1/text/transform
▶
Text Transform
Requires API key
POST
/v1/jobs/circuits
▶
Submit Circuit Job
Requires API key
POST
/v1/jobs/qasm
▶
Submit Qasm Job
Requires API key
POST
/v1/jobs/random
▶
Submit a bounded IBM hardware random job
Requires API key
GET
/v1/jobs/{job_id}
▶
Get Circuit Job
Requires API key
POST
/v1/jobs/{job_id}/cancel
▶
Cancel Circuit Job
Requires API key
GET
/v1/jobs/{job_id}/result
▶
Get Circuit Job Result
Requires API key
POST
/v1/algorithms/amplitude_estimation
▶
Algorithms Amplitude Estimation
Requires API key
POST
/v1/algorithms/grover_search
▶
Algorithms Grover Search
Requires API key
POST
/v1/algorithms/phase_estimation
▶
Algorithms Phase Estimation
Requires API key
POST
/v1/algorithms/time_evolution
▶
Algorithms Time Evolution
Requires API key
POST
/v1/topological/braid
▶
Topological Braid
Requires API key
POST
/v1/optimization/knapsack
▶
Optimization Knapsack
Requires API key
POST
/v1/optimization/maxcut
▶
Optimization Maxcut
Requires API key
POST
/v1/optimization/qaoa
▶
Optimization Qaoa
Requires API key
POST
/v1/optimization/tsp
▶
Optimization Tsp
Requires API key
POST
/v1/optimization/vqe
▶
Optimization Vqe
Requires API key
POST
/v1/experiments/quantum_volume
▶
Experiments Quantum Volume
Requires API key
POST
/v1/experiments/randomized_benchmarking
▶
Experiments Randomized Benchmarking
Requires API key
POST
/v1/experiments/state_tomography
▶
Experiments State Tomography
Requires API key
POST
/v1/experiments/t1
▶
Experiments T1
Requires API key
POST
/v1/experiments/t2ramsey
▶
Experiments T2Ramsey
Requires API key
POST
/v1/finance/portfolio_diversification
▶
Finance Portfolio Diversification
Requires API key
POST
/v1/finance/portfolio_optimization
▶
Finance Portfolio Optimization
Requires API key
POST
/v1/ml/kernel_classifier
▶
Ml Kernel Classifier
Requires API key
POST
/v1/ml/qsvr_regressor
▶
Ml Qsvr Regressor
Requires API key
POST
/v1/ml/vqc_classifier
▶
Ml Vqc Classifier
Requires API key
POST
/v1/nature/fermionic_mapping_preview
▶
Nature Fermionic Mapping Preview
Requires API key
POST
/v1/nature/ground_state_energy
▶
Nature Ground State Energy
Requires API key
GET
/v1/health
▶
Health
Public endpoint
GET
/v1/portfolio.json
▶
Portfolio Metadata
Public endpoint
GET
/v1/echo-types
▶
Echo Types (For a text-based Godot game)
Requires API key
What is Quantum Mechanics?
>
How to Use This API
>
Code Examples
This example calls a runtime endpoint with an API key generated from the dashboard.
const response = await fetch(
'https://davidjgrimsley.com/api/public/quantum/v1/gates/run',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': '<your_api_key>'
},
body: JSON.stringify({
gate_type: 'rotation',
rotation_angle_rad: Math.PI / 2
})
}
);
const result = await response.json();
console.log('Measurement:', result.measurement);
Live Demo
This is the actual quantum animation from my Quantum Echo project. It makes live calls through the same API surface documented above.
Technical Details
Status
active
Uptime
n/a
Data Loaded
2026-10-16T14:17:21.218Z (live)
Portfolio Metadata
https://davidjgrimsley.com/api/public/quantum/v1/portfolio.jsonFeedback, contributions, comments, and questions
Questions, corrections, and issue reports are welcome.
MrDJ@DavidJGrimsley.comhttps://github.com/davidjgrimsley/quantum-api/issuesAgent version (.md)
Coding agents can use the plain Markdown guide for lower-noise context, then follow the links to each integration guide.
/public-facing/api/quantum.md/llms.txtSynced from https://davidjgrimsley.com/api/public/quantum/v1/portfolio.json