qBraid

https://docs.qbraid.com/
Admin
qBraid is a comprehensive platform providing an integrated development environment (IDE), SDK, APIs,...
Tokens:98,386
Snippets:1,134
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install qBraid SDK

Source: https://docs.qbraid.com/v2/sdk

Standard installation method using pip.

```bash
pip install qbraid
```

--------------------------------

### qbraid compute up

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_compute

Starts a server instance and configures SSH. This command combines server startup and SSH setup into a single operation.

```APIDOC
## qbraid compute up

### Description
Starts a server instance and configures SSH. This is a convenience command that waits for the server to be ready.

### Usage
`qbraid compute up [OPTIONS] {profile_slug}`

### Arguments
- **profile_slug** (string) - Required - Profile slug to start

### Options
- **-c, --cluster** (string) - Optional - Cluster ID
- **-t, --timeout** (integer) - Optional - Server start timeout (default: 120)
- **--no-ssh** (boolean) - Optional - Skip SSH configuration
- **--help** (boolean) - Optional - Show help message
```

--------------------------------

### Install from source

Source: https://docs.qbraid.com/v2/qir/user-guide/overview

Steps to clone the repository and install the package locally.

```shell
git clone https://github.com/qBraid/qbraid-qir.git
cd qbraid-qir
pip install .
```

--------------------------------

### Install qBraid SDK from Source

Source: https://docs.qbraid.com/v2/sdk

Installation method for developers cloning the repository directly.

```bash
git clone https://github.com/qBraid/qBraid.git
cd qBraid
pip install .
```

--------------------------------

### Quick Start qBraid Skills Commands

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_skills

Basic commands to browse, install, and create skills.

```bash
qbraid skills list             # Browse available skills
qbraid skills install <slug>   # Install a skill
qbraid skills create           # Create a new skill
```

--------------------------------

### Install qBraid-CORE

Source: https://docs.qbraid.com/v2/core/user-guide/overview

Install the library from PyPI using pip.

```bash
pip install qbraid-core
```

--------------------------------

### Install qBraid-CLI

Source: https://docs.qbraid.com/v2/cli/user-guide/overview

Install the base qBraid-CLI package from PyPI.

```bash
pip install qbraid-cli
```

--------------------------------

### Install qBraid Algorithms from source

Source: https://docs.qbraid.com/v2/algorithms

Steps to clone the repository and install the package from the root directory.

```bash
git clone https://github.com/qBraid/qbraid-algorithms.git
cd qbraid-algorithms
pip3 install .
```

--------------------------------

### List Environments

Source: https://docs.qbraid.com/v2/cli

Example command to list installed Python environments.

```bash
$ qbraid envs list
```

--------------------------------

### Install qBraid-QIR

Source: https://docs.qbraid.com/v2/qir

Standard installation command for the qBraid-QIR package.

```bash
pip install qbraid-qir
```

--------------------------------

### Install qBraid Algorithms via pip

Source: https://docs.qbraid.com/v2/algorithms

Standard installation command for the package.

```bash
pip install qbraid-algorithms
```

--------------------------------

### Install an environment

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_envs

Installs a pre-built environment from cloud storage. Use the env_slug obtained from qbraid envs available.

```console
$ qbraid envs install [OPTIONS] {env_slug}
```

--------------------------------

### Install and Configure qBraid CLI

Source: https://docs.qbraid.com/v2/account/overview

Install the required CLI package and perform initial configuration using an API key.

```bash
pip install 'qbraid-cli>=0.12'
```

```bash
qbraid configure
```

```bash
pip install -U qbraid qbraid-cli
```

--------------------------------

### List installed environments

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_envs

Displays all currently installed qBraid environments.

```console
$ qbraid envs list [OPTIONS]
```

--------------------------------

### List installable environments

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_envs

Lists pre-built environments available for installation with optional pagination support.

```console
$ qbraid envs available [OPTIONS]
```

--------------------------------

### qbraid envs install

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_envs

Installs a pre-built environment from cloud storage to your local system.

```APIDOC
## qbraid envs install

### Description
Installs a pre-built environment from cloud storage. If the environment is incompatible with your system, you will be prompted to create a similar local environment or proceed with the download.

### Usage
`qbraid envs install [OPTIONS] {env_slug}`

### Arguments
- **env_slug** (string) - Required - Environment slug to install.

### Options
- **-t, --temp** - Optional - Install as temporary environment (faster, non-persistent).
- **--target <str>** - Optional - Custom target directory (defaults to ~/.qbraid/environments).
- **-y, --yes** - Optional - Automatically proceed with default options without prompting.
- **--help** - Optional - Show this message and exit.
```

--------------------------------

### qbraid compute server start

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_compute

Start a server by providing a profile slug or an existing on-demand instance ID.

