Set up an IBM Quantum channel

You can access IBM® quantum processing units (QPUs) by using the IBM Quantum Platform or IBM Cloud® channel. Channel is the term used to describe the method you use to access IBM Quantum services.

Select an IBM Quantum channel

You have the option to access IBM Quantum hardware through either IBM Quantum Platform or IBM Cloud.

IBM Quantum Platform

IBM Quantum Platform has Open (free access) and Premium (enterprise subscription) plans. See IBM Quantum access plans for details.

Before setting up with IBM Quantum Platform, make sure you have the Qiskit SDK and Qiskit Runtime installed.

Available plans:

Open Plan - Run your quantum circuits on the world's best QPUs for free (up to 10 minutes quantum time per month).
Premium Plan - Run quantum circuits on the world's best QPUs using an enterprise quantum time subscription.

IBM Cloud

IBM Cloud offers pay-as-you-go access plans. See IBM Quantum access plans for details.

IBM Cloud has Lite (free access) and Standard (pay-as-you-go access) plans. See Qiskit Runtime plans on IBM Cloud for details.

This channel does not support a cloud-based development environment. Therefore, you will need to install and set up Qiskit and Qiskit Runtime and set up to use IBM Cloud.

Available plans:

Standard (Pay-as-you-go) Plan - Run quantum circuits on the world's best QPUs and pay only for the quantum time you use.
Lite plan: Debug and learn about quantum circuits using free simulators.

Set up to use IBM Quantum Platform

Before setting up with IBM Quantum Platform, ensure you are working in an active Python environment with the Qiskit SDK and Qiskit Runtime installed.
If you do not already have a user account, get one at the IBM Quantum login page. Your user account is associated with one or more instances (in the form hub / group / project) that give access to IBM Quantum services. Additionally, a unique token is assigned to each account, allowing for IBM Quantum access from Qiskit. The instructions in this section use our default instance. For instructions to choose a specific instance, see Connect to an instance.

Note
The Instances section in your IBM Quantum account page lists the instances that you can access.
Retrieve your API token from the IBM Quantum account page. If you are on a trusted machine, use the save_account() method to save your credentials locally. (Skip to the next step if you are not using a trusted machine to authenticate to IBM Quantum Platform.) To use save_account(), first activate your Python virtual environment (see the installation instructions if you do not already have a virtual environment set up) and run Python to open a read-eval-print loop (REPL), then enter the following:
```
from qiskit_ibm_runtime import QiskitRuntimeService
 
QiskitRuntimeService.save_account(
  token="<your-token">,
  channel="ibm_quantum" # `channel` distinguishes between different account types
)
```
Close out of the REPL with exit(). Whenever you need to authenticate to the service, you can load your credentials with QiskitRuntimeService().

Warning
Protect your API token! Never include your token in plain text in a notebook file. If you are on a trusted machine, use the save_account() method described in the previous step to store your credentials, keeping in mind that your token will still be stored as plain text on your local drive. If you are not on a trusted machine, use the instructions in the next step.
- If you have saved credentials for both an IBM Quantum Platform account and an IBM Cloud account, IBM Cloud is the default account used when you initialize your account, unless you specify set_as_default=True in your IBM Quantum Platform account when you use the save_account() method. (REVIEWERS: IS THIS TRUE??)
- If you are saving multiple accounts per channel, consider using the name parameter to differentiate them. (REVIEWERS: Does each named account within the same channel use the same API token, or does each have a unique token?)
- Credentials are saved to $HOME/.qiskit/qiskit-ibm.json. Do not manually edit this file.
If you are not on a trusted machine (such as a shared computer), do the following to authenticate, while being careful not to save your API token in a notebook file or any other file on the local machine.
```
from qiskit_ibm_runtime import QiskitRuntimeService
 
service = QiskitRuntimeService(channel="ibm_quantum", token="<MY_IBM_QUANTUM_TOKEN>")
```
Test your setup. Run a simple circuit using Sampler to ensure that your environment is set up properly:

from qiskit import QuantumCircuit
from qiskit_ibm_runtime import QiskitRuntimeService, SamplerV2 as Sampler
 
# Create empty circuit
example_circuit = QuantumCircuit(2)
example_circuit.measure_all()
 
# You'll need to specify the credentials when initializing QiskitRuntimeService, if they were not previously saved.
service = QiskitRuntimeService()
backend = service.least_busy(operational=True, simulator=False)
 
sampler = Sampler(backend)
job = sampler.run([example_circuit])
print(f"job id: {job.job_id()}")
result = job.result()
print(result)

Set up to use IBM Quantum Platform with REST API

Alternatively, you can also access quantum processors with REST APIs, enabling you to work with QPUs using any programming language or framework.

Retrieve your IBM Quantum token from the IBM Quantum account page.
If you do not already have a user account, get one at the IBM Quantum login page. Your user account is associated with one or more instances (in the form hub / group / project) that give access to IBM Quantum services. Additionally, a unique token is assigned to each account, allowing for IBM Quantum access from Qiskit. The instructions in this section use our default instance. For instructions to choose a specific instance, see Connect to an instance.

