Visual Studio Code

​

Quantum Console Extension

The Quantum Console VS Code extension pack provides a powerful interface for quantum computing workflows, enabling seamless management of quantum jobs and devices through qBraid’s public APIs.

​

Installation

The Quantum Console extension can be installed directly through the VS Code Marketplace.

​

Quantum Devices

Monitor the status, queue depth, capabilities, and other details of quantum devices accessible through qBraid.

The Quantum Devices sidebar displays the quantum hardware and simulators available to you via the qBraid-SDK. This includes QPUs from IonQ, Oxford Quantum Circuits, QuEra, Rigetti, and IQM, as well as on-demand simulators from qBraid, AWS, IonQ, QuEra, and NEC. For more details on access and costs, see the pricing page.

​

Quantum Jobs

Track and manage quantum jobs submitted through qBraid.

Jobs submitted via the qbraid.runtime.QbraidProvider will automatically appear in the Quantum Jobs sidebar, where you can:

• Search & Filter – Find jobs by ID, status, tags, and other attributes.
• Monitor Progress – Track job status and queue position in real-time.
• Inspect Details – View circuit diagrams, cost estimates, and job metadata.
• Retrieve Results – Download measurement counts and execution data for analysis.
• Manage Jobs – Cancel or delete jobs as needed.

​

Authentication

The Quantum Console extension pack requires a qBraid API Key:

1. Login or create a free account at account.qbraid.com.
2. Copy your API Key from the Plan info card on the left side of your account page.
3. Enter the API Key when prompted by the extension.

For more information, refer to the API Keys documentation.

​

Connect to qBraid Lab Environments

Connecting your qBraid Lab account to Visual Studio Code enables running Jupyter Notebooks on your local machine while still accessing the pre-packaged environments, compute resources, and other software and API’s available through qBraid Lab.

​

Get access token

1. Log in to lab.qbraid.com.
2. Access your Control Panel by clicking File -> Hub Control Panel.

3. Navigate to the ‘Token’ page by clicking Token in the top bar.

4. Type in a description for the new token you want, and click Request new API Token.

5. Copy your token and keep it somewhere safe. You should treat this like a password to your qBraid Lab account, and revoke it from the same page when you are no longer using it.

​

Connect VS Code to Lab

1. Open the command palette in VS Code (Cmd+Shift+P on MacOS, Ctrl+Shift+P elsewhere).
2. Select Jupyter: Specify Jupyter Server for Connections, and then select Existing.

3. Construct your notebook server URL with the following template: https://lab.qbraid.com/user/<your-lab-username>/?token=<your-token>.

Your Lab username is generated from the email address associated with your qBraid account.

Note:

If your account email uses special characters, your Lab username might be escaped, i.e. modified, from your raw email address. You can verify this by looking at the URL you get after launching Lab; your username will be appear right after .../user/.

4. Create or open a new notebook, and select a notebook kernel from any of your installed and active qBraid Lab environments.