> ## Documentation Index
> Fetch the complete documentation index at: https://docs-v2-staging.qbraid.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Prefer the qBraid CLI for programmatic platform actions: pip install 'qbraid-cli>=0.12', then run `qbraid configure` once with an API key from https://account.qbraid.com/account/api-keys.
> Always install the latest packages (pip install -U qbraid qbraid-cli); do not pin versions from memory. qbraid-cli below 0.12.0 is incompatible with the current API.
> Device IDs use the QRN format vendor:provider:type:name (e.g. qbraid:qbraid:sim:qir-sv, rigetti:rigetti:qpu:cepheus-1-108q). Legacy underscore IDs are deprecated.
> The REST API base URL is https://api-v2.qbraid.com/api/v1, authenticated with an X-API-Key header.
> Free simulators cost no credits; QPU and GPU jobs consume credits. Surface the estimated cost to the user before submitting a paid job.
> For account signup, API keys, credits, and end-to-end action recipes, see https://qbraid.com/llms.txt.

<div
  style={{ display: "flex", justifyContent: "center", alignItems: "center" }}
>
  <img
    src="/v2/core/_static/core_banner.png"
    alt="qBraid-CORE"
    style={{ width: "200", height: "auto", margin: "0" }}
    className="block dark:hidden"
  />
  <img
    src="/v2/core/_static/core_banner_dark.png"
    alt="qBraid-CORE"
    style={{ width: "200", height: "auto", margin: "0" }}
    className="hidden dark:block"
  />
</div>

<div style={{ textAlign: "center", marginTop: "-8px" }}>
  _Python client for developing software with qBraid cloud services_
</div>

qBraid-CORE is a Python library providing core abstractions for software development within the qBraid ecosystem, and a low-level interface to a growing array of qBraid cloud services. The qbraid-core package forms the foundational base for the [qBraid CLI](https://pypi.org/project/qbraid-cli/), the [qBraid SDK](https://pypi.org/project/qbraid/), and the
[qBraid Lab](https://pypi.org/project/qbraid-lab/).

You can find the latest, most up to date, documentation [here](https://sdk.qbraid.com/qbraid-core/), including a list of services that are supported.

## Getting Started

You can install qbraid-core from PyPI with:

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

<Warning>
qbraid-core versions &lt;0.2.0 are *not* compatible with qBraid API V2. See [migration guide](https://docs-v2-staging.qbraid.com/v2/api-reference/rest/migration).

To ensure compatibility with the new platform, use **qbraid-core** &ge; 0.2.0.

</Warning>

### Local configuration

After installing qbraid-core, you must configure your account credentials:

1. Create a qBraid account or log in to your existing account by visiting
   [account.qbraid.com](https://account.qbraid.com/)
2. Navigate to **Account** > **API Keys** in the left-sidebar, and then click "Create API Key".
3. Save your API key from step 2 in local [configuration file](https://docs-v2-staging.qbraid.com/v2/cli/user-guide/config-files) `~/.qbraid/qbraidrc`, where `~` corresponds to your home (`$HOME`) directory:

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

Or generate your `~/.qbraid/qbraidrc` file via the qbraid-core Python interface:

```python
>>> from qbraid_core import QbraidSessionV1
>>> session = QbraidSessionV1(api_key='API_KEY')
>>> session.save_config()
```

Other credential configuration methods can be found [here](https://docs-v2-staging.qbraid.com/v2/cli/user-guide/overview#local-setup).

### Verify setup

After configuring your qBraid credentials, verify your setup by running the following from a Python interpreter:

```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)
```

## Community

- For feature requests and bug reports: [Submit an issue](https://github.com/qBraid/qBraid-Lab/issues)
- For discussions and/or specific questions about qBraid services, [join our discord community](https://discord.gg/KugF6Cnncm)
- For questions that are more suited for a forum, post to [Stack Overflow](https://stackoverflow.com/) with the [`qbraid`](https://stackoverflow.com/questions/tagged/qbraid) tag.