QiskitRuntimeService

class QiskitRuntimeService(*args, **kwargs)

Bases: object

Class for interacting with the Qiskit Runtime service.

QiskitRuntimeService constructor.

Recommended uses:

Direct instantiation:

from qiskit_ibm_runtime import QiskitRuntimeService
 
service = QiskitRuntimeService(
    channel="ibm_quantum_platform",
    token="API_KEY",
    instance="CRN"
    )

Saving default acccount:

from qiskit_ibm_runtime import QiskitRuntimeService
 
QiskitRuntimeService.save_account(
    token="API_KEY",
    instance="CRN",
    set_as_default = True
    )
 
service = QiskitRuntimeService()

The minimum required information for service authentication to a non-local channel is the token. The local channel doesn’t require authentication. For non-local channels, it is recommended to always provide the relevant instance to minimize API calls. If an instance is not defined, the service will fetch all instances accessible within the account, filtered by region, plans_preference, and tags. If plans_preference is not set, free and trial instances will be prioritized over paid instances.

Also note that only one account per API token can be used. The API token is linked to the account it was created in. If you want to use multiple accounts, you must create multiple API tokens.

The service will attempt to load an account from file if (a) no explicit token was provided during instantiation or (b) a name is specified, even if an explicit token was provided to the service constructor. The account will be selected based on the following criteria:

If a filename is specified, account details will be loaded from filename, else they will be loaded from the default configuration file.
If a name is specified, the corresponding account details will be loaded from the configuration file, including channel, token, instance, region, plans_preference, and the advanced configuration parameters: url, url_resolver, private_endpoint, verify, and proxies. Important Note: An explicit instance value provided during instantiation will overwrite the value of the loaded instance.
If no name is specified: if channel is specified, the service will load the default account associated with that channel from the configuration file. Else, it will fall back to the overall default account, defined when calling save_account() with set_as_default=True.

Parameters

channel (Optional[ChannelType]) – String that identifies the service platform. This is set to ibm_quantum_platform by default, but can additionally take local and ibm_cloud as values. If local is selected, the local testing mode will be used, and primitive queries will run on a local simulator. For more details, check the Qiskit Runtime local testing mode documentation. For non-local modes, the channel is used to resolve the default API URL value. ibm_cloud was the identifier for the legacy IBM Cloud platform, and its url will be redirected to the new ibm_quantum_platform url.
token (Optional[str]) – IBM Cloud API key. Providing an API key is required for IQP authentication. If not provided explicitly, the default saved account will be queried for this API key.
url (Optional[str]) – The API URL. Defaults to different values depending on the selected channel: https://quantum.cloud.ibm.com (ibm_quantum_platform), or https://quantum-computing.cloud.ibm.com (ibm_cloud).
filename (Optional[str]) – Full path of the file where the account is created. Default: _DEFAULT_ACCOUNT_CONFIG_JSON_FILE.
name (Optional[str]) – Name of the account to load from file.
instance (Optional[str]) – The service instance to use. For ibm_cloud and ibm_quantum_platform, this is the Cloud Resource Name (CRN) or the service name. If set, it will define an instance for service instantiation, if not set, the service will fetch all instances accessible within the account following the specified filtering criteria.
proxies (Optional[dict]) – Proxy configuration. Supported optional keys are urls (a dictionary mapping protocol or protocol and host to the URL of the proxy, documented at https://requests.readthedocs.io/en/latest/api/#requests.Session.proxies), username_ntlm, password_ntlm (username and password to enable NTLM user authentication)
verify (Optional[bool]) – Whether to verify the server’s TLS certificate.
private_endpoint (Optional[bool]) – Connect to private API URL.
url_resolver (Optional[Callable]) – Function used to resolve the runtime url.
region (Optional[str]) – Set a region preference for automatic instance selection. This argument is ignored if an instance is specified. Accepted values are us-east or eu-de. An instance with this region will be prioritized if an instance is not passed in.
plans_preference (Optional[List[str]]) – A list of account plan names ordered by priority for automatic instance selection. This argument is ignored if an instance is specified. Only instances with the given plan names will be considered. For example, if you want to avoid using your premium accounts you can just pass in "open" to only use your open plan instances. Accepted values include (but are not limited to): open, premium, flex, on-prem, pay-as-you-go.
tags (Optional[List[str]]) – Set a list of tags to filter available instances for automatic instance selection. This argument is ignored if an instance is specified.

Returns

An instance of QiskitRuntimeService or QiskitRuntimeLocalService for local channel.

Raises

IBMInputValueError – If an input is invalid.

Attributes

channel

Return the channel type used.

Returns

The channel type used.

Methods

active_account

active_account()

GitHub

Return the IBM Quantum account currently in use for the session.

Returns

A dictionary with information about the account currently in the session.

Return type

Dict[str, str] | None

active_instance

active_instance()

GitHub

Return the crn of the current active instance.

Return type

str

backend

backend(name, instance=None, use_fractional_gates=False)

GitHub

Return a single backend matching the specified filtering.

Parameters

name (str) – Name of the backend.
instance (str | None) – Specify the IBM Cloud account CRN.
use_fractional_gates (bool | None) – Set True to allow for the backends to include fractional gates. Currently this feature cannot be used simultaneously with dynamic circuits, PEC, PEA, or gate twirling. When this flag is set, control flow instructions are automatically removed from the backend. When you use a dynamic circuits feature (e.g. if_else) in your algorithm, you must disable this flag to create executable ISA circuits. This flag might be modified or removed when our backend supports dynamic circuits and fractional gates simultaneously. If None, then both fractional gates and control flow operations are included in the backends.

Returns

A backend matching the filtering.

Return type

Backend

Raises

QiskitBackendNotFoundError – if no backend could be found.

backends

backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, *, use_fractional_gates=False, **kwargs)

