# qBraid ## Docs - [API Keys](https://docs.qbraid.com/v2/account/api-keys.md): Create, view, rotate, and revoke API keys for programmatic access to qBraid. - [Partner Guide](https://docs.qbraid.com/v2/account/explore.md): How to add your solution to the qBraid Explore page. - [Creating an Organization](https://docs.qbraid.com/v2/account/organizations/creating-an-organization.md): Request a new qBraid organization for your team, lab, or company. - [Credit Requests](https://docs.qbraid.com/v2/account/organizations/credit-requests.md): Ask an admin for credits when you can't buy them directly from your org. - [Credits](https://docs.qbraid.com/v2/account/organizations/credits.md): Buy credits for the org, transfer them to members one by one or in bulk, and approve member requests. - [Members & Invites](https://docs.qbraid.com/v2/account/organizations/members.md): Invite teammates, send them credits with the invite, change roles, and remove people. - [Overview](https://docs.qbraid.com/v2/account/organizations/overview.md): Use quantum systems within your team, lab, or company with shared resources and centralized billing. - [Seats](https://docs.qbraid.com/v2/account/organizations/seats.md): Assign your subscription's seats to specific members and revoke them when people move on. - [Settings](https://docs.qbraid.com/v2/account/organizations/settings.md): Set your org's name and logo, control what happens when new members join, and find owner-only actions. - [Team Subscriptions](https://docs.qbraid.com/v2/account/organizations/subscriptions.md): Buy a team plan, change tier or interval, add capacity, and handle cancellations. - [Transactions](https://docs.qbraid.com/v2/account/organizations/transactions.md): Audit every credit movement in your organization, page through the history, and report issues on individual entries. - [Account Overview](https://docs.qbraid.com/v2/account/overview.md): Your qBraid account at a glance: where to find profile, API keys, usage, billing, and organization settings. - [Profile](https://docs.qbraid.com/v2/account/profile.md): Edit your name, photo, notification preferences; manage your organizations; or request to delete your account. - [Usage](https://docs.qbraid.com/v2/account/usage.md): Track your compute hours, storage, AI chat quota, and credit consumption. - [Buy Credits](https://docs.qbraid.com/v2/account/wallet/buy-credits.md): Top up your credit balance with a preset or custom amount, and apply a promo code at checkout. - [Overview](https://docs.qbraid.com/v2/account/wallet/overview.md): What you see when you open your wallet: balance, usage stats, and where to go next. - [Payment History](https://docs.qbraid.com/v2/account/wallet/payment-history.md): See every transaction on your account, filter by type or category, search, and export to CSV. - [Personal Subscriptions](https://docs.qbraid.com/v2/account/wallet/subscriptions.md): Pick a plan for your own account, manage it through Stripe, or cancel anytime. - [Agent Mode](https://docs.qbraid.com/v2/ai/user-guide/agent-mode.md): Execute quantum computing workflows through natural language - [AI Chat](https://docs.qbraid.com/v2/ai/user-guide/ai-chat.md): Your intelligent assistant for all things qBraid and quantum computing - [Overview](https://docs.qbraid.com/v2/ai/user-guide/overview.md) - [Usage Quotas](https://docs.qbraid.com/v2/ai/user-guide/usage-quotas.md): Understanding AI usage limits and credit consumption on qBraid - [qbraid-algorithms](https://docs.qbraid.com/v2/algorithms/api-reference/qbraid-algorithms.md) - [CLI](https://docs.qbraid.com/v2/algorithms/user-guide/cli.md) - [Usage Examples](https://docs.qbraid.com/v2/algorithms/user-guide/examples.md) - [Overview](https://docs.qbraid.com/v2/algorithms/user-guide/overview.md) - [Cancel Job](https://docs.qbraid.com/v2/api-reference/rest/cancel-quantum-job.md): Cancel a quantum job. - [Delete Job](https://docs.qbraid.com/v2/api-reference/rest/delete-quantum-job.md): Delete a quantum job by its job QRN. - [Delete Multiple Jobs](https://docs.qbraid.com/v2/api-reference/rest/delete-quantum-jobs.md): Delete multiple quantum jobs by their job QRNs. - [Get Device](https://docs.qbraid.com/v2/api-reference/rest/get-device.md): Retrieve a device by its device QRN. - [Get Job Program](https://docs.qbraid.com/v2/api-reference/rest/get-job-program.md): Retrieve the quantum program data for a job. - [Get All Devices](https://docs.qbraid.com/v2/api-reference/rest/get-quantum-devices.md): Retrieve a list of quantum devices available to the authenticated user. - [Get Job](https://docs.qbraid.com/v2/api-reference/rest/get-quantum-jobs.md): Retrieve a quantum job by its job QRN. - [Get All Jobs](https://docs.qbraid.com/v2/api-reference/rest/get-quantum-jobs-list.md): Retrieve a paginated list of quantum jobs for the authenticated user. - [Get Job Result](https://docs.qbraid.com/v2/api-reference/rest/get-quantum-jobs-result.md): Retrieve the result data for a quantum job. - [Migrating from V1](https://docs.qbraid.com/v2/api-reference/rest/migration.md) - [Create Job](https://docs.qbraid.com/v2/api-reference/rest/post-quantum-jobs.md): Submit a quantum job to the specified device. - [Overview](https://docs.qbraid.com/v2/api-reference/user-guide/overview.md): Learn to work with qBraid APIs - [qbraid](https://docs.qbraid.com/v2/cli/api-reference/qbraid.md): The qBraid CLI — A unified interface for AI agents, quantum computing, Python environments, and cloud compute. - [qbraid account](https://docs.qbraid.com/v2/cli/api-reference/qbraid_account.md): Manage qBraid account. - [qbraid admin](https://docs.qbraid.com/v2/cli/api-reference/qbraid_admin.md): CI/CD commands for qBraid maintainers. - [qbraid agents](https://docs.qbraid.com/v2/cli/api-reference/qbraid_agents.md): Manage AI coding agent sessions. - [qbraid compute](https://docs.qbraid.com/v2/cli/api-reference/qbraid_compute.md): Manage cloud compute and SSH. - [qbraid configure](https://docs.qbraid.com/v2/cli/api-reference/qbraid_configure.md): Configure CLI settings. - [qbraid devices](https://docs.qbraid.com/v2/cli/api-reference/qbraid_devices.md): Browse quantum devices. - [qbraid envs](https://docs.qbraid.com/v2/cli/api-reference/qbraid_envs.md): Manage Python environments. - [qbraid jobs](https://docs.qbraid.com/v2/cli/api-reference/qbraid_jobs.md): Submit and track quantum computing jobs. - [qbraid kernels](https://docs.qbraid.com/v2/cli/api-reference/qbraid_kernels.md): Add, remove, and repair Jupyter kernels. - [qbraid lab](https://docs.qbraid.com/v2/cli/api-reference/qbraid_lab.md): Launch qBraid Lab (JupyterLab). - [qbraid pip](https://docs.qbraid.com/v2/cli/api-reference/qbraid_pip.md): Run pip command in active qBraid environment. - [qbraid projects](https://docs.qbraid.com/v2/cli/api-reference/qbraid_projects.md): Browse and install qBraid Hub projects. - [qbraid skills](https://docs.qbraid.com/v2/cli/api-reference/qbraid_skills.md): Create, install, and share AI coding skills. - [qbraid troubleshoot](https://docs.qbraid.com/v2/cli/api-reference/qbraid_troubleshoot.md): Diagnose qBraid platform issues. - [Configuration Files](https://docs.qbraid.com/v2/cli/user-guide/config-files.md): Manage your qBraid account credentials and settings - [Environments](https://docs.qbraid.com/v2/cli/user-guide/environments.md) - [Magic Commands](https://docs.qbraid.com/v2/cli/user-guide/magic-commands.md) - [Overview](https://docs.qbraid.com/v2/cli/user-guide/overview.md) - [qbraid-core](https://docs.qbraid.com/v2/core/api-reference/qbraid-core.md) - [qbraid-core-js](https://docs.qbraid.com/v2/core/api-reference/qbraid-core-js.md) - [Overview](https://docs.qbraid.com/v2/core/user-guide/overview.md) - [FAQ](https://docs.qbraid.com/v2/home/faq.md): Frequently asked questions about the V2 platform. - [qBraid Docs](https://docs.qbraid.com/v2/home/introduction.md): Developer documentation and resources to fuel your quantum journey. - [Legacy Jobs Retrieval](https://docs.qbraid.com/v2/home/legacy-jobs.md) - [Migration Guide](https://docs.qbraid.com/v2/home/migration.md) - [On-Demand Pricing](https://docs.qbraid.com/v2/home/pricing.md) - [lab.qbraid.com](https://docs.qbraid.com/v2/lab/launch.md) - [Environment Manager](https://docs.qbraid.com/v2/lab/user-guide/environments.md): Install, create, share, and manage Python virtual environments for quantum computing. - [Files](https://docs.qbraid.com/v2/lab/user-guide/files.md): Working with files and directories in qBraid Lab. - [Getting Started](https://docs.qbraid.com/v2/lab/user-guide/getting-started.md): This section will walk you through the basics of using the Lab interface and managing your server instance. - [GPUs](https://docs.qbraid.com/v2/lab/user-guide/gpus.md) - [Usage Guidelines](https://docs.qbraid.com/v2/lab/user-guide/guidelines.md): Instructions to help you navigate, manage, and customize your lab environment effectively. - [Kernels](https://docs.qbraid.com/v2/lab/user-guide/kernels.md) - [Notebooks](https://docs.qbraid.com/v2/lab/user-guide/notebooks.md) - [On-Demand Instances](https://docs.qbraid.com/v2/lab/user-guide/on-demand-instances.md): Launch, manage, and understand the lifecycle of on-demand GPU and CPU instances on qBraid Lab. - [Overview](https://docs.qbraid.com/v2/lab/user-guide/overview.md) - [Quantum Devices](https://docs.qbraid.com/v2/lab/user-guide/quantum-devices.md): Monitor availability, status, and specifications of quantum devices and simulators. - [Quantum Jobs](https://docs.qbraid.com/v2/lab/user-guide/quantum-jobs.md): Submit, monitor, cancel, and delete quantum jobs across multiple providers. - [Settings](https://docs.qbraid.com/v2/lab/user-guide/settings.md): Monitor usage, configure session behavior, and manage notifications from the qBraid Lab Settings extension. - [Troubleshooting](https://docs.qbraid.com/v2/lab/user-guide/troubleshooting.md) - [Usage Limits](https://docs.qbraid.com/v2/lab/user-guide/usage-limits.md): Understanding compute hours, disk usage, and AI chat limits on qBraid Lab - [pyqasm](https://docs.qbraid.com/v2/pyqasm/api-reference/pyqasm.md) - [Advanced Features](https://docs.qbraid.com/v2/pyqasm/user-guide/advanced-features.md) - [Circuit Drawer](https://docs.qbraid.com/v2/pyqasm/user-guide/circuit-drawer.md) - [PyQASM CLI](https://docs.qbraid.com/v2/pyqasm/user-guide/cli.md) - [Usage Examples](https://docs.qbraid.com/v2/pyqasm/user-guide/examples.md) - [OpenPulse](https://docs.qbraid.com/v2/pyqasm/user-guide/openpulse.md): A low-level pulse programming extension of OpenQASM 3, giving developers direct control over the physical signals that manipulate qubits. - [Overview](https://docs.qbraid.com/v2/pyqasm/user-guide/overview.md) - [qbraid-qir](https://docs.qbraid.com/v2/qir/api-reference/qbraid-qir.md) - [Cirq conversions](https://docs.qbraid.com/v2/qir/user-guide/cirq-qir.md) - [Overview](https://docs.qbraid.com/v2/qir/user-guide/overview.md) - [QIR Profiles](https://docs.qbraid.com/v2/qir/user-guide/profiles.md) - [OpenQASM 3 conversions](https://docs.qbraid.com/v2/qir/user-guide/qasm3-qir.md) - [Squin conversions](https://docs.qbraid.com/v2/qir/user-guide/qir-squin.md) - [Qiskit conversions](https://docs.qbraid.com/v2/qir/user-guide/qiskit-qir.md) - [qbraid](https://docs.qbraid.com/v2/sdk/api-reference/qbraid.md) - [Interface](https://docs.qbraid.com/v2/sdk/user-guide/interface.md): Generate random circuits, unitary matrices, and test circuit equivalence. - [Overview](https://docs.qbraid.com/v2/sdk/user-guide/overview.md) - [Programs](https://docs.qbraid.com/v2/sdk/user-guide/programs.md): Extract and manage metadata from supported quantum program types, with the flexibility to introduce new types. - [BraketProvider](https://docs.qbraid.com/v2/sdk/user-guide/providers/aws.md): Runtime integration for streamlined access to Amazon Braket supported devices. - [AzureQuantumProvider](https://docs.qbraid.com/v2/sdk/user-guide/providers/azure.md): Runtime integration for streamlined access to Azure Quantum supported devices. - [QiskitRuntimeProvider](https://docs.qbraid.com/v2/sdk/user-guide/providers/ibm.md): Runtime integration for streamlined access to IBM Quantum hardware. - [IonQProvider](https://docs.qbraid.com/v2/sdk/user-guide/providers/ionq.md): Runtime integration for streamlined access to IonQ simulators and QPUs. - [QbraidProvider](https://docs.qbraid.com/v2/sdk/user-guide/providers/native.md): Runtime integration for streamlined access to quantum devices supported by qBraid. - [Job Execution](https://docs.qbraid.com/v2/sdk/user-guide/providers/native/jobs.md): Submit single quantum jobs, batch multiple circuits to one device, or group jobs across providers. - [OQCProvider](https://docs.qbraid.com/v2/sdk/user-guide/providers/oqc.md): Runtime integration for streamlined access to OQC simulators and QPUs. - [OriginProvider](https://docs.qbraid.com/v2/sdk/user-guide/providers/origin.md): Runtime integration for access to OriginQ quantum simulators and processors via QCloud. - [QuantinuumProvider](https://docs.qbraid.com/v2/sdk/user-guide/providers/quantinuum.md): Runtime integration for access to Quantinuum trapped-ion quantum processors via Quantinuum Nexus. - [RigettiProvider](https://docs.qbraid.com/v2/sdk/user-guide/providers/rigetti.md): Runtime integration for direct access to Rigetti quantum processors via QCS. - [Runtime Components](https://docs.qbraid.com/v2/sdk/user-guide/runtime/components.md): Universal building blocks for constructing client-side quantum software pipelines. - [Writing a New Provider](https://docs.qbraid.com/v2/sdk/user-guide/runtime/new-provider.md): A step-by-step guide to implementing a new provider class. - [Runtime Options](https://docs.qbraid.com/v2/sdk/user-guide/runtime/options.md): Settings applied at the device level that control the behavior of a device.run call - [Transforms](https://docs.qbraid.com/v2/sdk/user-guide/transforms.md): Adapt quantum programs to specific hardware requirements. - [Transpiler](https://docs.qbraid.com/v2/sdk/user-guide/transpiler.md): Graph-based approach to quantum program type conversions. - [Visualization](https://docs.qbraid.com/v2/sdk/user-guide/visualization.md): Draw circuit diagrams and plot experimental results, conversion graphs, and more. - [qBraid VS Code](https://docs.qbraid.com/v2/vscode/user-guide/code-editor.md): Directly connect to an online VS Code environment with pre-installed quantum extensions. - [Environment Manager](https://docs.qbraid.com/v2/vscode/user-guide/environment-manager.md): Manage your quantum environments directly within Visual Studio Code. - [Overview](https://docs.qbraid.com/v2/vscode/user-guide/overview.md): Get an overview of the qBraid VS Code extension pack and our custom VS Code deployment. - [Quantum Console](https://docs.qbraid.com/v2/vscode/user-guide/quantum-console.md): Manage qBraid jobs and devices directly within Visual Studio Code. ## OpenAPI Specs - [openapi-v2](https://docs.qbraid.com/openapi-v2.json) - [package](https://docs.qbraid.com/package.json) - [package-lock](https://docs.qbraid.com/package-lock.json) - [cspell](https://docs.qbraid.com/cspell.json) ## Optional - [Contact](https://www.qbraid.com/contact) - [Community](https://discord.com/invite/9jpmpeEV65) - [Example Notebooks](https://github.com/qBraid/qbraid-lab-demo)