QCOS API Catalog v2.1.0

Generated: January 25, 2026 Total Endpoints: 125 Total Resources: 16+ Total Modules: 16

📊 Executive Summary

The QCOS (Quantum Computing Operating System) API v2.1.0 provides a comprehensive quantum computing service with 125 endpoints distributed across 16 specialized modules. The API is predominantly read-heavy with strong support for complex quantum operations through POST endpoints.

Summary Statistics

Total Endpoints: 19
Total Resources: 12
Total Files: 6

Endpoints by HTTP Method

Method	Count	%
GET	12	63.2%
POST	4	21.1%
PUT	0	0.0%
DELETE	3	15.8%
PATCH	0	0.0%

Top Resources

Resource	Endpoints
`jobs`	4
`status`	3
`reports`	3
`batch`	1
`webhooks`	1
`backends`	1
`validate`	1
`tiers`	1
`credits`	1
`pricing`	1
`provenance`	1
`health`	1

Endpoints by File

azure_quantum_routes.py

Endpoints: 2

Method	Path	Function	Description
GET	`/status/{job_id}`	`get_job_status`	Get status of an Azure Quantum job.
DELETE	`/jobs/{job_id}`	`cancel_job`	Cancel an Azure Quantum job.

braket_routes.py

Endpoints: 2

Method	Path	Function	Description
GET	`/status/{job_id}`	`get_job_status`	Get status of an AWS Braket job.
DELETE	`/jobs/{job_id}`	`cancel_job`	Cancel an AWS Braket quantum task.

enhanced.py

Endpoints: 7

Method	Path	Function	Description
GET	`/batch/{batch_id}/status`	`get_batch_status`	Get status of a batch simulation.
POST	`/webhooks`	`create_webhook`	Register a webhook for job notifications.
GET	`/backends/all`	`list_all_backends`	Get a unified list of ALL available backends across all prov...
POST	`/validate`	`validate_circuit`	Validate a quantum circuit without executing it.
GET	`/tiers`	`list_tiers`	List available execution tiers with pricing.
GET	`/credits/balance`	`get_credits_balance`	Get current credit balance for the user.
GET	`/jobs/history`	`get_job_history`	Get job execution history for the user.

ibm_quantum_routes.py

Endpoints: 2

Method	Path	Function	Description
GET	`/status/{job_id}`	`get_job_status`	Get status of an IBM Quantum job.
DELETE	`/jobs/{job_id}`	`cancel_job`	Cancel an IBM Quantum job.

ledger_routes.py

Endpoints: 5

Method	Path	Function	Description
GET	`/pricing`	`get_pricing_table`	Get the pricing table for all providers and backends.
GET	`/provenance/{job_id}`	`get_provenance`	Get provenance and reproducibility data for a job.
POST	`/reports/chargeback`	`generate_chargeback_report`	Generate a chargeback report.
POST	`/reports/audit`	`generate_audit_report`	Generate an audit report.
GET	`/reports/usage`	`get_usage_report`	Get usage analytics report.

quantum_macro.py

Endpoints: 1

Method	Path	Function	Description
GET	`/health`	`health`	Health check for quantum macro services.

Endpoints by Resource

jobs

Total: 4 endpoints

Method	Path	Function
DELETE	`/jobs/{job_id}`	`cancel_job`
DELETE	`/jobs/{job_id}`	`cancel_job`
DELETE	`/jobs/{job_id}`	`cancel_job`
GET	`/jobs/history`	`get_job_history`

status

Total: 3 endpoints

Method	Path	Function
GET	`/status/{job_id}`	`get_job_status`
GET	`/status/{job_id}`	`get_job_status`
GET	`/status/{job_id}`	`get_job_status`

reports

Total: 3 endpoints

Method	Path	Function
GET	`/reports/usage`	`get_usage_report`
POST	`/reports/audit`	`generate_audit_report`
POST	`/reports/chargeback`	`generate_chargeback_report`

batch

Total: 1 endpoints