GitHub

Return all backends accessible via this account, subject to optional filtering.

Parameters

name (str | None) – Backend name to filter by.
min_num_qubits (int | None) – Minimum number of qubits the backend has to have.
instance (str | None) – IBM Cloud account CRN
dynamic_circuits (bool | None) – Filter by whether the backend supports dynamic circuits.

filters (Callable[[IBMBackend], bool] | None) –

More complex filters, such as lambda functions. For example:

QiskitRuntimeService.backends(
    filters=lambda b: b.max_shots > 50000
)
QiskitRuntimeService.backends(
    filters=lambda x: ("rz" in x.basis_gates )
)

use_fractional_gates (bool | None) – Set True to allow for the backends to include fractional gates. Note that our backends now support dynamic circuits and fractional gates simultaneously. You no longer have to disable this flag when using dynamic circuits features (e.g. if_else) in your algorithm. Control flow instructions are not removed from the backend when this flag is set to True. If None, then both fractional gates and control flow operations are included in the backends.

**kwargs (Any) –

Simple filters that require a specific value for an attribute in backend configuration or status. Examples:

# Get the operational real backends
QiskitRuntimeService.backends(simulator=False, operational=True)
 
# Get the backends with at least 127 qubits
QiskitRuntimeService.backends(min_num_qubits=127)
 
# Get the backends that support OpenPulse
QiskitRuntimeService.backends(open_pulse=True)

For the full list of backend attributes, see the IBMBackend class documentation

Returns

The list of available backends that match the filter.

Raises

IBMInputValueError – If an input is invalid.
QiskitBackendNotFoundError – If the backend is not in any instance.

Return type

List[IBMBackend]

check_pending_jobs

check_pending_jobs()

GitHub

(DEPRECATED) Check the number of pending jobs and wait for the oldest pending job if the maximum number of pending jobs has been reached.

Return type

None

delete_account

static delete_account(filename=None, name=None, channel=None)

GitHub

Delete a saved account from disk.

Parameters

filename (str | None) – Name of file from which to delete the account.
name (str | None) – Name of the saved account to delete.
channel (Literal['ibm_quantum_platform', 'ibm_cloud', 'local'] | None) – Channel type of the default account to delete. Ignored if account name is provided.

Returns

True if the account was deleted. False if no account was found.

Return type

bool

delete_job

delete_job(job_id)

GitHub

(DEPRECATED) Delete a runtime job.

Note that this operation cannot be reversed.

Parameters

job_id (str) – ID of the job to delete.

Raises

RuntimeJobNotFound – The job doesn’t exist.
IBMRuntimeError – Method is not supported.

Return type

None

instances

instances()

GitHub

Return a list that contains a series of dictionaries with the

following instance identifiers per instance: “crn”, “plan”, “name”.

Returns

A list with instances available for the active account.

Return type

Sequence[Dict[str, Any]]

job

job(job_id)

GitHub

Retrieve a runtime job.

Parameters

job_id (str) – Job ID.

Returns

Runtime job retrieved.

Raises

RuntimeJobNotFound – If the job doesn’t exist.
IBMRuntimeError – If the request failed.

Return type

RuntimeJobV2

jobs

jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)

GitHub