```APIDOC
## qbraid compute server start

### Description
Start a server. Pass a profile slug to provision a new instance, or an existing on-demand instance ID to resume a stopped one.

### Arguments
- **target** (string) - Required - Profile slug (new instance) or instance ID (resume a stopped one)

### Options
- **-c, --cluster** (str) - Optional - Cluster ID
- **-w, --wait** (flag) - Optional - Wait for server to be ready
- **-t, --timeout** (int) - Optional - Wait timeout in seconds (default: 120)
- **--ssh** (flag) - Optional - Configure SSH after start
```

--------------------------------

### Install from Source

Source: https://docs.qbraid.com/v2/qir

Commands to clone the repository and install the package from source, including optional dependencies.

```bash
git clone https://github.com/qBraid/qbraid-qir.git
cd qbraid-qir
pip install .
```

```bash
pip install '.[qiskit,cirq,qasm3,squin]'
```

--------------------------------

### Install PyQASM from source

Source: https://docs.qbraid.com/v2/pyqasm

Steps to clone the repository and install the package locally, including optional dependencies.

```bash
git clone https://github.com/qBraid/pyqasm.git
cd pyqasm
pip install .
```

```bash
pip install '.[cli,visualization]'
```

--------------------------------

### Install Intel Quantum SDK via CLI

Source: https://docs.qbraid.com/v2/lab/user-guide/featured-environments/intel-quantum-sdk

Use the qBraid CLI to locate and install the intelqsdk environment using its unique slug.

```bash
qbraid envs available              # find the intelqsdk environment and its slug
qbraid envs install intelq_r7zabv  # install by slug
```

--------------------------------

### Install qbraid-qir[squin]

Source: https://docs.qbraid.com/v2/qir/user-guide/qir-squin

Install the necessary package to enable Squin kernel conversion functionality.

```shell
pip install 'qbraid-qir[squin]'
```

--------------------------------

### Install qBraid CLI

Source: https://docs.qbraid.com/v2/cli

Install the base CLI package or the version with environment management extras.

```bash
pip install qbraid-cli
```

```bash
pip install 'qbraid-cli[envs]'
```

--------------------------------

### Install from source with extras

Source: https://docs.qbraid.com/v2/qir/user-guide/overview

Command to install the package from source including multiple optional dependencies.

```shell
pip install '.[qiskit,cirq,qasm3,squin]'
```

--------------------------------

### Install qBraid-CLI with Environment Support

Source: https://docs.qbraid.com/v2/cli/user-guide/overview

Install the CLI with the 'envs' extra to enable environment management capabilities.

```bash
pip install 'qbraid-cli[envs]'
```

--------------------------------

### Install qBraid Algorithms CLI

Source: https://docs.qbraid.com/v2/algorithms/user-guide/cli

Commands to install the CLI dependencies via pip.

```bash
pip install "qbraid-algorithms[cli]"
```

```bash
pip install -e ".[cli]"
```

--------------------------------

### Copy bundled quantum examples

Source: https://docs.qbraid.com/v2/lab/user-guide/featured-environments/intel-quantum-sdk

Copies pre-installed example scripts from the SDK share directory to the current workspace.

```python
import os
import shutil

shutil.copy(
    os.path.join(os.environ["IQSDK_SHARE"], "python-quantum-examples", "run_ghz.py"),
    ".",
)
```

--------------------------------

### qbraid skills install

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_skills

Installs a specific skill for supported AI coding tools.

```APIDOC
## qbraid skills install

### Description
Install a skill for AI coding tools.

### Usage
`qbraid skills install [OPTIONS] {slug}`

### Arguments
- **slug** (string) - Required - The skill slug to install

### Options
- **-t, --target** (claude-code|codex|cursor|copilot|all) - Optional - Target AI coding tool(s) to install for (default: claude-code)
```

--------------------------------

### Basic CLI Interaction

Source: https://docs.qbraid.com/v2/cli

Verify installation and view the CLI welcome screen.

