Quantum Simulation API Reference

Execute the current circuit DSL over HTTP and inspect exact state probabilities, seeded measurements and generated diagrams.

Documentation version: 2.1 · Compatible with: current AutomationGlance simulator · Last reviewed: 2026-10-17

Open API playground · Full DSL specification →

Endpoint and host

POST /api/runSimulation with Content-Type: application/json. On the live site, frontend/config/settings.js sets the API base to https://quantum-playground-flex-gag3cjd5aedvf6dz.southindia-01.azurewebsites.net. Append the endpoint to that host; the site's https://automationglance.com/api/ serves this documentation. Azure Functions local development normally uses port 7071; the repository integration fixture uses 7073.

Request fields

Field names are case-insensitive. Unknown fields, malformed JSON, comments and trailing commas are rejected by payload validation. Send each field once. No noise, backend, format, or gate-definition option is supported by this endpoint. No API key is required by this controller; deployment infrastructure may add restrictions.

{
  "circuit": "qubits 2\nH 0\nCX 0 1\nMEASURE 0\nMEASURE 1",
  "shots": 1024,
  "seed": 42,
  "sessionId": "documentation-local-session"
}

The example session is for the local fixture. Use your own existing session for a monetized deployment; examples do not bypass usage limits. Invalid DSL is parsed after the simulator quota guard, so an unsuccessful DSL execution can consume a run.

Successful response (HTTP 200)

For the Bell request, probabilities are 0.5 for 00 and 11 and zero for 01 and 10, up to floating-point roundoff. Each qubit's Bloch vector is (0,0,0). Counts sum to shots but need not split equally. Do not interpret the statevector as the result of physical hardware execution.

Full-state labels put q0 leftmost. Counts follow MEASURE statement order and may have a different width. All gates run before sampling; no mid-circuit feedback. See measurement ordering.

HTTP errors

Error objects include error and correlationId; detail or message may be present. DSL failure includes parse_errors; do not assume the success response's errors field. A width error also supplies requested and limit. A quota error supplies paymentEndpoint. Preserve the correlation ID when diagnosing failures.

Limits and reproducibility

Execution: 1–8 qubits and 1–100,000 shots. Checked-in security defaults: 1,048,576 request bytes, 10,000 characters per string, and 60 requests per 60-second window per client (normally IP). These security settings are deployment-configurable; they are not a guarantee of production quota. This controller has no separate gate-count limit; circuit text is bounded by request limits. Session usage limits are separate from rate limits.

Explicit seed controls only sampling. Otherwise 32-bit FNV-1a hashes UTF-8 bytes of the exact circuit + "|" + shots string. Editing whitespace or shots changes the derived seed. Metadata returns the seed and backend version; reproducibility assumes the same circuit, shots, seed and backend/runtime. Probabilities and amplitudes are deterministic ideal calculations independent of seed.

Executable client examples

These examples use the local fixture by default. Set AUTOMATIONGLANCE_API_BASE to your API host and AUTOMATIONGLANCE_SESSION_ID to your existing session for another deployment. Each checks HTTP failure before using results.

curl (bash and Python 3 for JSON encoding)

Download curl (bash and Python 3 for JSON encoding) example

#!/usr/bin/env bash
set -euo pipefail
# Point to your API host; the local integration fixture listens on port 7073.
: "${AUTOMATIONGLANCE_API_BASE:=http://127.0.0.1:7073}"
: "${AUTOMATIONGLANCE_SESSION_ID:=documentation-local-session}"
# Generate JSON safely; never interpolate arbitrary input into a JSON string.
python3 - <<'JSON' | curl --fail-with-body -sS "$AUTOMATIONGLANCE_API_BASE/api/runSimulation" -H 'Content-Type: application/json' --data-binary @-
import json, os
print(json.dumps({"circuit": "qubits 2\nH 0\nCX 0 1\nMEASURE 0\nMEASURE 1", "shots": 1024, "seed": 42,
                  "sessionId": os.environ.get("AUTOMATIONGLANCE_SESSION_ID", "documentation-local-session")}))
