qbraid_core.services.runtime.QuantumRuntimeClient

class qbraid_core.services.runtime.QuantumRuntimeClient(api_key=None, session=None)

Client for interacting with the qBraid Runtime API.

__init__(api_key=None, session=None)

Methods

__init__([api_key, session])
cancel_group(group_qrn)	Cancel a group and all its non-terminal jobs.
cancel_job(job_qrn)	Cancels a specific quantum job.
close_group(group_qrn)	Close a group (no new jobs accepted, existing jobs continue).
create_group([name, tags, metadata, max_ttl])	Create a new group job session.
create_job(request)	Submits a new quantum job.
delete_job(job_qrn)	Deletes a specific quantum job.
delete_jobs(job_qrns)	Deletes multiple quantum jobs.
get_credits_balance()	Get the current user's credit balance for their organization.
get_device(device_qrn)	Returns the metadata for a specific quantum device.
get_group(group_qrn)	Retrieve group details by QRN.
get_job(job_qrn)	Returns the metadata for a specific quantum job.
get_job_program(job_qrn)	Returns the program data for a specific quantum job.
get_job_result(job_qrn)	Returns the results for a specific quantum job.
get_job_statuses()	Returns job status options and available filters.
list_devices()	Returns a list of all quantum devices.
list_groups([status, page, limit])	List group jobs for the current user.
list_jobs([vendor, provider, status, ...])	Returns a list of quantum jobs matching the given filters.
running_in_lab()	Check if running in the qBraid Lab environment.
user_credits_value()	Get the current user's qBraid credits value.

Attributes

session

The QbraidSessionV1 used to make requests.