Quantumize Python SDK

A typed Python client for the Quantumize post-quantum cryptography API. Supports both sync (httpx) and async usage.

Installation

pip install quantumize-sdk

Or install directly from source:

pip install ./sdk/python

Requirements: Python ≥ 3.9, httpx ≥ 0.24.0

Quick Start

from quantumize import QuantumizeClient

# 1. Initialise the client with your API key
client = QuantumizeClient(api_key="qtz_k_your_key_here")

# 2. Encrypt a file
with open("report.pdf", "rb") as f:
    result = client.encrypt_file(f, "report.pdf", algo="kyber768")

# 3. The encrypted artifact and decryption key are now stored in Quantumize
print("Encrypted file:", result.encrypted_file_name)
print("Decryption key:", result.private_decryption_key_name)

# 4. List your files
files = client.list_files()
for file in files:
    print(file.name, "•", "encrypted" if file.encrypted else "plaintext")

# 5. Check your account and credit balance
account = client.get_account()
print(f"Credits remaining: {account.credits}")

Generate an API key at Account Settings → API Keys in the dashboard, or via POST /api/v1/api-keys. The full key value is shown only once — store it in an environment variable or a secrets manager.

Authentication

All requests authenticate via the X-API-Key header:

client = QuantumizeClient(api_key="qtz_k_...")

For on-premise / enterprise deployments behind a firewall, pass your internal base URL:

client = QuantumizeClient(
    api_key="qtz_k_...",
    base_url="https://pqc.internal.acme.com",
)

Core Methods

Cryptographic Operations

File Management

Account & Platform

Algorithms

Fetch available algorithms at runtime:

algos = client.get_algorithms()
kem_algos = [a for a in algos if a.type == "KEM"]
dsa_algos = [a for a in algos if a.type == "DSA"]

for algo in kem_algos:
    print(f"{algo.name:30s}  Security Level {algo.security_level}  {algo.nist_status}")

Common KEM algorithms: kyber512, kyber768 (default), kyber1024, mceliece348864, hqc-128, hqc-192, hqc-256

Common DSA algorithms: dilithium2 (default), dilithium3, dilithium5, falcon-512, falcon-1024, sphincs-sha2-128f

Async Usage

import asyncio
from quantumize import AsyncQuantumizeClient

async def main():
    async with AsyncQuantumizeClient(api_key="qtz_k_...") as client:
        # Encrypt a file asynchronously
        with open("contract.docx", "rb") as f:
            result = await client.encrypt_file(f, "contract.docx", algo="kyber1024")

        print("Encrypted:", result.encrypted_file_name)

        # List supported algorithms
        algos = await client.get_algorithms()
        print(f"{len(algos)} algorithms available")

asyncio.run(main())

Error Handling

from quantumize import (
    QuantumizeClient,
    AuthenticationError,
    InsufficientCreditsError,
    VerificationError,
)

client = QuantumizeClient(api_key="qtz_k_...")

try:
    result = client.encrypt_file(open("data.bin", "rb"), "data.bin")
except InsufficientCreditsError:
    print("Not enough credits — top up at quantumize.io/billing")
except AuthenticationError:
    print("Invalid or revoked API key")

OpenAPI Specification

The full machine-readable API contract is available at:

GET /api/v1/openapi.json

Or download the YAML source from the repository at docs/api/openapi.yaml.

License

Proprietary — © Quantumize Platform. All rights reserved.