QaaS API Documentation

Returns the API status and available capabilities.

Response

{
  "status": "operational",
  "service": "QaaS - Quantum as a Service",
  "version": "1.0.0",
  "algorithms_available": 100,
  "frameworks": ["Qiskit", "Cirq", "PennyLane"],
  "timestamp": "2025-12-11T21:45:47.471Z"
}

Returns all available pricing tiers with features and payment links.

Response

{
  "tiers": [
    {
      "id": "explorer",
      "name": "Explorer",
      "price": 0,
      "runs_per_day": 10,
      "runs_per_month": 300,
      "algorithms": 25,
      "backends": ["simulator"]
    },
    ...
  ],
  "currency": "USD",
  "billing": "monthly"
}

Returns available quantum algorithms based on your tier.

Headers

Name	Type	Description
X-API-Key	string	Your API key (optional for Explorer tier)

Response

{
  "tier": "explorer",
  "total_available": 25,
  "algorithms": [
    {
      "id": 1,
      "name": "AE_PROB_001",
      "category": "amplitude_estimation",
      "description": "Probability amplitude estimation for option pricing"
    },
    ...
  ],
  "categories": ["amplitude_estimation", "grover_search", ...]
}

Execute a quantum algorithm with specified parameters.

Request Body

Parameter	Type	Required	Description
algorithm_id	string	Yes	Algorithm identifier (e.g., "AE_PROB_001")
parameters	object	Yes	Algorithm-specific parameters
backend	string	No	Execution backend (default: "simulator")
shots	number	No	Number of measurement shots (default: 1024)

Example Request

POST /api/quantum/run
Content-Type: application/json
X-API-Key: YOUR_API_KEY

{
  "algorithm_id": "QAOA_PORT_001",
  "parameters": {
    "assets": ["AAPL", "GOOGL", "MSFT", "AMZN"],
    "returns": [0.12, 0.15, 0.10, 0.18],
    "covariance": [[0.04, 0.01, 0.02, 0.01], ...],
    "risk_tolerance": 0.5
  },
  "backend": "qiskit_aer",
  "shots": 2048
}

Response

{
  "job_id": "qj_abc123xyz",
  "status": "completed",
  "algorithm": "QAOA_PORT_001",
  "result": {
    "optimal_weights": [0.25, 0.35, 0.15, 0.25],
    "expected_return": 0.1425,
    "portfolio_variance": 0.0289,
    "sharpe_ratio": 1.42
  },
  "execution_time_ms": 847,
  "backend_used": "qiskit_aer",
  "shots_executed": 2048,
  "quantum_watermark": "RAS=e5586ef939094a8e"
}

Returns your current usage statistics and remaining quota.

Response

{
  "tier": "quant",
  "period": "2025-12",
  "usage": {
    "runs_today": 45,
    "runs_this_month": 892,
    "remaining_today": 205,
    "remaining_month": 1608
  },
  "limits": {
    "runs_per_day": 250,
    "runs_per_month": 2500
  }
}