{"api":{"id":"quantum","name":"Quantum API","version":"0.1.0","icon":"quantum","description":"Production Quantum API with key lifecycle management and runtime endpoints for simulation and transformation workloads.","baseUrl":"https://davidjgrimsley.com/public-facing/api/quantum/v1","docsUrl":"https://davidjgrimsley.com/public-facing/api/quantum/docs","healthUrl":"https://davidjgrimsley.com/public-facing/api/quantum/v1/health","status":"active","featured":true,"tags":["quantum","simulation","security","api"],"uptime":"n/a"},"endpoints":[{"method":"POST","path":"/public-facing/api/quantum/v1/gates/run","operationPath":"/v1/gates/run","summary":"Gates Run","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"gate_type":"rotation","rotation_angle_rad":1.5708}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/circuits/run","operationPath":"/v1/circuits/run","summary":"Circuits Run","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"include_statevector":false,"num_qubits":2,"operations":[{"gate":"h","target":0},{"control":0,"gate":"cx","target":1}],"shots":1024}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/random","operationPath":"/v1/random","summary":"Generate a bounded random integer locally","description":"Inclusive signed 32-bit bounds. Uses Qiskit simulation or an explicitly labeled classical fallback.","auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"max":1,"min":0}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"GET","path":"/public-facing/api/quantum/v1/list_backends","operationPath":"/v1/list_backends","summary":"Get Backends","description":null,"auth":"api_key","parameters":[{"name":"provider","type":"string | null","required":false,"description":"","example":null,"enum":null,"dependsOn":null},{"name":"simulator_only","type":"boolean","required":false,"description":"","example":null,"enum":null,"dependsOn":null},{"name":"min_qubits","type":"integer","required":false,"description":"","example":null,"enum":null,"dependsOn":null},{"name":"ibm_profile","type":"string | null","required":false,"description":"","example":null,"enum":null,"dependsOn":null}],"requestBody":null,"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/transpile","operationPath":"/v1/transpile","summary":"Transpile","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"backend_name":"aer_simulator","circuit":{"num_qubits":2,"operations":[{"gate":"h","target":0},{"control":0,"gate":"cx","target":1}]},"optimization_level":1,"output_qasm_version":"3"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/qasm/export","operationPath":"/v1/qasm/export","summary":"Qasm Export","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"circuit":{"num_qubits":2,"operations":[{"gate":"h","target":0},{"control":0,"gate":"cx","target":1}]},"qasm_version":"3"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/qasm/import","operationPath":"/v1/qasm/import","summary":"Qasm Import","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"qasm":"OPENQASM 2.0; include \"qelib1.inc\"; qreg q[1]; h q[0];","qasm_version":"auto"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/qasm/run","operationPath":"/v1/qasm/run","summary":"Qasm Run","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"include_statevector":false,"qasm":"OPENQASM 2.0; include \"qelib1.inc\"; qreg q[2]; creg c[2]; h q[0]; cx q[0],q[1]; measure q[0] -> c[0]; measure q[1] -> c[1];","qasm_version":"auto","seed":7,"shots":1024}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/text/transform","operationPath":"/v1/text/transform","summary":"Text Transform","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"text":"Hello quantum world"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/jobs/circuits","operationPath":"/v1/jobs/circuits","summary":"Submit Circuit Job","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"backend_name":"ibm_kyiv","circuit":{"num_qubits":2,"operations":[{"gate":"h","target":0},{"control":0,"gate":"cx","target":1}]},"ibm_profile":"IBM Open","provider":"ibm","shots":1024}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/jobs/qasm","operationPath":"/v1/jobs/qasm","summary":"Submit Qasm Job","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"backend_name":"ibm_kyiv","ibm_profile":"IBM Open","provider":"ibm","qasm":"OPENQASM 2.0; include \"qelib1.inc\"; qreg q[2]; creg c[2]; h q[0]; cx q[0],q[1]; measure q[0] -> c[0]; measure q[1] -> c[1];","qasm_version":"auto","shots":1024}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/jobs/random","operationPath":"/v1/jobs/random","summary":"Submit a bounded IBM hardware random job","description":"Submits one measured Hadamard qubit on a non-simulator IBM backend. Poll the existing job status and result routes.","auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"backend_name":"ibm_kyiv","max":1,"min":0,"provider":"ibm"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"GET","path":"/public-facing/api/quantum/v1/jobs/{job_id}","operationPath":"/v1/jobs/{job_id}","summary":"Get Circuit Job","description":null,"auth":"api_key","parameters":[{"name":"job_id","type":"string","required":true,"description":"","example":null,"enum":null,"dependsOn":null}],"requestBody":null,"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/jobs/{job_id}/cancel","operationPath":"/v1/jobs/{job_id}/cancel","summary":"Cancel Circuit Job","description":null,"auth":"api_key","parameters":[{"name":"job_id","type":"string","required":true,"description":"","example":null,"enum":null,"dependsOn":null}],"requestBody":null,"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"GET","path":"/public-facing/api/quantum/v1/jobs/{job_id}/result","operationPath":"/v1/jobs/{job_id}/result","summary":"Get Circuit Job Result","description":null,"auth":"api_key","parameters":[{"name":"job_id","type":"string","required":true,"description":"","example":null,"enum":null,"dependsOn":null}],"requestBody":null,"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/algorithms/amplitude_estimation","operationPath":"/v1/algorithms/amplitude_estimation","summary":"Algorithms Amplitude Estimation","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"num_eval_qubits":2,"objective_qubits":[0],"seed":7,"shots":256,"state_preparation":{"num_qubits":1,"operations":[{"gate":"ry","target":0,"theta":1.2}]},"variant":"ae"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/algorithms/grover_search","operationPath":"/v1/algorithms/grover_search","summary":"Algorithms Grover Search","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"iterations":[1],"marked_bitstrings":["11"],"sample_from_iterations":false,"seed":7,"shots":256}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/algorithms/phase_estimation","operationPath":"/v1/algorithms/phase_estimation","summary":"Algorithms Phase Estimation","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"num_evaluation_qubits":3,"seed":7,"shots":256,"state_preparation":{"num_qubits":1,"operations":[{"gate":"h","target":0}]},"unitary":{"num_qubits":1,"operations":[{"gate":"z","target":0}]},"variant":"standard"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/algorithms/time_evolution","operationPath":"/v1/algorithms/time_evolution","summary":"Algorithms Time Evolution","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"hamiltonian":[{"coefficient":1.0,"pauli":"Z"}],"initial_state":{"num_qubits":1,"operations":[{"gate":"h","target":0}]},"num_timesteps":2,"seed":7,"shots":256,"time":0.5,"variant":"trotter_qrte"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/topological/braid","operationPath":"/v1/topological/braid","summary":"Topological Braid","description":"Evaluate a three-Fibonacci-anyon braid and optionally sample measurement.","auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"anyon_count":3,"braid_word":[{"generator":1,"power":1},{"generator":2,"power":1},{"generator":1,"power":-1}],"initial_state":"0","measure":true,"model":"fibonacci","seed":7,"shots":1,"total_charge":"tau"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/optimization/knapsack","operationPath":"/v1/optimization/knapsack","summary":"Optimization Knapsack","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"capacity":5,"item_values":[3,4,5],"item_weights":[2,3,4],"optimizer":{"maxiter":25,"name":"cobyla"},"reps":1,"seed":7,"shots":512,"solver":"exact"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/optimization/maxcut","operationPath":"/v1/optimization/maxcut","summary":"Optimization Maxcut","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"edges":[{"source":0,"target":1,"weight":1.5},{"source":1,"target":2,"weight":2.0},{"source":0,"target":2,"weight":0.5}],"num_nodes":3,"optimizer":{"maxiter":25,"name":"cobyla"},"reps":1,"seed":7,"shots":512,"solver":"qaoa"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/optimization/qaoa","operationPath":"/v1/optimization/qaoa","summary":"Optimization Qaoa","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"optimizer":{"maxiter":25,"name":"cobyla"},"problem":{"linear":[1.0,-2.0],"num_variables":2,"quadratic":[{"i":0,"j":1,"value":2.0}],"sense":"minimize"},"reps":1,"seed":7,"shots":512}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/optimization/tsp","operationPath":"/v1/optimization/tsp","summary":"Optimization Tsp","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"distance_matrix":[[0.0,10.0,15.0,20.0],[10.0,0.0,35.0,25.0],[15.0,35.0,0.0,30.0],[20.0,25.0,30.0,0.0]],"optimizer":{"maxiter":25,"name":"cobyla"},"reps":1,"seed":7,"shots":512,"solver":"exact"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/optimization/vqe","operationPath":"/v1/optimization/vqe","summary":"Optimization Vqe","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"ansatz":{"reps":1,"type":"real_amplitudes"},"optimizer":{"maxiter":25,"name":"cobyla"},"pauli_sum":[{"coefficient":1.0,"pauli":"ZI"},{"coefficient":-0.5,"pauli":"IZ"},{"coefficient":0.2,"pauli":"XX"}],"seed":7,"shots":512}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/experiments/quantum_volume","operationPath":"/v1/experiments/quantum_volume","summary":"Experiments Quantum Volume","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"qubits":[0,1],"seed":7,"shots":128,"trials":5}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/experiments/randomized_benchmarking","operationPath":"/v1/experiments/randomized_benchmarking","summary":"Experiments Randomized Benchmarking","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"num_samples":3,"qubits":[0],"seed":7,"sequence_lengths":[1,2,4,8],"shots":256}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/experiments/state_tomography","operationPath":"/v1/experiments/state_tomography","summary":"Experiments State Tomography","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"circuit":{"num_qubits":1,"operations":[{"gate":"h","target":0}]},"seed":7,"shots":512,"target_statevector":[{"imag":0.0,"real":0.70710678},{"imag":0.0,"real":0.70710678}]}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/experiments/t1","operationPath":"/v1/experiments/t1","summary":"Experiments T1","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"delays":[1e-6,2e-6,3e-6,4e-6],"qubits":[0],"seed":7,"shots":128}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/experiments/t2ramsey","operationPath":"/v1/experiments/t2ramsey","summary":"Experiments T2Ramsey","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"delays":[1e-6,2e-6,3e-6,4e-6,5e-6],"osc_freq":100000.0,"qubits":[0],"seed":7,"shots":128}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/finance/portfolio_diversification","operationPath":"/v1/finance/portfolio_diversification","summary":"Finance Portfolio Diversification","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"asset_labels":["ALPHA","BETA","GAMMA"],"num_clusters":2,"optimizer":{"maxiter":25,"name":"cobyla"},"reps":1,"seed":7,"shots":512,"similarity_matrix":[[1.0,0.2,0.3],[0.2,1.0,0.4],[0.3,0.4,1.0]],"solver":"exact"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/finance/portfolio_optimization","operationPath":"/v1/finance/portfolio_optimization","summary":"Finance Portfolio Optimization","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"budget":2,"covariance_matrix":[[0.05,0.01,0.02],[0.01,0.06,0.01],[0.02,0.01,0.04]],"expected_returns":[0.1,0.2,0.12],"optimizer":{"maxiter":25,"name":"cobyla"},"reps":1,"risk_factor":0.5,"seed":7,"shots":512,"solver":"qaoa"}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/ml/kernel_classifier","operationPath":"/v1/ml/kernel_classifier","summary":"Ml Kernel Classifier","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"feature_map":{"entanglement":"full","reps":1,"type":"zz_feature_map"},"prediction_features":[[0.1,0.2],[0.9,0.8]],"seed":7,"training_features":[[0.0,0.0],[0.0,1.0],[1.0,0.0],[1.0,1.0]],"training_labels":[0,1,1,0]}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/ml/qsvr_regressor","operationPath":"/v1/ml/qsvr_regressor","summary":"Ml Qsvr Regressor","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"feature_map":{"entanglement":"full","reps":1,"type":"zz_feature_map"},"prediction_features":[[0.1,0.2],[0.9,0.8]],"seed":7,"training_features":[[0.0,0.0],[0.0,1.0],[1.0,0.0],[1.0,1.0]],"training_targets":[0.0,1.0,1.0,0.0]}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/ml/vqc_classifier","operationPath":"/v1/ml/vqc_classifier","summary":"Ml Vqc Classifier","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"ansatz":{"entanglement":"reverse_linear","reps":1,"type":"real_amplitudes"},"feature_map":{"entanglement":"full","reps":1,"type":"zz_feature_map"},"optimizer":{"maxiter":25,"name":"cobyla"},"prediction_features":[[0.1,0.2],[0.9,0.8]],"seed":7,"training_features":[[0.0,0.0],[0.0,1.0],[1.0,0.0],[1.0,1.0]],"training_labels":[0,1,1,0]}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/nature/fermionic_mapping_preview","operationPath":"/v1/nature/fermionic_mapping_preview","summary":"Nature Fermionic Mapping Preview","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"ansatz":{"reps":1,"type":"real_amplitudes"},"atoms":[{"symbol":"H","x":0.0,"y":0.0,"z":0.0},{"symbol":"H","x":0.0,"y":0.0,"z":0.735}],"basis":"sto3g","charge":0,"mapper":"jordan_wigner","optimizer":{"maxiter":25,"name":"cobyla"},"seed":7,"spin":0}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"POST","path":"/public-facing/api/quantum/v1/nature/ground_state_energy","operationPath":"/v1/nature/ground_state_energy","summary":"Nature Ground State Energy","description":null,"auth":"api_key","parameters":null,"requestBody":{"description":"Request payload.","example":{"ansatz":{"reps":1,"type":"real_amplitudes"},"atoms":[{"symbol":"H","x":0.0,"y":0.0,"z":0.0},{"symbol":"H","x":0.0,"y":0.0,"z":0.735}],"basis":"sto3g","charge":0,"mapper":"jordan_wigner","optimizer":{"maxiter":25,"name":"cobyla"},"seed":7,"spin":0}},"responses":[{"code":"200","description":"Successful Response","example":null},{"code":"422","description":"Validation Error","example":null}]},{"method":"GET","path":"/public-facing/api/quantum/v1/health","operationPath":"/v1/health","summary":"Health","description":null,"auth":"public","parameters":null,"requestBody":null,"responses":[{"code":"200","description":"Successful Response","example":null}]},{"method":"GET","path":"/public-facing/api/quantum/v1/portfolio.json","operationPath":"/v1/portfolio.json","summary":"Portfolio Metadata","description":null,"auth":"public","parameters":null,"requestBody":null,"responses":[{"code":"200","description":"Successful Response","example":null}]},{"method":"GET","path":"/public-facing/api/quantum/v1/echo-types","operationPath":"/v1/echo-types","summary":"Echo Types (For a text-based Godot game)","description":"Lists the custom text-effect modes used by the Echoes Godot game integration.","auth":"api_key","parameters":null,"requestBody":null,"responses":[{"code":"200","description":"Successful Response","example":null}]}]}