API Documentation

Q-MUMMA REST API Reference

Base URL: https://api.qmumma.com/v1

Overview

The Q-MUMMA API is a RESTful HTTP API served exclusively over HTTPS. It provides access to quantum algorithm execution, entropy generation, benchmark data, and compliance certificates. All responses are JSON. All results include ML-DSA-65 PQC signatures and SHA-256 audit hashes.

Single public surface. The REST API is the only public-facing surface of Q-MUMMA. All internal computation, hardware routing, and AI optimisation happens behind an mTLS gRPC mesh — completely invisible to API consumers.

# Base URL (all environments) Production: https://api.qmumma.com/v1 Sandbox: https://sandbox.api.qmumma.com/v1 # All requests require: Content-Type: application/json Authorization: Bearer qm_live_<token> (or qm_test_ for sandbox)

Authentication

Q-MUMMA uses Bearer token authentication. Every API key is scoped to a specific plan and rate limit. Keys are prefixed so you can identify them at a glance.

Token Prefixes

PrefixEnvironmentDescription
qm_live_ProductionFull hardware access. Billed per execution.
qm_test_SandboxSimulated responses. Identical API structure. Never billed.
qm_ent_EnterpriseExtended rate limits. Dedicated hardware queue.

Using Your Token

# Every request — Authorization header Authorization: Bearer qm_live_sk_8x9z2mNQpT... # Example with curl: curl https://api.qmumma.com/v1/algorithms \ -H "Authorization: Bearer qm_live_sk_8x9z2mNQpT..."

Keep keys secret. Never embed API keys in frontend code or public repositories. Use environment variables or a secrets manager. Rotate keys from the dashboard if compromised.

Jobs

Jobs are the core resource. Submit a quantum algorithm job, the AI Brain selects optimal hardware, executes, and returns a signed result.

POST/v1/jobs/submitSubmit a quantum job
# Request body { "algorithm_id": "vqe.molecular.v2", // Required "hardware": "auto", // "auto" | "ibm_marrakesh" | ... "shots": 4096, // Min 1024, Max 131072 "parameters": { "molecule": "H2O" }, // Algorithm-specific "priority": "standard", // "standard" | "priority" "webhook_url": "https://your.app/hook" // Optional } # Response 202 Accepted { "job_id": "qm_job_9f2a8b1c", "status": "queued", "hardware": "ibm_marrakesh", "estimated_ms": 8400, "cost_usd": 50.00 }
GET/v1/jobs/{job_id}Poll job status & result
# Response 200 — when status = "completed" { "job_id": "qm_job_9f2a8b1c", "status": "completed", "hardware": "ibm_marrakesh", "qubits": 156, "result": { "energy_hartree": -1.5479, ... }, "fidelity": "99.24%", "pqc_signature": "<ML-DSA-65 base64>", "audit_hash": "sha256:a3f8c1d2...", "blockchain_anchor":"vajra://txid/...", "executed_at": "2026-05-06T04:00:00Z" }
GET/v1/jobsList jobs (paginated)

Returns paginated list of your jobs. Query params: limit, before, after, status.

Algorithms

GET/v1/marketplace/algorithmsList all available algorithms
# Response includes per-algorithm pricing, specs, and required parameters { "algorithms": [ { "id": "vqe.molecular.v2", "name": "VQE Molecular Simulation", "category": "drug_discovery", "max_qubits": 156, "cost_usd": 50.0, "hardware": ["ibm_marrakesh", "ibm_heron_r2"] } ] }
GET/v1/marketplace/algorithms/{id}Algorithm detail + parameter schema

Returns full JSON Schema for the algorithm's parameters object, along with hardware availability, current queue depth, and result schema.

Entropy

POST/v1/entropy/generateGenerate certified quantum entropy
{ "bits": 10000, // 1–10,000,000 per request "format": "hex", // "hex" | "base64" | "bytes" "certification": true // Includes PQC signature + NIST test report } # Response 200 { "data": "A3F8C1D2E7B4...", "bits": 10000, "source": "ibm_marrakesh", "nist_tests_passed": true, "pqc_signature": "<ML-DSA-65>", "cost_usd": 0.01 }

Certificates

Compliance certificates are cryptographically bound to job results. They are signed with ML-DSA-65 and suitable for FDA 21 CFR Part 11, SEC, and ISO regulatory submissions.

GET/v1/jobs/{job_id}/certificateDownload compliance certificate

Returns a PDF certificate containing: job ID, hardware, fidelity, algorithm, result summary, PQC signature, blockchain anchor, and Aumtrix digital seal. Commercial plan and above.

Regulatory Use. Certificates include all fields required for FDA 21 CFR Part 11, SEC Rule 17a-4, and ISO 27001 evidence packages. Contact enterprise@qmumma.com for jurisdiction-specific template customisation.

Error Codes

HTTP CodeError TypeMeaning
400bad_requestInvalid request body or missing required fields
401unauthorizedMissing or invalid API key
403forbiddenFeature not available on your plan
404not_foundJob ID or algorithm not found
429rate_limitedExceeded requests per minute — back off and retry
500server_errorTemporary error — retry after exponential backoff
503hardware_unavailableRequested hardware offline — use "auto" for failover

Failed hardware jobs are never billed. If a job fails due to hardware error (5xx), you are not charged. The job is automatically eligible for retry with alternate hardware.

Rate Limits

PlanRequests/minJobs/month includedBurst
Student / Free10520
Academic6030100
Commercial300100500
EnterpriseUnlimitedCustomUnlimited

SDKs & Client Libraries

Python SDK
pip install qmumma from qmumma import QMummaClient client = QMummaClient("qm_live_...") result = client.jobs.submit( algorithm_id="vqe.molecular.v2", shots=4096 )
Coming Q2 2026
JavaScript / TypeScript SDK
npm install @qmumma/sdk import { QMummaClient } from "@qmumma/sdk"; const client = new QMummaClient("qm_live_..."); const result = await client.jobs.submit({ algorithmId: "vqe.molecular.v2", shots: 4096 });
Coming Q2 2026

All SDKs are open source on Aumtrix GitHub. In the meantime, all endpoints are curl-compatible. See our API Marketplace for curl examples for each algorithm.

Webhooks

Receive a POST to your URL the moment a job completes, fails, or is rerouted. Webhook payloads are signed with HMAC-SHA256 using your webhook secret.

# Webhook payload (POST to your URL) { "event": "job.completed", "job_id": "qm_job_9f2a8b1c", "status": "completed", "timestamp": "2026-05-06T04:00:00Z" } # Verify HMAC signature on every webhook: X-QMUMMA-Signature: sha256=<hmac_hex>

OpenAPI Spec

Full OpenAPI 3.0 specification available. Import into Postman, Insomnia, or any HTTP client to get autocomplete for all endpoints, parameters, and response shapes.

Download OpenAPI JSON Get API Key to Explore