Module @qbraid-core/ibm-cloud

qbraid

@qbraid-core/ibm-cloud

Stable npm

Client for interacting with IBM's Qiskit Runtime Service via the IBM Cloud API.

npm install @qbraid-core/ibm-cloud
import { IBMCloudClient} from '@qbraid-core/ibm-cloud';

const apiKey = 'my-api-key';
const serviceCRN = 'my-service-crn';

const client = new IBMCloudClient(apiKey: apiKey, serviceCRN: serviceCRN);

// Get a Job
const jobID = 'my-ibm-job-id';
const jobResponse = await client.getJob(jobID);
console.log("Job details: ", jobResponse);

// Get all devices
const backends = await client.getBackends();
console.log("Available backends: ", backends);

// Get a backend status
const backendName = 'ibm_marrakesh';
const backendStatus = await client.getBackendStatus(backendName);
console.log("Backend status: ", backendStatus);

This software is proprietary and subject to the terms of the qBraid Commercial Software License.

Classes

IBMCloudClient
IBMConfigManager

Interfaces

APIErrorResponse
DeviceConfiguration
DeviceErrors
DeviceProperties
DeviceStatus
Job
JobList
JobMetrics