Skip to content

QCentroid SDK for Python#

qcentroid-sdk is the official Python SDK for interacting with the QCentroid API.

It is designed to make the most common user workflows simple:

  • authenticate with QCentroid
  • list use cases, solvers, and jobs
  • upload datasets
  • launch jobs with inline data or an existing dataset

What this SDK covers today#

The current SDK includes:

  • login with an API key
  • list use cases
  • get a use case schema by name
  • list solvers
  • list solvers for a use case name
  • list jobs
  • get a job by name
  • wait for job completion
  • retrieve job input, output, and execution logs
  • upload a dataset
  • run a job

Install#

pip install qcentroid-sdk

Quick example#

from qcentroid_sdk import QCentroidClient

client = QCentroidClient(
    api_key="your-api-key",
)

jobs = client.jobs.list(limit=10)

for job in jobs.value:
    print(job.name, job.status)

You can also configure credentials with environment variables:

export QCENTROID_API_KEY="your-api-key"

Documentation pages#