References Overview

Kipu Quantum Hub ships three SDKs and one CLI. Each one targets a different job. This page helps you pick the right one in under a minute.

Which tool should I use?

I want to…	Use this	Package
Run a Qiskit or Braket circuit on a quantum backend	Quantum SDK	qhub-quantum (Python)
Use IBM Qiskit Runtime sessions/primitives	Quantum SDK — HubQiskitRuntimeService	qhub-quantum (Python)
Call a Managed Service I deployed (submit jobs, get results, stream logs)	Service SDK	qhub-service (Python, TypeScript)
Manage data pools or upload/download files via the platform API	API SDK	qhub-api (Python, TypeScript)
Log in, bootstrap a project, run it locally, or deploy it to the Hub	CLI	@quantum-hub/qhubctl (Node.js)
Configure a service project (name, resources, runtime)	qhub.json	file in project root
Style descriptions in the platform UI with Markdown or LaTeX	Markdown & LaTeX	—

At a glance

Quantum SDK — qhub-quantum

Run Qiskit 2.2 or Amazon Braket circuits on any supported backend. Provides drop-in replacements for Qiskit/Braket providers:

• HubQiskitProvider — gate-based backends (IonQ, IQM, Rigetti, simulators)
• HubQiskitRuntimeService — IBM backends with sessions, Sampler/Estimator
• HubBraketProvider — AWS-accessed devices (including QuEra Aquila for AHS)
• Works with PennyLane via the pennylane-qiskit plugin

→ Open reference

Service SDK — qhub-service

Talk to Managed Services you (or others) have deployed on the Hub. Start executions, pass data + params, poll status, retrieve result files, tail logs, use Data Pools as input.

• Available for Python and TypeScript
• Authenticates with service-scoped credentials (access key + secret), not a personal token

→ Open reference

API SDK — qhub-api

Client for platform resources — primarily data pools and their files. Use it to wire dataset management into your own scripts or apps.

• Available for Python and TypeScript
• Authenticates with a personal access token (optionally scoped to an organization)

→ Open reference

CLI — qhubctl

Terminal tool for project lifecycle on the Hub. Log in, bootstrap a new service, run it locally, deploy it, upload files to a data pool, inspect build status.

• Installed via npm i -g @quantum-hub/qhubctl
• Used by the other SDKs for auth: qhubctl login -t <token> makes subsequent SDK calls token-free

→ Open reference

Install cheat-sheet

# Quantum SDK (Qiskit / Braket)
pip install --upgrade qhub-quantum

# Service SDK
uv add qhub-service          # or: pip install qhub-service

# API SDK
uv add qhub-api              # or: pip install --upgrade qhub-api

# CLI
npm i -g @quantum-hub/qhubctl
qhubctl login -t <your-access-token>

Authentication at a glance

Tool	Credential	How to supply it
Quantum SDK	Personal access token	qhubctl login or access_token=... argument
API SDK	Personal access token	KQH_PERSONAL_ACCESS_TOKEN env var (Python) or constructor arg
Service SDK	Service-scoped access key + secret	Env vars (ACCESS_KEY_ID, SECRET_ACCESS_KEY, SERVICE_ENDPOINT) or constructor args
CLI	Personal access token	qhubctl login -t <token>

Generate personal access tokens on the Access Tokens page. Service credentials are generated per-service in Service Settings.

What's next?

• New here? Start with the Quickstart.
• Deploying your own service? Read Implementations → Create a Service.
• Looking for a specific backend? See Available Backends.