> ## Documentation Index
> Fetch the complete documentation index at: https://docs.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.
> When writing Python, prefer the qBraid SDK: `from qbraid.runtime import QbraidProvider` wraps devices, job submission (`device.run()`), and batch groups (`GroupJobSession`).
> 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.
> For endpoints without a dedicated wrapper, use `QbraidSessionV1` from `qbraid_core` — an authenticated session (`.get()`/`.post()`) that sets the X-API-Key header. Full spec: https://docs.qbraid.com/openapi-v2.json
> 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.

# qbraid artifacts

> Publish and share standalone HTML.

Lists show only your artifacts.

**Usage**:

```console
$ qbraid artifacts [OPTIONS] COMMAND [ARGS]...
```

**Options**:

- `--help`: Show this message and exit.

**Commands**:

- `publish`: Publish one standalone HTML file.
- `list`: List your published HTML artifacts.
- `get`: Show one artifact you can view.
- `update`: Update HTML, title, or access.
- `share`: Grant a qBraid user viewing access.
- `revoke`: Remove a collaborator viewing grant.
- `unpublish`: Make an artifact owner-only.
- `delete`: Delete an artifact and its HTML.

## qbraid artifacts publish

Publish one standalone HTML file.

Publishing is immediate; there is no review queue. Publishing the same file
with the same title and access returns the existing artifact.

**Usage**:

```console
$ qbraid artifacts publish [OPTIONS] {file}
```

**Arguments**:

- `file`: [required]

**Options**:

- `--title <str>`
- `--visibility <private|shared|public>`: [default: private]
- `--json`
- `--new`: Publish a copy even if this file is already published.
- `--help`: Show this message and exit.

## qbraid artifacts list

List your published HTML artifacts.

This never lists a public or global catalog.

**Usage**:

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

**Options**:

- `--page <int range>`: [default: 1; x&gt;=1]
- `--limit <int range>`: [default: 50; 1&lt;=x&lt;=100]
- `--json`
- `--help`: Show this message and exit.

## qbraid artifacts get

Show one artifact you can view.

**Usage**:

```console
$ qbraid artifacts get [OPTIONS] {ID}
```

**Arguments**:

- `ID`: Artifact ID from 'qbraid artifacts list'. [required]

**Options**:

- `--json`
- `--help`: Show this message and exit.

## qbraid artifacts update

Update HTML, title, or access.

The share link is preserved.

**Usage**:

```console
$ qbraid artifacts update [OPTIONS] {ID}
```

**Arguments**:

- `ID`: Artifact ID from 'qbraid artifacts list'. [required]

**Options**:

- `--file <file>`
- `--title <str>`
- `--visibility <private|shared|public>`
- `--json`
- `--help`: Show this message and exit.

## qbraid artifacts share

Grant a qBraid user viewing access.

The recipient must sign in. Send them the link after granting access.

**Usage**:

```console
$ qbraid artifacts share [OPTIONS] {ID}
```

**Arguments**:

- `ID`: Artifact ID from 'qbraid artifacts list'. [required]

**Options**:

- `--email <str>`: [required]
- `--json`
- `--help`: Show this message and exit.

## qbraid artifacts revoke

Remove a collaborator viewing grant.

Public artifacts remain accessible via their link.

**Usage**:

```console
$ qbraid artifacts revoke [OPTIONS] {ID}
```

**Arguments**:

- `ID`: Artifact ID from 'qbraid artifacts list'. [required]

**Options**:

- `--email <str>`: [required]
- `--json`
- `--help`: Show this message and exit.

## qbraid artifacts unpublish

Make an artifact owner-only.

Disables both public and shared viewing.

**Usage**:

```console
$ qbraid artifacts unpublish [OPTIONS] {ID}
```

**Arguments**:

- `ID`: Artifact ID from 'qbraid artifacts list'. [required]

**Options**:

- `--json`
- `--help`: Show this message and exit.

## qbraid artifacts delete

Delete an artifact and its HTML.

Use --yes in non-interactive scripts; --json requires --yes.

**Usage**:

```console
$ qbraid artifacts delete [OPTIONS] {ID}
```

**Arguments**:

- `ID`: Artifact ID from 'qbraid artifacts list'. [required]

**Options**:

- `--yes`
- `--json`
- `--help`: Show this message and exit.