Note
The Instances section in your IBM Quantum account page lists the instances that you can access.
Optionally obtain a temporary access token by supplying the API token obtained above. This is especially useful if you would like control over tokens, such as token invalidation. Alternatively, you can work directly with your IBM Quantum Platform API token.
```
import requests
 
url = 'https://auth.quantum-computing.ibm.com/api/users/loginWithToken'
input={'apiToken': "<MY_IBM_QUANTUM_TOKEN>"}
auth_response = requests.post(url, json=input)
auth_id=auth_response.json()['id']
```

View your available backends:

url_backends = 'https://api.quantum-computing.ibm.com/runtime/backends'
headers = {'Content-Type': 'application/json',
            'x-access-token':auth_id}
 
backends_response = requests.get(url_backends, headers=headers)
 
print(backends_response.json()['devices'][:5],"...")

You can then transpile circuits using REST API and run them using either the Sampler or the Estimator primitives.

After your experiments are complete, you can proceed to invalidate your token and then test its invalidation.

logout_url = 'https://auth.quantum-computing.ibm.com/api/users/logout'
headers = {'x-access-token':auth_id}
logout_response = requests.post(logout_url, headers=headers)
print("response ok?:",logout_response.ok,logout_response.text)

This should yield an error (Error 401) once the access token is invalidated.

logout_url = 'https://auth.quantum-computing.ibm.com/api/users/logout'
headers = {'x-access-token':auth_id}
logout_response = requests.post(logout_url, headers=headers)
 
if logout_response.status_code == 200:
    job_id = logout_response.json().get('id')
    print("Job created:",logout_response.text)
elif logout_response.status_code == 401:
    print("invalid credentials. Access token should be successfully invalidated.")
else:
    print(logout_response.text,"\n")
    print(f"Error: {logout_response.status_code}")

Output

  invalid credentials. Access token should be successfully invalidated.

Set up to use IBM Cloud

Before setting up with IBM Cloud, ensure you are working in an active Python environment with the Qiskit SDK and Qiskit Runtime installed.
If you do not already have one, set up an IBM Cloud account from the IBM Cloud Registration page.
Create a service instance, if necessary. Open your IBM Cloud Instances page. If you have one or more instances shown, continue to the next step. Otherwise, click Create instance. When creating your instance you can name it, tag it, select a resource group for it, and select a performance strategy. Next, agree to the license agreements by checking the box in the bottom right corner of the page, and click Create.

Note
If you are an administrator who needs to set up Qiskit Runtime on Cloud for your organization, refer to Plan Qiskit Runtime for an organization.
Find your access credentials.
1. Find your API key. From the API keys page, view or create your API key, then copy it to a secure location so you can use it for authentication.
2. Find your Cloud Resource Name (CRN). Open the Instances page and click your instance. In the page that opens, click the icon to copy your CRN. Save it in a secure location so you can use it for authentication.
Authenticate to the service by calling QiskitRuntimeService with your saved credentials or with your IBM Cloud API key and CRN. Remember that your credentials should be kept confidential, so do not share it in a notebook or in any public code.
```
from qiskit_ibm_runtime import QiskitRuntimeService
 
service = QiskitRuntimeService(
channel="ibm_cloud",
token="<IBM Cloud API key>", # Your token is confidential.
# Take care not to share your token in public code.
instance="<IBM Cloud CRN>"
)
```
You can optionally use the save_account() method to save your credentials for easy access later on, before initializing the service. See these instructions to create an environment variable to use in the following code. Credentials are saved locally as plain text. Never include your token in a notebook or public code!
```
import os
from qiskit_ibm_runtime import QiskitRuntimeService
 
# Save account to disk.
QiskitRuntimeService.save_account(
    channel="ibm_cloud",
    token=iqp_api_token,
    instance="<IBM Cloud CRN>",
    name="<account-name>",
    # Use `overwrite=True` if you're updating your token.
    overwrite=True,
)
 
# Load saved credentials
service = QiskitRuntimeService(name="<account-name>")
```
- If you save your credentials to disk, you can use QiskitRuntimeService() in the future to initialize your account. The channel parameter distinguishes between different account types. When initializing the account, IBM Cloud is the default account used if you have saved credentials for both an IBM Quantum Platform and an IBM Cloud account unless you specify otherwise with the channel parameter.
- If you are saving multiple accounts per channel, consider using the name parameter to differentiate them.
- Credentials are saved to $HOME/.qiskit/qiskit-ibm.json. Do not manually edit this file.
- If you don't save your credentials, you must specify them every time you start a new session.
Test your setup. Ensure that you can connect to the service:

from qiskit_ibm_runtime import QiskitRuntimeService
 
service = QiskitRuntimeService()

Next steps

Recommendations

Configure the Qiskit SDK locally.
Follow the steps in Hello world to write and run a quantum program.
Get started with IBM Quantum on Cloud.
Try a tutorial in IBM Quantum Learning.