DEVELOPER DOCUMENTATION

UVQ API Documentation

Complete guide to integrating quantum computing into your applications

🚀 Quick Start

Get started with UVQ's Quantum Computing API in minutes:

1. Authentication

All API requests require authentication using your API key:

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://api.uvq.net/v1/quantum/algorithms

2. Base URL

Production: https://api.uvq.net/v1/

Sandbox: https://sandbox-api.uvq.net/v1/

🔗 Core API Endpoints

Quantum Algorithms

GET /quantum/algorithms - List available quantum algorithms 
{
  "algorithms": [
    {
      "id": "shor",
      "name": "Shor's Algorithm",
      "description": "Integer factorization using quantum computing",
      "complexity": "O((log N)³)",
      "qubits_required": "2n + 3"
    },
    {
      "id": "grover",
      "name": "Grover's Algorithm",
      "description": "Quantum search algorithm for unsorted databases",
      "complexity": "O(√N)",
      "qubits_required": "log₂(N)"
    }
  ]
}

Circuit Execution

POST /quantum/execute - Execute quantum circuit 
{
  "circuit": {
    "gates": [
      {"type": "H", "target": 0},
      {"type": "CNOT", "control": 0, "target": 1}
    ],
    "measurements": [0, 1]
  },
  "shots": 1024
}

Job Management

GET /jobs/{job_id} - Get job status DELETE /jobs/{job_id} - Cancel job

🔐 Authentication

API Key Authentication

Include your API key in the Authorization header:

Authorization: Bearer uvq_live_1234567890abcdef

Rate Limits

  • Free Tier: 100 requests/hour
  • Developer: 1,000 requests/hour
  • Professional: 10,000 requests/hour
  • Enterprise: Unlimited

⚛️ Quantum Circuit Format

Supported Gates

Single Qubit

  • H (Hadamard)
  • X, Y, Z (Pauli)
  • S, T (Phase)
  • RX, RY, RZ (Rotation)

Two Qubit

  • CNOT
  • CZ
  • SWAP
  • CRX, CRY, CRZ

Example: Bell State Circuit

{
  "circuit": {
    "qubits": 2,
    "gates": [
      {"type": "H", "target": 0},
      {"type": "CNOT", "control": 0, "target": 1}
    ],
    "measurements": [0, 1]
  },
  "shots": 1000
}

⚠️ Error Handling

HTTP Status Codes

  • 200: Success
  • 400: Bad Request - Invalid circuit or parameters
  • 401: Unauthorized - Invalid API key
  • 429: Too Many Requests - Rate limit exceeded
  • 500: Internal Server Error

Error Response Format

{
  "error": {
    "code": "invalid_circuit",
    "message": "Circuit contains unsupported gate: MAGIC",
    "details": "Available gates: H, X, Y, Z, CNOT, ..."
  }
}
View Code Examples Try Interactive Console Get API Key