ibm-quantum-schemas

What it is and what it does

IBM Quantum Schemas is a Python package containing Pydantic models that standardize the structure of data exchanged with IBM Quantum services. It defines the request and response payloads for IBM Quantum primitives and programs, allowing developers to validate and serialize quantum job specifications programmatically. The package organizes models by semantic version (e.g., `version_0_10`), with development versions marked by a `_dev` suffix to signal instability.

The package serves as a bridge between Python code and IBM Quantum's REST API, ensuring type safety and schema compliance before sending jobs to quantum hardware or simulators. It depends on pydantic for validation, qiskit for quantum primitives, and several utility libraries. The repository recently shifted focus from hosting raw JSON schemas to providing these Pydantic models, making it the canonical source for schema definitions in the Qiskit ecosystem.

Use it for:

• Validate quantum job specifications before submitting them to IBM Quantum services.
• Serialize and deserialize quantum program inputs and outputs with type checking.
• Build client libraries or tools that interface with IBM Quantum primitives programmatically.
• Ensure compatibility between local code and IBM Quantum API versions by using versioned schemas.
• Develop quantum applications that need strict schema compliance for production deployments.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides Pydantic models that define the structure of inputs and outputs for IBM Quantum primitives and programs, enabling programmatic Python interfaces to IBM Quantum services.

Yes, if you are building applications that interact with IBM Quantum services or Qiskit Runtime. The package is actively maintained, has no known vulnerabilities, and provides essential schema definitions for the Qiskit ecosystem. It is in alpha status, so some included programs may not yet be production-ready; check the Qiskit Runtime REST API documentation to confirm which schema versions are supported by your target platform.

Install

ibm-quantum-schemas on PyPI

pip install ibm-quantum-schemas

uv add ibm-quantum-schemas

poetry add ibm-quantum-schemas

Installing ibm-quantum-schemas

Before you install

Low friction installation with a pure-Python wheel. The package is actively maintained (last commit 2026-08-10) and in alpha status. It depends on established libraries like pydantic and qiskit, which are standard in the quantum computing ecosystem.

License in practice

Licensed under Apache-2.0 (permissive), allowing use in both open-source and proprietary projects with minimal restrictions.

Quickstart

pip install ibm-quantum-schemas

from ibm_quantum_schemas.version_0_10 import SomeModel
# Use the Pydantic model for validation and serialization

Requires Python 3.10 or later; depends on qiskit and pydantic being installed.

Verify before relying

• Which specific Pydantic model versions are stable vs. beta on the current IBM Quantum platform.
• Whether all included program schemas (executor, noise_learner_v3) are production-ready or still experimental.
• Compatibility guarantees between schema versions and specific qiskit releases.

Package facts

Evidence: ibm_quantum_schemas-0.10.20260723-py3-none-any.whl

Tags

More Scientific/Engineering packages