qBraid Cloud Client Libraries for JavaScript

Idiomatic client libraries for developing JavaScript applications that interact with qBraid Cloud Services:

Library	Release Level	Version
Base
AI Chat
Quantum Devices
Quantum Jobs
Compute Manager
File Storage

If the service is not listed above but has public endpoints documented in the qBraid Cloud APIs, you can use @qbraid-core/base to interact with the service through a generic REST interface. For example:

const { QbraidClient } = require('@qbraid-core/base');

const client = new QbraidClient();

const response = await client.session.request('GET', '/example/endpoint');
Copy

Authentication

Login or create an account at account.qbraid.com, and copy your API Key from the Plan info card on the left side of your account page.

Store your API Key in the QBRAID_API_KEY environment variable, or use the qBraid CLI to save your API Key in a local configuration file.

See qBraid Account - API Keys for more information.

Versioning

Our libraries follow Semantic Versioning.

Please note it is currently under active development. Any release versioned 0.x.y is subject to backwards-incompatible changes at any time.

Launch Stages

Stable: Libraries defined at the Stable quality level are stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against Stable libraries are addressed with the highest priority.

Preview: Libraries defined at the preview quality level are still a work-in-progress and are more likely to get backwards-incompatible updates.

Deprecated: Libraries defined at the deprecated quality level are no longer supported, may contain bugs, and may be removed without warning.

License

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