JSON

C# (.NET 10)

Download C# (.NET 10) example

#:property PublishAot=false
// .NET 10 file-based app: dotnet run --file csharp.cs
using System.Net.Http.Json;
using System.Text.Json;
var baseUrl = Environment.GetEnvironmentVariable("AUTOMATIONGLANCE_API_BASE") ?? "http://127.0.0.1:7073";
var payload = new {
    circuit = "qubits 2\nH 0\nCX 0 1\nMEASURE 0\nMEASURE 1", shots = 1024, seed = 42,
    sessionId = Environment.GetEnvironmentVariable("AUTOMATIONGLANCE_SESSION_ID") ?? "documentation-local-session"
};
using var client = new HttpClient();
using var response = await client.PostAsJsonAsync(baseUrl + "/api/runSimulation", payload);
var body = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode) throw new HttpRequestException($"{(int)response.StatusCode}: {body}");
using var result = JsonDocument.Parse(body);
Console.WriteLine(result.RootElement.GetRawText());

JavaScript (Node.js 18+)

Download JavaScript (Node.js 18+) example

// Node.js 18+; for browser code use window.API_BASE and your existing session ID.
const base = process.env.AUTOMATIONGLANCE_API_BASE || 'http://127.0.0.1:7073';
const payload = {
  circuit: 'qubits 2\nH 0\nCX 0 1\nMEASURE 0\nMEASURE 1', shots: 1024, seed: 42,
  sessionId: process.env.AUTOMATIONGLANCE_SESSION_ID || 'documentation-local-session'
};
const response = await fetch(`${base}/api/runSimulation`, {
  method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify(payload)
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
console.log(JSON.stringify(await response.json()));

Python 3

Download Python 3 example

# Python 3 standard library.
import json, os, urllib.request, urllib.error
base = os.environ.get("AUTOMATIONGLANCE_API_BASE", "http://127.0.0.1:7073")
payload = {"circuit": "qubits 2\nH 0\nCX 0 1\nMEASURE 0\nMEASURE 1", "shots": 1024, "seed": 42,
           "sessionId": os.environ.get("AUTOMATIONGLANCE_SESSION_ID", "documentation-local-session")}
request = urllib.request.Request(base + "/api/runSimulation", data=json.dumps(payload).encode(),
                                 headers={"Content-Type": "application/json"}, method="POST")
try:
    with urllib.request.urlopen(request) as response:
        print(json.dumps(json.load(response)))
except urllib.error.HTTPError as error:
    raise RuntimeError(f"{error.code}: {error.read().decode()}") from error

{"returns":[3,2,1],"covariance":[[1,0,0],[0,1,0],[0,0,1]],"riskWeight":1,"selectedCount":1,"shots":1024,"seed":42}

{"universe":["A","B","C"],"sets":[{"elements":[0,1],"cost":2},{"elements":[1,2],"cost":2},{"elements":[0,1,2],"cost":5}],"shots":1024,"seed":42}

{"vertices":3,"colors":2,"edges":[[0,1],[1,2]],"shots":1024,"seed":42}

{"distances":[[0,2,3],[2,0,4],[3,4,0]],"targetCities":100,"shots":1024,"seed":42}

{"machineCount":1,"horizon":2,"jobs":[{"operations":[{"machine":0,"duration":1},{"machine":0,"duration":1}]}],"targetOperations":1000,"targetHorizon":100,"shots":1024,"seed":42}

{"distances":[[0,2,2,2],[2,0,2,2],[2,2,0,2],[2,2,2,0]],"demands":[1,1,1],"capacity":2,"vehicleCount":2,"targetCustomers":100,"targetVehicleCount":10,"targetCapacity":10,"targetMinimumDemand":1,"shots":1024,"seed":42}