Method	Path	Function
GET	`/batch/{batch_id}/status`	`get_batch_status`

webhooks

Total: 1 endpoints

Method	Path	Function
POST	`/webhooks`	`create_webhook`

backends

Total: 1 endpoints

Method	Path	Function
GET	`/backends/all`	`list_all_backends`

validate

Total: 1 endpoints

Method	Path	Function
POST	`/validate`	`validate_circuit`

tiers

Total: 1 endpoints

Method	Path	Function
GET	`/tiers`	`list_tiers`

credits

Total: 1 endpoints

Method	Path	Function
GET	`/credits/balance`	`get_credits_balance`

pricing

Total: 1 endpoints

Method	Path	Function
GET	`/pricing`	`get_pricing_table`

provenance

Total: 1 endpoints

Method	Path	Function
GET	`/provenance/{job_id}`	`get_provenance`

health

Total: 1 endpoints

Method	Path	Function
GET	`/health`	`health`

Detailed Endpoint Documentation

azure_quantum_routes.py

GET /status/{job_id}

Function: get_job_status

Description:

Get status of an Azure Quantum job.

    Returns job status, results (if completed), and cost information.

DELETE /jobs/{job_id}

Function: cancel_job

Description:

Cancel an Azure Quantum job.

    Only pending/queued jobs can be cancelled.
    Jobs already running may still incur partial charges.

braket_routes.py

GET /status/{job_id}

Function: get_job_status

Description:

Get status of an AWS Braket job.
    # TODO: Implement proper task tracking
    raise HTTPException(
        status_code=501,
        detail="Task tracking not yet implemented"
    )


@router.delete("/jobs/{job_id}")
async def cancel_job(
    job_id: str,
    user: User = Depends(get_current_user)
):

DELETE /jobs/{job_id}

Function: cancel_job

Description:

Cancel an AWS Braket quantum task.

    Only pending/queued tasks can be cancelled.

enhanced.py

GET /batch/{batch_id}/status

Function: get_batch_status

Description:

Get status of a batch simulation.
    # Retrieve from cache/database
    batch_status = get_batch_from_store(batch_id)

    if not batch_status:
        raise HTTPException(status_code=404, detail="Batch not found")

    return batch_status


# =============================================================================
# Cost Estimation
# =============================================================================


@router.post("/estimate", response_model=CostEstimationResponse)
async def estimate_cost(request: CostEstimationRequest, user: User = Depends(get_current_user)):

POST /webhooks

Function: create_webhook

Description:

Register a webhook for job notifications.

    Webhook will be called when specified events occur:
    - job.completed: Job finished successfully
    - job.failed: Job failed with error
    - optimization.done: Circuit optimization completed
    - batch.completed: Batch simulation finished

    Webhook payload includes job details and HMAC signature for verification.

GET /backends/all

Function: list_all_backends

Description:

Get a unified list of ALL available backends across all providers.

    Consolidates:
    - LUMI GPU simulators
    - IBM Quantum backends
    - Azure Quantum targets
    - AWS Braket devices

    Returns normalized data for easy comparison and selection.

POST /validate

Function: validate_circuit

Description:

Validate a quantum circuit without executing it.

    Checks:
    - QASM syntax validity
    - Gate support for target backends
    - Qubit count limits
    - Measurement operations

    Returns validation result with any errors or warnings.

GET /tiers

Function: list_tiers

Description:

List available execution tiers with pricing.

    Used by SynapseX to display pricing and select appropriate tier.

GET /credits/balance

Function: get_credits_balance

Description:

Get current credit balance for the user.

    Used by SynapseX for quota management and billing.

GET /jobs/history

Function: get_job_history

Description:

Get job execution history for the user.

    Filters:
    - status: queued, processing, completed, failed
    - provider: ibm_quantum, azure_quantum, aws_braket, lumi_gpu

    Used by SynapseX dashboard for job monitoring.

ibm_quantum_routes.py

GET /status/{job_id}

Function: get_job_status

Description:

