REST API

Complete HTTP API for quantum computing operations. Execute quantum circuits, manage jobs, access multiple QPU backends, and retrieve results via secure RESTful endpoints. Full OpenAPI 3.0 specification with interactive documentation. Rate limits: 10,000 requests/hour.

Get API Key View Docs

Quick Start

Get Started in 60 Seconds

1. Sign up at dashboard.agiquantumcloud.com to get your API key
2. Make your first request using cURL, Python, or any HTTP client
3. Start building quantum applications

cURL Example:

curl -X POST https://api.agiquantumcloud.com/v1/jobs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "backend": "quantum_simulator",
    "circuit": {
      "qubits": 2,
      "gates": [
        {"type": "h", "target": 0},
        {"type": "cx", "control": 0, "target": 1}
      ],
      "measurements": [0, 1]
    },
    "shots": 1024
  }'

Python Example:

import requests

API_KEY = "your_api_key_here"
BASE_URL = "https://api.agiquantumcloud.com/v1"

headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}

# Create a Bell state circuit
circuit_data = {
    "backend": "quantum_simulator",
    "circuit": {
        "qubits": 2,
        "gates": [
            {"type": "h", "target": 0},
            {"type": "cx", "control": 0, "target": 1}
        ],
        "measurements": [0, 1]
    },
    "shots": 1024
}

response = requests.post(
    f"{BASE_URL}/jobs",
    headers=headers,
    json=circuit_data
)

job = response.json()
print(f"Job ID: {job['job_id']}")

Core Endpoints

POST /v1/jobs

Submit a quantum circuit for execution. Returns a job ID for tracking execution status and retrieving results.

Request Parameters:

Parameter Type Required Description
backend string Yes QPU backend name (e.g., "quantum_simulator", "superconducting_qpu")
circuit object Yes Circuit definition with qubits, gates, and measurements
shots integer No Number of circuit executions (default: 1024, max: 100000)
optimize boolean No Enable circuit optimization (default: true)

Response Example:

{
  "job_id": "qjob_abc123def456",
  "status": "queued",
  "created_at": "2024-01-15T10:30:00Z",
  "backend": "quantum_simulator"
}
GET /v1/jobs/{job_id}

Retrieve job status and results. Poll this endpoint to check if your job has completed.

Response Example (completed job):

{
  "job_id": "qjob_abc123def456",
  "status": "completed",
  "created_at": "2024-01-15T10:30:00Z",
  "completed_at": "2024-01-15T10:30:15Z",
  "results": {
    "counts": {
      "00": 512,
      "11": 512
    },
    "shots": 1024,
    "success": true
  }
}
GET /v1/backends

List all available quantum backends with their specifications and real-time availability status.

Response Example:

{
  "backends": [
    {
      "name": "quantum_simulator",
      "type": "simulator",
      "qubits": 64,
      "status": "online",
      "queue_length": 0
    },
    {
      "name": "superconducting_qpu",
      "type": "hardware",
      "qubits": 127,
      "status": "online",
      "queue_length": 3,
      "avg_wait_time": 45
    }
  ]
}
DELETE /v1/jobs/{job_id}

Cancel a queued or running job. Cannot cancel completed jobs.

Authentication

All API requests require authentication using an API key. Include your key in the Authorization header.

API Key Authentication

Include your API key in every request:

Authorization: Bearer YOUR_API_KEY

Generate keys at dashboard.agiquantumcloud.com

OAuth 2.0

For enterprise applications, use OAuth 2.0 with client credentials flow. Supports token refresh and fine-grained permissions.

Authorization: Bearer {oauth_token}

Security Features

• All connections over HTTPS/TLS 1.3
• IP whitelisting available
• Request signing with HMAC
• Automatic key rotation
• Audit logging included

Rate Limits & Quotas

Free Tier

1,000 Requests/Hour

Pro Tier

10,000 Requests/Hour

Enterprise

Unlimited Custom Limits

Simulator

64 Max Qubits

Hardware QPU

127 Max Qubits

Shots Limit

100K Per Job

Client Libraries

Python SDK

pip install ishara-quantum

JavaScript/Node

npm install @ishara/quantum

Java

Maven & Gradle

C++

CMake integration

Go

go get github.com/ishara/quantum

Rust

cargo add ishara-quantum

Start Building Today

Get your API key and start executing quantum circuits in minutes. Free tier includes 1,000 requests/hour and access to simulator backends. No credit card required.

Get API Key View Full Documentation