```bash
$ qbraid
----------------------------------
  * Welcome to the qBraid CLI! *
----------------------------------

        ____            _     _
   __ _| __ ) _ __ __ _(_) __| |
  / _` |  _ \| '__/ _` | |/ _` |
 | (_| | |_) | | | (_| | | (_| |
  \__,_|____/|_|  \__,_|_|\__,_|
     |_|


- Use 'qbraid --help' to see available commands.

- Use 'qbraid --version' to see the current version.

Reference Docs: https://docs.qbraid.com/v2/cli/api-reference/qbraid
```

--------------------------------

### Start compute server

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_compute

Starts a server with the specified profile and configures SSH. Requires a profile slug as an argument.

```bash
qbraid compute up 2vCPU_4GB
```

```console
$ qbraid compute up [OPTIONS] {profile_slug}
```

--------------------------------

### Install Optional Dependencies

Source: https://docs.qbraid.com/v2/qir

Commands to install specific extras for Cirq, OpenQASM 3, Qiskit, and Squin support.

```bash
pip install 'qbraid-qir[cirq]'
```

```bash
pip install 'qbraid-qir[qasm3]'
```

```bash
pip install 'qbraid-qir[qiskit]'
```

```bash
pip install 'qbraid-qir[squin]'
```

--------------------------------

### Install visualization dependencies

Source: https://docs.qbraid.com/v2/pyqasm/user-guide/circuit-drawer

Install the necessary extra package to enable circuit drawing functionality.

```shell
pip install 'pyqasm[visualization]'
```

--------------------------------

### qbraid envs available

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_envs

Lists pre-built environments available for installation.

```APIDOC
## qbraid envs available

### Description
List installable environments. Shows available pre-built environments for installation.

### Usage
`qbraid envs available [OPTIONS]`

### Options
- **-p, --page** (int) - Optional - Page number for pagination (default: 1)
- **-l, --limit** (int) - Optional - Number of environments per page (default: 20)
- **--help** - Show this message and exit.
```

--------------------------------

### Complete Workflow Examples

Source: https://docs.qbraid.com/v2/algorithms/user-guide/cli

Common usage patterns for generating subroutines.

```bash
qbraid-algorithms generate qft --qubits 3
```

```bash
qbraid-algorithms generate bernvaz --secret "101" --oracle-only --show
```

```bash
qbraid-algorithms generate iqft --qubits 4 --output my_iqft_4.qasm --show
```

--------------------------------

### Install PyQASM with optional dependencies

Source: https://docs.qbraid.com/v2/pyqasm

Commands to install specific extras for CLI tools or circuit visualization.

```bash
pip install 'pyqasm[cli]'
```

```bash
pip install 'pyqasm[visualization]'
```

--------------------------------

### Install packages with qbraid pip

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_pip

Syntax for running pip install commands within the qBraid environment.

```console
$ qbraid pip install [OPTIONS]
```

--------------------------------

### Install a Hub project

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_projects

Clones a project repository and installs its associated environments, handling platform and Python version mismatches automatically.

```console
$ qbraid projects install [OPTIONS] {slug}
```

--------------------------------

### qbraid projects install

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_projects

Clones a Hub project repository and installs its associated environments, with automatic handling for platform and Python version mismatches.

```APIDOC
## qbraid projects install

### Description
Install a Hub project by cloning the repo and installing environments. Automatically handles platform and Python version mismatches.

### Usage
`qbraid projects install [OPTIONS] {slug}`

### Arguments
- **slug** (str) - Required - The slug of the project to install.

### Options
- **-t, --target-dir** (str) - Optional - Directory to clone the project into (defaults to ~/).
- **--no-envs** (flag) - Optional - Skip installing the project's associated environments.
```

--------------------------------

### Install qbraid-qir Qiskit extra

Source: https://docs.qbraid.com/v2/qir/user-guide/qiskit-qir

Install the necessary package to enable Qiskit to QIR conversion. Requires Qiskit version 2.0 or higher.

```shell
pip install 'qbraid-qir[qiskit]'
```

--------------------------------

### Verify PyQASM CLI Installation

Source: https://docs.qbraid.com/v2/pyqasm/user-guide/cli

Check the installation and view available commands using the help flag.

```shell
pyqasm --help
```

```shell
Usage: pyqasm [OPTIONS] COMMAND [ARGS]...

The PyQASM CLI.

╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --version             -v        Show the version and exit.                                                     │
│ --install-completion            Install completion for the current shell.                                      │
│ --show-completion               Show completion for the current shell, to copy it or customize the             │
│                                 installation.                                                                  │
│ --help                -h        Show this message and exit.                                                    │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ validate   Validate OpenQASM files.                                                                            |
| unroll     Unroll OpenQASM files.                                                                                                               │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Get Job Program Response Example

Source: https://docs.qbraid.com/v2/api-reference/rest/get-job-program

Example JSON response returned upon a successful request to the get job program endpoint.

```json
{
    "success": true,
    "data": {
      "format": "qasm3",
      "data": "OPENQASM 3;\ninclude \"stdgates.inc\";\nqubit[2] q;\nh q[0];\ncx q[0], q[1];\nmeasure q;"
    }
  }
```

--------------------------------

### Get All Devices Response Example

Source: https://docs.qbraid.com/v2/api-reference/rest/get-quantum-devices

Example JSON response structure for a successful request to the devices endpoint.

```json
{
    "success": true,
    "data": [
      {
        "name": "QIR sparse simulator",
        "qrn": "qbraid:qbraid:sim:qir-sv",
        "vendor": "qbraid",
        "deviceType": "SIMULATOR",
        "runInputTypes": ["qasm2", "qasm3", "qir.bc", "qir.ll"],
        "status": "ONLINE",
        "statusMsg": null,
        "nextAvailable": null,
        "queueDepth": 0,
        "avgQueueTime": null,
        "numberQubits": 64,
        "paradigm": "gate_model",
        "modality": "sparse_simulator",
        "noiseModels": null,
        "pricingModel": "fixed",
        "pricing": {
          "perTask": 0.5,
          "perShot": 0,
          "perMinute": 7.5
        },
        "directAccess": true
      }
    ]
  }
```

--------------------------------

### Get All Jobs Response Example

Source: https://docs.qbraid.com/v2/api-reference/rest/get-quantum-jobs-list

Example JSON response structure for a successful request to the jobs list endpoint.

```json
{
    "success": true,
    "data": [
      {
        "name": "Bell state job",
        "shots": 1000,
        "deviceQrn": "qbraid:qbraid:sim:qir-sv",
        "tags": { "experiment": "bell-state" },
        "runtimeOptions": {},
        "jobQrn": "qbraid:job:abc123xyz",
        "batchJobQrn": null,
        "vendor": "qbraid",
        "provider": "qbraid",
        "status": "COMPLETED",
        "statusMsg": null,
        "experimentType": "gate_model",
        "queuePosition": null,
        "timeStamps": {
          "createdAt": "2025-01-15T10:30:00Z",
          "endedAt": "2025-01-15T10:30:05Z",
          "executionDuration": 5000
        },
        "cost": 0.501875,
        "estimatedCost": 0.5,
        "metadata": {}
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 1,
      "totalPages": 1,
      "hasNext": false,
      "hasPrev": false
    },
    "meta": {
      "timestamp": "2025-01-15T10:30:06.000Z"
    }
  }
```

--------------------------------

### Start a Server

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_compute

Provision a new instance using a profile slug or resume a stopped instance using an ID.

```console
$ qbraid compute server start [OPTIONS] {target}
```

--------------------------------

### qbraid envs list

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_envs

Lists all currently installed qBraid environments.

```APIDOC
## qbraid envs list

### Description
List installed qBraid environments.

### Usage
`qbraid envs list [OPTIONS]`

### Options
- **--help** - Show this message and exit.
```

--------------------------------

### Qubit Spectroscopy Example

Source: https://docs.qbraid.com/v2/pyqasm/user-guide/openpulse

Demonstrates frequency sweeping using a loop and defcal blocks.

```python
import pyqasm
qasm_code = """
OPENQASM 3.0;
defcalgrammar "openpulse";

complex[float[32]] amp = 1.0 + 2.0im;
cal {
   port d0;
   frame driveframe = newframe(d0, 5.0e9, 0.0);
   waveform wf = gaussian(amp, 16ns, 4ns);
}

const float frequency_start = 4.5e9;
const float frequency_step = 1e6;
const int frequency_num_steps = 3;

defcal saturation_pulse $0 {
   play(driveframe, constant(amp, 100e-6s));
}

cal {
   set_frequency(driveframe, frequency_start);
}

for int i in [1:frequency_num_steps] {
   cal {
       shift_frequency(driveframe, frequency_step);
   }
   saturation_pulse $0;
}
"""
module = pyqasm.loads(qasm_code)
module.unroll()

print(pyqasm.dumps(module))
```

```qasm
OPENQASM 3.0;
qubit[1] __PYQASM_QUBITS__;
defcalgrammar "openpulse";
cal {
 port d0;
 frame driveframe = newframe(d0, 5000000000.0, 0.0, 0ns);
 waveform wf = gaussian(1.0 + 2.0im, 16.0ns, 4.0ns);
}
defcal saturation_pulse() $0 {
 play(driveframe, constant(amp, 0.0001s));
}
cal {
 set_frequency(driveframe, 4500000000.0);
}
cal {
 shift_frequency(driveframe, 4501000000.0);
}
saturation_pulse __PYQASM_QUBITS__[0];
cal {
 shift_frequency(driveframe, 4502000000.0);
}
saturation_pulse __PYQASM_QUBITS__[0];
cal {
 shift_frequency(driveframe, 4503000000.0);
}
saturation_pulse __PYQASM_QUBITS__[0];
```

--------------------------------

### Initialize qBraid CLI

Source: https://docs.qbraid.com/v2/cli/user-guide/overview

Display the welcome banner and basic usage instructions.

```bash
$ qbraid
----------------------------------
  * Welcome to the qBraid CLI! *
----------------------------------

        ____            _     _ 
   __ _| __ ) _ __ __ _(_) __| |
  / _` |  _ \| '__/ _` | |/ _` |
 | (_| | |_) | | | (_| | | (_| |
  \__,_|____/|_|  \__,_|_|\__,_|
     |_|


- Use 'qbraid --help' to see available commands.

- Use 'qbraid --version' to see the current version.
```

--------------------------------

### Get Device Response Example

Source: https://docs.qbraid.com/v2/api-reference/rest/get-device

Successful response structure for a device lookup, including device capabilities, status, and pricing information.

```json
{
    "success": true,
    "data": {
      "runInputTypes": ["pyqir", "qasm3"],
      "numberQubits": 64,
      "noiseModels": [],
      "statusMsg": null,
      "nextAvailable": null,
      "avgQueueTime": null,
      "qrn": "qbraid:qbraid:sim:qir-sv",
      "modality": null,
      "name": "QIR Simulator",
      "paradigm": "gate_model",
      "pricing": {
        "perTask": 0,
        "perShot": 0,
        "perMinute": 0
      },
      "status": "ONLINE",
      "vendor": "qbraid",
      "description": "Sparse state vector simulator using QIR compiler. Free of cost.",
      "deviceType": "SIMULATOR",
      "queueDepth": 0,
      "directAccess": true,
      "pricingModel": "fixed"
    }
  }
```

--------------------------------

### Get Quantum Job Result Response

Source: https://docs.qbraid.com/v2/api-reference/rest/get-quantum-jobs-result

Example of a successful 200 OK response containing job status, cost, execution timestamps, and measurement counts.

```json
{
    "success": true,
    "data": {
      "status": "COMPLETED",
      "cost": 0.501875,
      "timeStamps": {
        "createdAt": "2025-01-15T10:30:00Z",
        "endedAt": "2025-01-15T10:30:05Z",
        "executionDuration": 5000
      },
      "resultData": {
        "measurementCounts": { "00": 504, "11": 496 }
      }
    }
  }
```

--------------------------------

### Configure qBraid environments

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_envs

Examples of viewing and updating environment configurations using various flags.

```bash
$ qbraid envs config 5dcc
$ qbraid envs config myenv --description "Quantum sim env"
$ qbraid envs config myenv --tags "quantum,sim,gpu"
$ qbraid envs config myenv --add-tag gpu --add-tag cuda
$ qbraid envs config myenv --remove-tag deprecated
$ qbraid envs config myenv --system-site-packages true
```

--------------------------------

### Initialize qBraid configuration

Source: https://docs.qbraid.com/v2/cli/user-guide/config-files

Run this command to interactively set up the configuration file with your API key.

```bash
qbraid configure
```

--------------------------------

### Create Job Response Example

Source: https://docs.qbraid.com/v2/api-reference/rest/post-quantum-jobs

Successful response returned after submitting a quantum job.

```json
{
    "success": true,
    "data": {
      "jobQrn": "aws:aws:sim:dm1-a1b2-qjob-1234567890abcdef",
      "status": "INITIALIZING"
    }
  }
```

--------------------------------

### Install packages using pip magic

Source: https://docs.qbraid.com/v2/lab/user-guide/notebooks

Use the %pip magic command to install packages within a notebook cell. Restart the kernel after installation for changes to take effect.

```python
[ ] %pip install <my-package>
```

--------------------------------

### Install PyQASM via pip

Source: https://docs.qbraid.com/v2/pyqasm

Standard installation command for the PyQASM package.

```bash
pip install pyqasm
```

--------------------------------

### Submit a Quantum Job with qBraid-SDK

Source: https://docs.qbraid.com/v2/lab/user-guide/quantum-jobs

Demonstrates how to list available devices, select a target, run a Qiskit circuit, and retrieve results using the qBraid runtime provider.

```python
from qbraid.runtime import QbraidProvider

# See available devices
provider = QbraidProvider()
devices = provider.get_devices()
print("Available devices:")
for device in devices:
    print(device.id, device.status())

# Select a device
device = provider.get_device("aws:rigetti:qpu:cepheus-1-108q")
print("\nSelected device:", device)

# Define your quantum circuit (example using Qiskit)
from qiskit import QuantumCircuit
qc = QuantumCircuit(2)
qc.h(0)
qc.cx(0, 1)
qc.measure_all()

# Run the quantum job
job = device.run(qc, shots=1024)
print("Job ID:", job.id)

print("Job submitted successfully.")

# Wait for the job to complete
job.wait_for_final_state()

# Retrieve and print the results
result = job.result()
print("Counts: ", result.data.get_counts())
```

--------------------------------

### Check skill installation

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_skills

Verifies if a specific skill is installed and identifies its location.

```console
$ qbraid skills check [OPTIONS] {slug}
```

--------------------------------

### Install PyQASM CLI

Source: https://docs.qbraid.com/v2/pyqasm/user-guide/cli

Install the CLI tool as an extra dependency for PyQASM.

```shell
pip install 'pyqasm[cli]'
```

--------------------------------

### List available quantum devices with QbraidProvider

Source: https://docs.qbraid.com/v2/sdk

Initialize the provider and retrieve a list of available device objects.

```python
from qbraid import QbraidProvider

provider = QbraidProvider()
devices = provider.get_devices()

print(devices)
```

--------------------------------

### Verify qBraid Setup

Source: https://docs.qbraid.com/v2/core/user-guide/overview

Confirm the configuration by listing available quantum devices through the runtime client.

```python
>>> from qbraid_core.services.runtime import QuantumRuntimeClient
>>> quantum_client = QuantumRuntimeClient()
>>> device_list = quantum_client.list_devices()
>>> for device in device_list:
...     print(device.qrn)
```

--------------------------------

### Configure qBraid CLI

Source: https://docs.qbraid.com/v2/cli

Initialize local configuration and API key settings.

```bash
$ qbraid configure
```

--------------------------------

### Check Installed Version

Source: https://docs.qbraid.com/v2/qir

Verify the installed version of qbraid-qir within a Python shell.

```python
In [1]: import qbraid_qir

In [2]: qbraid_qir.__version__
```

--------------------------------

### qbraid pip install

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_pip

Installs packages within the qBraid environment using pip.

```APIDOC
## qbraid pip install

### Description
Performs a pip install action within the environment using open-ended arguments and options.

### Usage
`qbraid pip install [OPTIONS]`

### Options
- **--help** - Show this message and exit.
```

--------------------------------

### Quick start compute commands

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_compute

Basic workflow for managing a compute server session.

```bash
qbraid compute up <profile>    # Start server + configure SSH
qbraid compute status          # Check server status
qbraid compute ssh connect     # SSH into running server
qbraid compute down            # Stop server
```

--------------------------------

### Check installed version

Source: https://docs.qbraid.com/v2/algorithms

Verify the installed version of the package within a Python shell.

```python
import qbraid_algorithms

qbraid_algorithms.__version__
```

--------------------------------

### qbraid skills installed

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_skills

Lists locally installed skills, optionally filtered by target tool.

```APIDOC
## qbraid skills installed

### Description
List locally installed skills.

### Usage
`qbraid skills installed [OPTIONS]`

### Options
- **-t, --target** (claude-code|codex|cursor|copilot|all) - Optional - Show skills for specific tool only
- **--help** - Optional - Show this message and exit.
```

--------------------------------

### List installed skills

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_skills

Displays all locally installed skills, optionally filtered by target tool.

```console
$ qbraid skills installed [OPTIONS]
```

--------------------------------

### Quick start qBraid environment commands

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_envs

Common commands for managing local and cloud-based Python environments.

```bash
qbraid envs create             # Create new environment
qbraid envs available          # Browse installable environments
qbraid envs install <slug>     # Install from cloud
qbraid envs list               # List local environments
qbraid envs upload <name>      # Upload to cloud
```

--------------------------------

### Windows PATH Warning Example

Source: https://docs.qbraid.com/v2/cli

Example of a path configuration warning encountered on Windows systems.

```text
WARNING: The script qbraid.exe is installed in 'C:\Users\<YourUsername>\AppData\Local\Packages\PythonSoftwareFoundation.Python.<version>\LocalCache\local-packages\Python<version>\Scripts' which is not on PATH.
```

--------------------------------

### List available qBraid environments

Source: https://docs.qbraid.com/v2/cli/user-guide/environments

Display all configured qBraid environments and their corresponding file paths.

```bash
$ qbraid envs list
# qbraid environments:
#

default                        /opt/.qbraid/environments/qbraid_000000
qsharp                         /opt/.qbraid/environments/qsharp_b54crn
qbraid_sdk                     /home/jovyan/.qbraid/environments/qbraid_sdk_9j9sjy
qiskit                         /home/jovyan/.qbraid/environments/qiskit_9y9siy
```

--------------------------------

### qbraid agents hooks install

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_agents

Installs agent lifecycle hooks for specific AI coding tools.

```APIDOC
## qbraid agents hooks install

### Description
Installs agent lifecycle hooks for AI coding tools.

### Usage
`qbraid agents hooks install [OPTIONS]`

### Options
- **-t, --tool** (str) - Optional - Install hooks for a specific tool (claude, codeq, codex)
- **--help** - Optional - Show help message
```

--------------------------------

### Install a qBraid skill

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_skills

Installs a skill for supported AI coding tools, defaulting to Claude Code.

```console
$ qbraid skills install [OPTIONS] {slug}
```

--------------------------------

### qbraid compute ssh setup usage

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_compute

Syntax for configuring SSH access to a server.

```console
$ qbraid compute ssh setup [OPTIONS]
```

--------------------------------

### Manage Job Groups Quick Start

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_jobs

Common commands for creating and managing job groups.

```bash
qbraid jobs groups create -n my-batch
qbraid jobs groups list
qbraid jobs groups info <qrn>
qbraid jobs groups jobs <qrn>
qbraid jobs groups close <qrn>     # no more submissions, jobs run
qbraid jobs groups cancel <qrn>    # cancel group + non-terminal jobs
qbraid jobs groups delete <qrn>    # remove the record
```

--------------------------------

### Create a qBraid environment

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_envs

Initiates the creation of a new environment, either through an interactive walkthrough or by specifying flags.

```console
$ qbraid envs create [OPTIONS]
```

--------------------------------

### qbraid_core.setup_default_session

Source: https://docs.qbraid.com/v2/core/api-reference/qbraid-core

Sets up a default session for the qBraid environment.

```APIDOC
## setup_default_session(**kwargs)

### Description
Sets up a default session, passing through any parameters to the session constructor.

### Parameters
- **kwargs** (dict) - Optional - Parameters passed directly to the session constructor.
```

--------------------------------

### Query Available Simulators

Source: https://docs.qbraid.com/v2/ai/user-guide/agent-mode

Use this prompt to identify available quantum simulators suitable for testing specific circuit sizes.

```text
What simulators are currently available on qBraid?
I want something fast for testing a 2-qubit circuit.
```

--------------------------------

### Configure qBraid credentials via file

Source: https://docs.qbraid.com/v2/core

Define the API key and URL in the local configuration file located at ~/.qbraid/qbraidrc.

```ini
[default]
api-key = YOUR_KEY
url = https://api-v2.qbraid.com/api/v1
```

--------------------------------

### OpenAPI Specification for Get Jobs

Source: https://docs.qbraid.com/v2/api-reference/rest/get-quantum-jobs-list

The OpenAPI definition for the GET /jobs endpoint, detailing parameters and response schemas.

```yaml
openapi: 3.1.0
info:
  title: qBraid Runtime API
  description: FastAPI backend powering qBraid's quantum runtime microservice.
  version: '2'
servers:
  - url: https://api-v2.qbraid.com/api/v1
    description: Live Server
security:
  - ApiKeyAuth: []
paths:
  /jobs:
    get:
      tags:
        - jobs
      summary: Get All Jobs
      description: >-
        Retrieve a paginated list of quantum jobs for the authenticated user.


        **Query Parameters:**

        - **vendor** (string, optional): Filter by vendor (e.g., `aws`, `ibm`,
        `qbraid`, or `all`)

        - **provider** (string, optional): Filter by provider name

        - **statusGroup** (string, optional): Filter by status group —
        `pending`, `returned`, or `all`

        - **status** (string, optional): Filter by individual job status (takes
        priority over `statusGroup`)

        - **search** (string, optional): Search jobs by keyword (1–255
        characters)

        - **tags** (string, optional): Filter by tags as a JSON object (e.g.,
        `{"env":"prod"}`)

        - **page** (integer, optional): Page number (default: 1)

        - **limit** (integer, optional): Items per page, max 100 (default: 50)


        **Returns:**

        - Paginated array of RuntimeJob objects with pagination metadata


        **Raises:**

        - **401**: Authentication required

        - **422**: Validation error if query parameters are invalid
      operationId: list_jobs_jobs_get
      parameters:
        - name: vendor
          in: query
          required: false
          schema:
            type: string
            enum:
              - aws
              - azure
              - ibm
              - ionq
              - qbraid
              - all
            description: Filter jobs by vendor
            title: Vendor
          description: Filter jobs by vendor
        - name: provider
          in: query
          required: false
          schema:
            type: string
            description: Filter jobs by provider name
            title: Provider
          description: Filter jobs by provider name
        - name: statusGroup
          in: query
          required: false
          schema:
            type: string
            enum:
              - all
              - pending
              - returned
            description: Filter by status group
            title: Status Group
          description: >-
            Filter by status group — `pending` (active/in-progress), `returned`
            (completed/failed/cancelled), or `all`
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - INITIALIZING
              - QUEUED
              - VALIDATING
              - RUNNING
              - CANCELLING
              - CANCELLED
              - COMPLETED
              - FAILED
              - UNKNOWN
              - HOLD
            description: Filter by individual job status
            title: Status
          description: >-
            Filter by individual job status. Takes priority over `statusGroup`
            when both are provided
        - name: search
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: Search keyword
            title: Search
          description: Search jobs by keyword (1–255 characters)
        - name: tags
          in: query
          required: false
          schema:
            type: string
            description: JSON object of tag key-value pairs to filter by
            title: Tags
            example: '{"experiment":"bell-state"}'
          description: >-
            Filter by tags as a JSON object (e.g.,
            `{"experiment":"bell-state"}`)
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            description: Page number (1-indexed)
            title: Page
          description: 'Page number (1-indexed, default: 1)'
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
            description: Number of items per page
            title: Limit
          description: 'Number of items per page (1–100, default: 50)'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJobsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: Authentication required
```

--------------------------------

### OpenAPI Specification for Get Job

Source: https://docs.qbraid.com/v2/api-reference/rest/get-quantum-jobs

Defines the GET endpoint for retrieving job details and the associated response schemas.

```yaml
openapi: 3.1.0
info:
  title: qBraid Runtime API
  description: FastAPI backend powering qBraid's quantum runtime microservice.
  version: '2'
servers:
  - url: https://api-v2.qbraid.com/api/v1
    description: Live Server
security:
  - ApiKeyAuth: []
paths:
  /jobs/{job_qrn}:
    get:
      tags:
        - jobs
      summary: Get Job
      description: |-
        Retrieve a quantum job by its job QRN.

        **Args:**
        - **job_qrn** (string): Job QRN (qBraid Resource Name)

        **Returns:**
        - RuntimeJob object containing the job details

        **Raises:**
        - **403**: You do not have permission to access this job
        - **404**: Job is not found
        - **422**: Validation error if the job_qrn parameter is invalid
      operationId: get_job_jobs__job_qrn__get
      parameters:
        - name: job_qrn
          in: path
          required: true
          schema:
            type: string
            description: Job QRN (qBraid Resource Name)
            title: Job Qrn
          description: Job QRN (qBraid Resource Name)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetJobResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: You do not have permission to access this job
        '404':
          description: Job Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: Job not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    GetJobResponse:
      properties:
        success:
          type: boolean
          title: Success
        data:
          $ref: '#/components/schemas/RuntimeJob'
      type: object
      required:
        - success
        - data
      title: GetJobResponse
      description: Response schema for retrieving a single job
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RuntimeJob:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Job name
        shots:
          type: integer
          exclusiveMinimum: 0
          title: Shots
          description: Number of shots to execute
        deviceQrn:
          type: string
          title: Deviceqrn
          description: qBraid device resource name
        tags:
          additionalProperties:
            anyOf:
              - type: string
              - type: integer
              - type: boolean
          type: object
          title: Tags
          description: Job tags
        runtimeOptions:
          additionalProperties: true
          type: object
          title: Runtimeoptions
          description: Runtime options
        jobQrn:
          type: string
          title: Jobqrn
          description: qBraid job resource name
        batchJobQrn:
          anyOf:
            - type: string
            - type: 'null'
          title: Batchjobqrn
          description: Batch job resource name
        vendor:
          type: string
          enum:
            - aws
            - azure
            - ibm
            - ionq
            - qbraid
          title: Vendor
          description: Vendor name
        provider:
          type: string
          enum:
            - aqt
            - aws
            - azure
            - equal1
            - ibm
            - iqm
            - ionq
            - nec
            - oqc
            - pasqal
            - quantinuum
            - quera
            - rigetti
            - qbraid
          title: Provider
          description: Provider name
        status:
          type: string
          description: Job status
        statusMsg:
          anyOf:
            - type: string
            - type: 'null'
          title: Statusmsg
          description: Job status message
        experimentType:
          type: string
          description: Experiment type
        queuePosition:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Queueposition
          description: Job queue position
        timeStamps:
          anyOf:
            - $ref: '#/components/schemas/TimeStamps'
```

--------------------------------

### QbraidDevice.run(programs, shots)

Source: https://docs.qbraid.com/v2/sdk

Submits quantum programs to a device for execution.

```APIDOC
## QbraidDevice.run(programs, shots)

### Description
Submits a list of quantum programs (e.g., Qiskit, Braket, Cirq circuits or QASM strings) to the device.

### Parameters
- **programs** (list) - Required - A list of quantum programs to execute.
- **shots** (int) - Optional - The number of shots to perform for the experiment.

### Returns
- **jobs** (list) - A list of `QuantumJob` objects.
```

--------------------------------

### Install agent lifecycle hooks

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_agents

Installs hooks for specific AI coding tools like claude, codeq, or codex.

```console
$ qbraid agents hooks install [OPTIONS]
```

--------------------------------

### Delete Multiple Jobs Response Example

Source: https://docs.qbraid.com/v2/api-reference/rest/delete-quantum-jobs

Example JSON response body returned after a successful request to delete multiple jobs.

```json
{
    "success": true,
    "data": {
      "successfulIds": ["qbraid:job:abc123xyz", "qbraid:job:def456uvw"],
      "failedIds": {
        "qbraid:job:invalid123": "Job not found"
      }
    }
  }
```

--------------------------------

### Submit quantum jobs via CLI

Source: https://docs.qbraid.com/v2/cli/api-reference/qbraid_jobs

Examples of submitting quantum programs using file paths or stdin, specifying devices, formats, and output options.

```bash
qbraid jobs submit circuit.qasm -d qbraid:qbraid:sim:qir-sv --shots 100

cat circuit.qasm | qbraid jobs submit - -d qbraid:qbraid:sim:qir-sv -f qasm2

qbraid jobs submit program.ll -d qbraid:qbraid:sim:qir-sv --json
```
Tokens:
Raw