Retrieve all runtime jobs, subject to optional filtering.

Parameters

limit (int | None) – Number of jobs to retrieve. None means no limit.
skip (int) – Starting index for the job retrieval.
backend_name (str | None) – Name of the backend to retrieve jobs from.
pending (bool | None) – Filter by job pending state. If True, ‘QUEUED’ and ‘RUNNING’ jobs are included. If False, ‘DONE’, ‘CANCELLED’ and ‘ERROR’ jobs are included.
program_id (str | None) – Filter by Program ID.
instance (str | None) – Filter by IBM Cloud instance crn.
job_tags (List[str] | None) – Filter by tags assigned to jobs. Matched jobs are associated with all tags.
session_id (str | None) – Filter by session id. All jobs in the session will be returned in desceding order of the job creation date.
created_after (datetime | None) – Filter by the given start date, in local time. This is used to find jobs whose creation dates are after (greater than or equal to) this local date/time.
created_before (datetime | None) – Filter by the given end date, in local time. This is used to find jobs whose creation dates are before (less than or equal to) this local date/time.
descending (bool) – If True, return the jobs in descending order of the job creation date (i.e. newest first) until the limit is reached.

Returns

A list of runtime jobs.

Raises

IBMInputValueError – If an input value is invalid.

Return type

List[RuntimeJobV2]

least_busy

least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)

GitHub

Return the least busy available backend.

Parameters

min_num_qubits (int | None) – Minimum number of qubits the backend has to have.
instance (str | None) – IBM Cloud account CRN.
filters (Callable[[IBMBackend], bool] | None) –

Filters can be defined as for the backends() method. An example to get the operational backends with 5 qubits:
```
QiskitRuntimeService.least_busy(n_qubits=5, operational=True)
```
kwargs (Any)

Returns

The backend with the fewest number of pending jobs.

Raises

QiskitBackendNotFoundError – If no backend matches the criteria.

Return type

IBMBackend

save_account

static save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, set_as_default=None, private_endpoint=False, region=None, plans_preference=None, tags=None)

GitHub

Save the account to disk for future use.

Parameters

token (str | None) – IBM Cloud API key.
url (str | None) – The API URL. Defaults to https://cloud.ibm.com.
instance (str | None) – This is an optional parameter to specify the CRN or service name. If set, it will define a default instance for service instantiation, if not set, the service will fetch all instances accessible within the account.
channel (Literal['ibm_quantum_platform', 'ibm_cloud', 'local'] | None) – Channel type. ibm_cloud or ibm_quantum_platform.
filename (str | None) – Full path of the file where the account is saved.
name (str | None) – Name of the account to save.
proxies (dict | None) – Proxy configuration. Supported optional keys are urls (a dictionary mapping protocol or protocol and host to the URL of the proxy, documented at https://requests.readthedocs.io/en/latest/api/#requests.Session.proxies), username_ntlm, password_ntlm (username and password to enable NTLM user authentication)
verify (bool | None) – Verify the server’s TLS certificate.
overwrite (bool | None) – True if the existing account is to be overwritten.
set_as_default (bool | None) – If True, the account is saved in filename, as the default account.
private_endpoint (bool | None) – Connect to private API URL.
region (Literal['us-east', 'eu-de'] | None) – Set a region preference. us-east or eu-de. An instance with this region will be prioritized if an instance is not passed in.
plans_preference (List[str] | None) – A list of account plan names (open, premium, etc.), ordered by preference. An instance with the first value in the list will be prioritized and only instances with the given plan names will be considered. For example, if you want to avoid using your premium accounts you can just pass in "open" to only use your open plan instances. plans_preference is ignored if an instance is specified.
tags (List[str] | None) – Set a list of tags to filter available instances. Instances with these tags will be prioritized if an instance is not passed in.

Return type

None

saved_accounts

static saved_accounts(default=None, channel=None, filename=None, name=None)

GitHub

List the accounts saved on disk.

Parameters

default (bool | None) – If set to True, only default accounts are returned.
channel (Literal['ibm_quantum_platform', 'ibm_cloud', 'local'] | None) – Channel type.``ibm_cloud`` or ibm_quantum_platform.
filename (str | None) – Name of file whose accounts are returned.
name (str | None) – If set, only accounts with the given name are returned.

Returns

A dictionary with information about the accounts saved on disk.

Raises

ValueError – If an invalid account is found on disk.

Return type

dict

usage

usage()

GitHub

Return usage information for the current active instance.

Returns

Dict with usage details.

Return type

Dict[str, Any]