Migrating to v0.23.0: IBM Quantum Compute Service API rename#

Important

Deprecation notice (since v0.23.0)

The IBM Qiskit Runtime Service API has been renamed to the IBM Quantum Compute Service API. Resource names and environment variable prefixes have changed accordingly. Legacy names remain supported until November 21, 2026. See the migration guide for details.

Starting with v0.23.0, the IBM Qiskit Runtime Service API has been renamed to the IBM Quantum Compute Service API. As part of this change, the resource names and the prefixes of environment variables used by QRMI have been updated accordingly.

What changed#

Item

Deprecated name

New name

Resource type text

qiskit-runtime-service

ibm-quantum-compute-service

Resource type (C)

QRMI_RESOURCE_TYPE_QISKIT_RUNTIME_SERVICE

QRMI_RESOURCE_TYPE_IBM_QUANTUM_COMPUTE_SERVICE

Resource type (Python)

ResourceType.IBMQiskitRuntimeService

ResourceType.IBMQuantumComputeService

Resource type (Rust)

ResourceType::QiskitRuntimeService

ResourceType::IBMQuantumComputeService

QuantumResource trait implementor (Rust)

qrmi::ibm::IBMQiskitRuntimeService

qrmi::ibm::IBMQuantumComputeService

Environment variable prefix

QRMI_IBM_QRS_

QRMI_IBM_QCS_

Transition period#

A transition period is in effect until November 21, 2026. During this period, both the legacy and the new resource names and environment variable prefixes are supported to ensure backward compatibility. After the transition period ends, support for the legacy names will be removed, and users are expected to have fully migrated to the new naming scheme.

How to migrate#

  1. Environment variables — Replace any environment variables prefixed with QRMI_IBM_QRS_ with the equivalent QRMI_IBM_QCS_ prefixed variables.

  2. Rust — Replace references to ResourceType::QiskitRuntimeService and qrmi::ibm::IBMQiskitRuntimeService with ResourceType::IBMQuantumComputeService and qrmi::ibm::IBMQuantumComputeService respectively.

  3. Python — Replace references to ResourceType.IBMQiskitRuntimeService with ResourceType.IBMQuantumComputeService.

  4. C — Replace QRMI_RESOURCE_TYPE_QISKIT_RUNTIME_SERVICE with QRMI_RESOURCE_TYPE_IBM_QUANTUM_COMPUTE_SERVICE.

  5. Configuration files / resource type strings — Replace any occurrences of qiskit-runtime-service with ibm-quantum-compute-service.

No functional behavior changes as a result of this rename; only names and identifiers are affected.