Skip to content

Prerequisites#

Before using the QCentroid SDK, make sure the required platform setup is already in place.

1. Have a QCentroid account#

You need a valid QCentroid API key to authenticate with the API.

In practice, this means you need:

  • a QCentroid user account
  • your API key

Without a QCentroid account, the SDK cannot log in or access any platform resources.

2. Have at least one use case created in QCentroid#

The SDK runs jobs against an existing QCentroid use case.

That means the use case must already exist in the platform before you can launch jobs from Python.

Examples:

  • list available use cases with the SDK
  • select the correct use_case_name
  • inspect the use case schema before preparing input data
  • run a job against that existing use case

3. Have at least one solver created for that use case#

The SDK does not create solvers in the current initial version.

To run a job, the target use case must already have at least one solver available in QCentroid. Your script will reference that solver by name when launching the job.

In other words:

  • create and configure the solver in the QCentroid platform first
  • confirm that the solver name is available for the target use case
  • then call the SDK to execute jobs with that solver

Use names, not numeric ids#

When interacting with QCentroid from the SDK, users should rely on the URN-style name identifiers.

Examples:

  • use job.name
  • use solver.name
  • use use_case.name

Numeric internal ids may exist in API responses, but they are not intended to be used in normal SDK workflows.

Typical setup order#

The usual workflow is:

  1. Create your QCentroid account or get access from your organization.
  2. Create a use case in the QCentroid platform.
  3. Create or configure a solver for that use case.
  4. Use the SDK to upload datasets, launch jobs, and inspect results.

Scope of the SDK#

The SDK is mainly intended for operational workflows such as:

  • listing resources
  • uploading datasets
  • running jobs
  • checking job status

Use case and solver creation are usually performed in the QCentroid platform, not through the SDK.