Get status of an IBM Quantum job.
    # TODO: Implement proper job tracking
    raise HTTPException(
        status_code=501,
        detail="Job tracking not yet implemented"
    )


@router.delete("/jobs/{job_id}")
async def cancel_job(
    job_id: str,
    user: User = Depends(get_current_user)
):

DELETE /jobs/{job_id}

Function: cancel_job

Description:

Cancel an IBM Quantum job.

    Only pending/queued jobs can be cancelled.

ledger_routes.py

GET /pricing

Function: get_pricing_table

Description:

Get the pricing table for all providers and backends.

    Returns cost-per-shot and minimum charges.

GET /provenance/{job_id}

Function: get_provenance

Description:

Get provenance and reproducibility data for a job.

    Includes hashes, lineage, chain verification, and reproducibility score.

    **Requires: ENTERPRISE license tier**

POST /reports/chargeback

Function: generate_chargeback_report

Description:

Generate a chargeback report.

    Aggregates costs by tenant, project, backend, or custom tags.

    **Requires: ENTERPRISE license tier**

POST /reports/audit

Function: generate_audit_report

Description:

Generate an audit report.

    Complete job history with all metadata for compliance.

    **Requires: ENTERPRISE license tier**

GET /reports/usage

Function: get_usage_report

Description:

Get usage analytics report.

    Summary of jobs, shots, and costs by backend and provider.

quantum_macro.py

GET /health

Function: health

Description:

Health check for quantum macro services.
    return {
        "status": "healthy",
        "service": "quantum_macro_optimization",
        "version": "2.1.0",
        "algorithms": ["qaoa", "qmc", "qsvm", "vqe"],
        "backends": ["ibm_quantum", "d-wave", "ionq", "aws_braket"],
        "timestamp": datetime.now().isoformat(),
    }

📊 Executive Summary​

Summary Statistics​

Endpoints by HTTP Method​

Top Resources​

Endpoints by File​

azure_quantum_routes.py​

braket_routes.py​

enhanced.py​

ibm_quantum_routes.py​

ledger_routes.py​

quantum_macro.py​

Endpoints by Resource​

jobs​

status​

reports​

batch​

webhooks​

backends​

validate​

tiers​

credits​

pricing​

provenance​

health​

Detailed Endpoint Documentation​

azure_quantum_routes.py​

GET /status/{job_id}​

DELETE /jobs/{job_id}​

braket_routes.py​

GET /status/{job_id}​

DELETE /jobs/{job_id}​

enhanced.py​

GET /batch/{batch_id}/status​

POST /webhooks​

GET /backends/all​

POST /validate​

GET /tiers​

GET /credits/balance​

GET /jobs/history​

ibm_quantum_routes.py​

GET /status/{job_id}​

DELETE /jobs/{job_id}​

ledger_routes.py​

GET /pricing​

GET /provenance/{job_id}​

POST /reports/chargeback​

POST /reports/audit​

GET /reports/usage​

quantum_macro.py​

GET /health​

📊 Executive Summary

Summary Statistics

Endpoints by HTTP Method

Top Resources

Endpoints by File

azure_quantum_routes.py

braket_routes.py

enhanced.py

ibm_quantum_routes.py

ledger_routes.py

quantum_macro.py

Endpoints by Resource

jobs

status

reports

batch

webhooks

backends

validate

tiers

credits

pricing

provenance

health

Detailed Endpoint Documentation

azure_quantum_routes.py

GET /status/{job_id}

DELETE /jobs/{job_id}

braket_routes.py

GET /status/{job_id}

DELETE /jobs/{job_id}

enhanced.py

GET /batch/{batch_id}/status

POST /webhooks

GET /backends/all

POST /validate

GET /tiers

GET /credits/balance

GET /jobs/history

ibm_quantum_routes.py

GET /status/{job_id}

DELETE /jobs/{job_id}

ledger_routes.py

GET /pricing

GET /provenance/{job_id}

POST /reports/chargeback

POST /reports/audit

GET /reports/usage

quantum_macro.py

GET /health