Appearance

HubPlatformClient ​

Part of the Kipu Quantum Hub API SDK reference - see the landing page for installation and Python credential helpers.

HubPlatformClient covers the catalog surface: services, applications, organizations, data pools, subscriptions, marketplace listings, billing, and more. The constructor has the same shape as HubQuantumClient, including the organization_id / organizationId option.

Authentication ​

HubPlatformClient authenticates with a personal access token sent as the X-Auth-Token request header. The same Python credential helpers documented under Python credential helpers work here - pass the resolved token via api_key.

Organization scoping ​

Most Platform endpoints accept an X-OrganizationId header to scope the request to a specific organization. HubPlatformClient exposes a dedicated organization_id / organizationId constructor option that sends the header on every request; in TypeScript, individual sub-client methods also accept a per-request override. Leave it unset to operate in your personal account. Resolve the id with the Python helpers in Python context resolution, or read KQH_ORGANIZATION_ID yourself in TypeScript.

Quickstart ​

python
from qhub.api.platform import HubPlatformClient

platform = HubPlatformClient(
    api_key="YOUR_PERSONAL_ACCESS_TOKEN",
    organization_id="YOUR_ORGANIZATION_ID",
)

services = platform.services.get_services(page=0, size=20)
for service in services.content or []:
    print(service.id, service.display_name)

Constructor ​

ParameterRequiredDescription
api_key / apiKeyyesPersonal access token; sent as X-Auth-Token.
base_url / baseUrlnoOverrides both the default environment and environment if supplied.
environmentnoHubPlatformClientEnvironment.DEFAULT (Python) / HubPlatformEnvironment.Default (TypeScript).
organization_id / organizationIdnoValue for the X-OrganizationId header; sent on every request from this client.
headersnoAdditional headers merged into every request.
timeout / timeoutInSecondsnoRead timeout in seconds; defaults to 60 when no custom HTTP client is supplied.
max_retries / maxRetriesnoNumber of retries for transient failures; defaults to 2.
follow_redirectsno (Python only)Passed through to httpx.Client; defaults to True.
httpx_client / fetchnoInject a preconfigured HTTP client (Python) or fetch implementation (TypeScript).
loggingnoLogger instance or {level, logger, silent} config dict.

Python also ships AsyncHubPlatformClient with the same shape plus an httpx.AsyncClient hook.

Namespaces ​

HubPlatformClient exposes the following sub-clients, lazily instantiated on first access.

NamespacePurpose
algorithmsAlgorithms in the catalog and their sketches, relations, and access permissions.
announcementsPlatform-wide announcements to display, newest first.
applicationsApplications (projects that consume services).
authenticationAccess tokens and keys (API tokens, APIM / gateway credentials).
billingBalances, budgets, credits, billing history, revenue, cost reports.
data_poolsData pools (shared datasets) and their files.
data_pool_grantsGrants that let services read from a data pool.
data_pool_sharesVisibility grants of data pools to users or organizations.
entitlementsEntitlement and job-eligibility checks for the current tenant.
external_servicesExternally-hosted services registered in the catalog.
git_integrationsGit provider integrations used by services.
implementationsImplementations attached to algorithms.
managed_servicesManaged services (Hub-hosted) including builds and source upload.
marketplaceMarketplace listings for algorithms, services, implementations, use cases.
organizationsOrganizations you belong to, members, provider tokens.
productsActive platform offerings and their metered prices (public, no authentication).
quantum_workloadsCross-organization view of quantum workload costs (reporting surface).
service_executionsService execution records, inputs, outputs, logs, metrics, cancellation.
service_jobsService jobs (the subset of execution records that are long-running jobs).
service_sharesVisibility grants of services to users or organizations.
servicesServices in the catalog (the published, versioned artefacts).
subscriptionsSubscriptions (for services that require opt-in).
use_casesUse cases exposed in the catalog / marketplace.
user_notificationsPer-user notifications.
usersInvitations, accounts, and per-user provider tokens.
workflow_servicesWorkflow services (multi-step managed services).
workflow_user_tasksUser tasks raised by workflow services, and their responses.

User-profile data (name, email, profile image, personal access tokens) now lives on HubUserClient - see HubUserClient.

Endpoints ​

Default base URLOverride
https://api.hub.kipu-quantum.com/qc-catalogbase_url=... / baseUrl: ..., or environment=HubPlatformClientEnvironment.DEFAULT (Python) / environment: HubPlatformEnvironment.Default (TypeScript).

Errors ​

All Python errors extend ApiError (in qhub.api.platform.core.api_error); all TypeScript errors extend HubPlatformError.

StatusPython classTypeScript classMeaning
400BadRequestErrorBadRequestErrorMalformed request.
401UnauthorizedErrorUnauthorizedErrorMissing or invalid credentials.
403ForbiddenErrorForbiddenErrorAuthenticated but not permitted.
404NotFoundErrorNotFoundErrorResource does not exist.
409ConflictErrorConflictErrorConflict with current state, e.g. publication races.
413ContentTooLargeErrorContentTooLargeErrorUpload exceeds the configured size limit.
415UnsupportedMediaTypeErrorUnsupportedMediaTypeErrorWrong Content-Type on the request body.
422UnprocessableEntityErrorUnprocessableEntityErrorValidation failure on the request body.
500InternalServerErrorInternalServerErrorServer-side failure.

Other failure modes:

  • Auth misconfiguration (TypeScript) - constructing HubPlatformClient without apiKey throws HubPlatformError with message "Please provide 'apiKey' when initializing the client".
  • Timeouts - hitting timeoutInSeconds raises HubPlatformTimeoutError in TypeScript; in Python, timeouts surface as the underlying httpx.TimeoutException.

All HTTP error instances expose status_code, headers, and body (Python) / statusCode, rawResponse, and body (TypeScript).

Reference ​

Field casing ​

Platform-API DTOs use snake_case in Python (created_at, display_name) and camelCase in TypeScript (createdAt, displayName).

Pagination wrappers ​

Identical to the Quantum API - {content, page, size, total_elements, total_pages}, zero-based page.

Python reference ​

Workflow Services ​

client.workflow_services.get_workflow_model(...)

Description ​

Get the current workflow model of a workflow service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.workflow_services.get_workflow_model(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.workflow_services.update_workflow_model(...)

Description ​

Update the workflow model of an existing workflow service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.workflow_services.update_workflow_model(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

workflow_model: typing.Optional[str] — The BPMN workflow model definition as an XML string.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.workflow_services.create_workflow_service(...) -> ServiceDto

Description ​

Create a new workflow service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.workflow_services.create_workflow_service(
    name="my-quantum-service",
)

Parameters ​

name: str — The unique name of the service. Used as an identifier in URLs and API calls.

summary: typing.Optional[str] — A short summary of the service.

description: typing.Optional[str] — A detailed description of what the service does and how to use it.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.workflow_services.add_workflow_service_pricing_plan(...) -> PricingPlanDto

Description ​

Add a pricing plan to the workflow service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.workflow_services.add_workflow_service_pricing_plan(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.workflow_services.deploy_workflow_model(...)

Description ​

Deploy a workflow service model to the platform's workflow engine.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.workflow_services.deploy_workflow_model(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Use Cases ​

client.use_cases.get_use_case(...) -> UseCaseDto

Description ​

Get a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_use_case(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.update_use_case(...) -> UseCaseDto

Description ​

Update an existing use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.update_use_case(
    id="id",
    title="Quantum Portfolio Optimization",
)

Parameters ​

id: str — The unique ID of a use case.

title: str — The title of the use case.

short_description: typing.Optional[str] — A short summary of the use case.

description: typing.Optional[str] — A detailed description of the use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.delete_use_case(...)

Description ​

Delete a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.delete_use_case(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.set_use_case_visibility(...)

Description ​

Set the visibility of a use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.set_use_case_visibility(
    id="id",
    type="PRIVATE",
)

Parameters ​

id: str — The unique ID of a use case.

request: UpdateVisibilityRequest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.get_use_case_sketch(...) -> UseCaseSketchDto

Description ​

Get a specific sketch of a use case (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_use_case_sketch(
    id="id",
    sketch_id="sketchId",
)

Parameters ​

id: str — The unique ID of a use case.

sketch_id: str — The unique ID of a use case sketch.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.update_use_case_sketch(...) -> UseCaseSketchDto

Description ​

Update a specific sketch of a use case (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.update_use_case_sketch(
    id="id",
    sketch_id="sketchId",
)

Parameters ​

id: str — The unique ID of a use case.

sketch_id: str — The unique ID of a use case sketch.

description: typing.Optional[str] — The new description for the sketch.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.delete_use_case_sketch(...)

Description ​

Delete a specific sketch of a use case (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.delete_use_case_sketch(
    id="id",
    sketch_id="sketchId",
)

Parameters ​

id: str — The unique ID of a use case.

sketch_id: str — The unique ID of a use case sketch.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.get_use_case_sketch_image(...) -> typing.Iterator[bytes]

Description ​

Get the image of a specific sketch of a use case (both identified by their IDs). Returns binary image content (not JSON).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_use_case_sketch_image(
    id="id",
    sketch_id="sketchId",
)

Parameters ​

id: str — The unique ID of a use case.

sketch_id: str — The unique ID of a use case sketch.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.upload_use_case_sketch_image(...)

Description ​

Upload the image for a specific sketch of a use case (both identified by their IDs). Accepts binary file upload (multipart/form-data).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.upload_use_case_sketch_image(
    id="id",
    sketch_id="sketchId",
    file="example_file",
)

Parameters ​

id: str — The unique ID of a use case.

sketch_id: str — The unique ID of a use case sketch.

file: core.File — The image file to upload.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.update_use_case_demo_integration(...) -> DemoWithStatus

Description ​

Swap the git integration used by the demo of a specific use case (identified by its ID). The new integration must have access to the demo's existing repository; repository and branch stay unchanged. No build is triggered.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.update_use_case_demo_integration(
    id="id",
    git_integration_id="550e8400-e29b-41d4-a716-446655440000",
)

Parameters ​

id: str — The unique ID of a use case.

git_integration_id: str — ID of the git integration to use from now on (GitHub installation or GitLab access token)

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.update_use_case_demo_environment(...) -> DemoWithStatus

Description ​

Replace the environment variables of the demo for a specific use case (identified by its ID). The provided map fully replaces the existing environment. Keys are uppercased and whitespace is replaced with underscores; entries with blank values are removed.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.update_use_case_demo_environment(
    id="id",
    environment={
        "key": "value"
    },
)

Parameters ​

id: str — The unique ID of a use case.

environment: typing.Dict[str, str] — Environment variables for the demo. The provided map fully replaces the existing environment. Keys are uppercased and whitespace is replaced with underscores; entries with blank keys/values are removed.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.get_use_case_author(...) -> UseCaseAuthorDto

Description ​

Get a specific author of a use case (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_use_case_author(
    id="id",
    author_id="authorId",
)

Parameters ​

id: str — The unique ID of a use case.

author_id: str — The unique ID of a use case author.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.update_use_case_author(...) -> UseCaseAuthorDto

Description ​

Update a specific author of a use case (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.update_use_case_author(
    id="id",
    author_id="authorId",
    name="Jane Doe",
)

Parameters ​

id: str — The unique ID of a use case.

author_id: str — The unique ID of a use case author.

name: str — The name of the author.

url: typing.Optional[str] — A URL linking to the author's profile or website.

main_author: typing.Optional[bool] — Whether this is the main/primary author of the use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.delete_use_case_author(...)

Description ​

Delete a specific author of a use case (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.delete_use_case_author(
    id="id",
    author_id="authorId",
)

Parameters ​

id: str — The unique ID of a use case.

author_id: str — The unique ID of a use case author.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.get_use_cases(...) -> PageResponseUseCaseOverviewDto

Description ​

Get a page of use cases. The access filter selects which bucket is returned.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_use_cases()

Parameters ​

access: typing.Optional[GetUseCasesRequestAccess] — Which bucket of results to return. GRANTED (default) returns the results the caller holds an access permission for, INTERNAL returns the results with INTERNAL visibility regardless of the caller, PUBLIC returns the results with PUBLIC visibility regardless of the caller, ALL returns the union of all three.

q: typing.Optional[str] — Free-text search. Matches a case-insensitive fragment of the title, short description or description. Omitted or blank returns the unfiltered list.

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.create_use_case(...) -> UseCaseDto

Description ​

Create a new use case in the current user's account or the specified organization. Use cases describe real-world quantum computing applications and can link to algorithms, services, and demos. The caller becomes the owner of the created use case.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.create_use_case(
    title="Quantum Portfolio Optimization",
)

Parameters ​

title: str — The title of the use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.create_use_case_sketch(...) -> UseCaseSketchDto

Description ​

Create a new sketch for a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.create_use_case_sketch(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

description: typing.Optional[str]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.link_service_to_use_case(...)

Description ​

Link a service to a specific use case (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.link_service_to_use_case(
    id="id",
    service_definition_id="serviceDefinitionId",
)

Parameters ​

id: str — The unique ID of a use case.

service_definition_id: str — The unique ID of a service definition.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.unlink_service_from_use_case(...)

Description ​

Unlink a service from a specific use case (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.unlink_service_from_use_case(
    id="id",
    service_definition_id="serviceDefinitionId",
)

Parameters ​

id: str — The unique ID of a use case.

service_definition_id: str — The unique ID of a service definition.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.get_use_case_logo(...) -> typing.Iterator[bytes]

Description ​

Get the logo of a specific use case (identified by its ID). Returns binary image content (not JSON).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_use_case_logo(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.upload_use_case_logo(...)

Description ​

Upload the logo for a specific use case (identified by its ID). Accepts binary file upload (multipart/form-data).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.upload_use_case_logo(
    id="id",
    file="example_file",
)

Parameters ​

id: str — The unique ID of a use case.

file: core.File — The logo image file to upload.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.get_use_case_demo(...) -> DemoWithStatus

Description ​

Get the demo with current build status for a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_use_case_demo(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.create_use_case_demo(...) -> DemoWithStatus

Description ​

Create a demo for a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.create_use_case_demo(
    id="id",
    use_case_id="550e8400-e29b-41d4-a716-446655440000",
    git_integration_id="550e8400-e29b-41d4-a716-446655440000",
    repository_type="GITHUB",
    repository_url="https://github.com/myorg/my-demo-app",
)

Parameters ​

id: str — The unique ID of a use case.

use_case_id: str — ID of the use case this demo belongs to

git_integration_id: str — ID of the git integration to use (GitHub installation or GitLab access token)

repository_type: CreateDemoRequestRepositoryType — Type of git integration

repository_url: str — Full repository name in owner/repo format

branch: typing.Optional[str] — Branch to build from (defaults to repository default branch)

environment: typing.Optional[typing.Dict[str, str]] — Environment variables for the demo

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.delete_use_case_demo(...)

Description ​

Delete the demo of a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.delete_use_case_demo(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.trigger_use_case_demo_build(...)

Description ​

Trigger a build for the demo of a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.trigger_use_case_demo_build(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.get_use_case_authors(...) -> typing.List[UseCaseAuthorDto]

Description ​

Get all authors of a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_use_case_authors(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.create_use_case_author(...) -> UseCaseAuthorDto

Description ​

Create a new author for a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.create_use_case_author(
    id="id",
    name="Jane Doe",
)

Parameters ​

id: str — The unique ID of a use case.

name: str — The name of the author.

url: typing.Optional[str] — A URL linking to the author's profile or website.

main_author: typing.Optional[bool] — Whether this is the main/primary author of the use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.get_use_case_author_image(...) -> typing.Iterator[bytes]

Description ​

Get the image of a specific author of a use case (both identified by their IDs). Returns binary image content (not JSON).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_use_case_author_image(
    id="id",
    author_id="authorId",
)

Parameters ​

id: str — The unique ID of a use case.

author_id: str — The unique ID of a use case author.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.upload_use_case_author_image(...)

Description ​

Upload the image for a specific author of a use case (both identified by their IDs). Accepts binary file upload (multipart/form-data).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.upload_use_case_author_image(
    id="id",
    author_id="authorId",
    file="example_file",
)

Parameters ​

id: str — The unique ID of a use case.

author_id: str — The unique ID of a use case author.

file: core.File — The author profile image file to upload.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.delete_use_case_author_image(...)

Description ​

Delete the image of a specific author of a use case (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.delete_use_case_author_image(
    id="id",
    author_id="authorId",
)

Parameters ​

id: str — The unique ID of a use case.

author_id: str — The unique ID of a use case author.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.link_algorithm_to_use_case(...)

Description ​

Link an algorithm to a specific use case (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.link_algorithm_to_use_case(
    id="id",
    algorithm_id="algorithmId",
)

Parameters ​

id: str — The unique ID of a use case.

algorithm_id: str — The unique ID of an algorithm.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.unlink_algorithm_from_use_case(...)

Description ​

Unlink an algorithm from a specific use case (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.unlink_algorithm_from_use_case(
    id="id",
    algorithm_id="algorithmId",
)

Parameters ​

id: str — The unique ID of a use case.

algorithm_id: str — The unique ID of an algorithm.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.get_use_case_access_permissions(...) -> typing.List[AccessPermissionDto]

Description ​

Get all access permissions for a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_use_case_access_permissions(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.add_use_case_access_permission(...)

Description ​

Add an access permission to a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.add_use_case_access_permission(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request: AccessPermissionDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.get_linked_services_by_use_case(...) -> typing.List[ServiceDto]

Description ​

Get all services linked to a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_linked_services_by_use_case(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.get_use_case_demo_runtime_logs(...) -> typing.List[LogEntry]

Description ​

Get the runtime logs for the demo of a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_use_case_demo_runtime_logs(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.get_use_case_demo_build_logs(...) -> typing.List[LogEntry]

Description ​

Get the build logs for the demo of a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_use_case_demo_build_logs(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.get_linked_algorithms_by_use_case(...) -> typing.List[AlgorithmDto]

Description ​

Get all algorithms linked to a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.get_linked_algorithms_by_use_case(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.use_cases.remove_use_case_access_permission(...)

Description ​

Remove an access permission from a specific use case (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.use_cases.remove_use_case_access_permission(
    id="id",
    sid="sid",
)

Parameters ​

id: str — The unique ID of a use case.

sid: str — The security identifier (user SID or organization SID) of the permission holder to remove.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Services ​

client.services.update_service_summary(...)

Description ​

Update the summary of a service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.update_service_summary(
    id="id",
    summary="summary",
)

Parameters ​

id: str — The unique ID of a service.

summary: str — The new summary for the service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.update_service_publication(...)

Description ​

Publish a service. scope=PUBLIC publishes to the marketplace; scope=INTERNAL publishes within the organization only. Idempotent: calling twice with the same scope has no effect.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.update_service_publication(
    id="id",
    scope="PUBLIC",
)

Parameters ​

id: str — The unique ID of a service.

scope: PublicationRequestScope — The scope of the publication, determining who can discover the service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.delete_service_publication(...)

Description ​

Unpublishes the service (lifecycle → CREATED). Idempotent. Fails with 409 if the service has active subscriptions or use-case relations unless force=true.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.delete_service_publication(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

force: typing.Optional[bool] — If true, cancels active subscriptions and unlinks use-case relations before unpublishing.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.get_service_open_api(...) -> str

Description ​

Get the OpenAPI specification of a service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.get_service_open_api(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

format: typing.Optional[GetServiceOpenApiRequestFormat] — Output format: JSON or YAML. Default: JSON.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.update_service_open_api(...)

Description ​

Update the OpenAPI specification of a service (multipart/form-data). Accepts binary file upload (multipart/form-data).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.update_service_open_api(
    id="id",
    file="example_file",
)

Parameters ​

id: str — The unique ID of a service.

file: core.File — The OpenAPI specification file (YAML or JSON) to upload.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.update_service_links(...)

Description ​

Replace the links of a service. Pass an empty array to clear links.

Usage ​

python
from qhub.api.platform import HubPlatformClient, ServiceLink
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.update_service_links(
    id="id",
    request=[
        ServiceLink(
            type="TERMS_OF_SERVICE",
            name="API Documentation",
            url="https://docs.example.com",
        )
    ],
)

Parameters ​

id: str — The unique ID of a service.

request: typing.List[ServiceLink]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.update_service_display_name(...)

Description ​

Update the display name of a service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.update_service_display_name(
    id="id",
    display_name="displayName",
)

Parameters ​

id: str — The unique ID of a service.

display_name: str — The new display name for the service. Must not exceed 70 characters.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.update_service_description(...)

Description ​

Update the description of a service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.update_service_description(
    id="id",
    description="description",
)

Parameters ​

id: str — The unique ID of a service.

description: str — The new description for the service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.update_service_contacts(...)

Description ​

Replace the contact list of a service. Pass an empty array to clear contacts.

Usage ​

python
from qhub.api.platform import HubPlatformClient, ServiceContact
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.update_service_contacts(
    id="id",
    request=[
        ServiceContact(
            type="EMAIL",
            contact="support@example.com",
        )
    ],
)

Parameters ​

id: str — The unique ID of a service.

request: typing.List[ServiceContact]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.get_services(...) -> typing.List[ServiceOverviewDto]

Description ​

Get a list of all services, optionally filtered by lifecycle.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.get_services()

Parameters ​

lifecycle: typing.Optional[typing.Union[GetServicesRequestLifecycleItem, typing.Sequence[GetServicesRequestLifecycleItem]]] — Filter by one or more lifecycle stages (CREATED, INTERNAL, PUBLIC).

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.get_service(...) -> ServiceDto

Description ​

Get a specific service (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.get_service(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.delete_service(...)

Description ​

Delete a service (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.delete_service(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.get_service_subscriptions(...) -> typing.List[SubscriptionDto]

Description ​

Get active subscriptions for a service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.get_service_subscriptions(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.get_service_statistics(...) -> ServiceStatistics

Description ​

Get usage statistics for a specific service, including star count, subscription count, and execution statistics (total, this month, last month, last three months).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.get_service_statistics(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.services.check_service_name_availability(...) -> bool

Description ​

Check whether a service name is available (not yet taken).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.services.check_service_name_availability(
    name="name",
)

Parameters ​

name: str — The service name to check for availability.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Service Shares ​

client.service_shares.update_service_share_role(...) -> ShareDto

Description ​

Update the role of an existing service share.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_shares.update_service_share_role(
    id="id",
    share_id="shareId",
)

Parameters ​

id: str — The unique ID of a service.

share_id: str — The unique ID of a resource share.

request: UpdateResourceShareRoleDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_shares.delete_service_share(...)

Description ​

Revoke a share that was previously granted on a service. This removes the shared access for the target tenant. Requires GRANT permission on the service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_shares.delete_service_share(
    id="id",
    share_id="shareId",
)

Parameters ​

id: str — The unique ID of a service.

share_id: str — The unique ID of a resource share.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_shares.update_service_share_constraint(...) -> TimeBasedConstraintDto

Description ​

Update an existing constraint on a service share.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_shares.update_service_share_constraint(
    id="id",
    share_id="shareId",
    constraint_id="constraintId",
    valid_from="validFrom",
    valid_until="validUntil",
    type="TIME_BASED",
)

Parameters ​

id: str — The unique ID of a service.

share_id: str — The unique ID of a resource share.

constraint_id: str — The unique ID of a share constraint.

request: TimeBasedConstraintDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_shares.delete_service_share_constraint(...)

Description ​

Delete an existing constraint on a service share.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_shares.delete_service_share_constraint(
    id="id",
    share_id="shareId",
    constraint_id="constraintId",
)

Parameters ​

id: str — The unique ID of a service.

share_id: str — The unique ID of a resource share.

constraint_id: str — The unique ID of a share constraint.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_shares.get_shares_for_service(...) -> typing.List[ShareDto]

Description ​

List all shares for a given service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_shares.get_shares_for_service(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_shares.share_service(...) -> ShareDto

Description ​

Share a service with other tenants.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_shares.share_service(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request: CreateShareRequestDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_shares.add_service_share_constraint(...) -> TimeBasedConstraintDto

Description ​

Add a new constraint to an existing service share.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_shares.add_service_share_constraint(
    id="id",
    share_id="shareId",
    valid_from="validFrom",
    valid_until="validUntil",
    type="TIME_BASED",
)

Parameters ​

id: str — The unique ID of a service.

share_id: str — The unique ID of a resource share.

request: CreateTimeBasedConstraintDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Service Executions ​

client.service_executions.cancel_service_execution(...)

Description ​

Cancel a specific service execution (identified by its ID). Only service executions that are pending or currently running can be cancelled.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_executions.cancel_service_execution(
    id="id",
)

Parameters ​

id: str — The unique ID of a service execution.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_executions.get_service_execution(...) -> GetServiceExecutionResponse

Description ​

Get a specific service execution (identified by its ID), either a managed or workflow service execution. The response type depends on the underlying service execution type: A workflow service execution returns the type WorkflowServiceExecutionDto and managed service execution returns the type ServiceExecutionDto.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_executions.get_service_execution(
    id="id",
)

Parameters ​

id: str — The unique ID of a service execution.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_executions.head_service_execution(...)

Description ​

Check if the tenant has view permission for a specific service execution (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_executions.head_service_execution(
    id="id",
)

Parameters ​

id: str — The unique ID of a service execution.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_executions.get_service_executions(...) -> PageResponseServiceExecutionDto

Description ​

Get all service executions with pagination support. Optionally filter by applicationId, serviceId, tags, IDs, and creation date range. Supports sorting by: createdAt, startedAt, endedAt, status, serviceId, applicationId. Default sort is createdAt descending (newest first).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_executions.get_service_executions()

Parameters ​

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

created_after: typing.Optional[datetime.datetime] — Filter service executions created after this timestamp (ISO 8601 format, e.g., 2024-01-01T00:00:00Z, or milliseconds since epoch)

created_before: typing.Optional[datetime.datetime] — Filter service executions created before this timestamp (ISO 8601 format, e.g., 2024-01-01T00:00:00Z, or milliseconds since epoch)

application_id: typing.Optional[str] — Filter by a certain application id

service_id: typing.Optional[str] — Filter by a certain service id

tags: typing.Optional[typing.Union[str, typing.Sequence[str]]] — Filter by tags (returns service executions that have ANY of the specified tags)

ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] — Filter by ID pattern (supports wildcards with '', e.g., 'f81d4fae-' or '*-00a0c91e6bf6')

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_executions.get_service_execution_result(...) -> typing.Optional[typing.Dict[str, typing.Any]]

Description ​

Get the results for a specific service execution (identified by its ID). If the service execution has not been completed yet or no results are available, a HTTP 204 (No Content) response is returned with a "Retry-After" header.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_executions.get_service_execution_result(
    id="id",
)

Parameters ​

id: str — The unique ID of a service execution.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_executions.get_service_execution_result_file(...) -> typing.Iterator[bytes]

Description ​

Download a specific result file from a service execution. The file path is specified as a sub-path after /results/, e.g., /service-executions/{id}/results/output.json to download the file output.json from the service output. Returns binary file content (not JSON).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_executions.get_service_execution_result_file(
    id="id",
)

Parameters ​

id: str — The unique ID of a service execution.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_executions.get_service_execution_observability_files(...) -> typing.Optional[typing.Dict[str, typing.Any]]

Description ​

Get the list of observability files for a specific service execution (identified by its ID). Only accessible by service owners and creators with at least VIEWER role on the service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_executions.get_service_execution_observability_files(
    id="id",
)

Parameters ​

id: str — The unique ID of a service execution.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_executions.get_service_execution_observability_file(...) -> typing.Iterator[bytes]

Description ​

Download a specific observability file for a service execution. Only accessible by service owners and creators with at least VIEWER role on the service. Returns binary file content (not JSON).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_executions.get_service_execution_observability_file(
    id="id",
    filename="filename",
)

Parameters ​

id: str — The unique ID of a service execution.

filename: str — The name of the observability file to download (as listed by the observability files endpoint).

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_executions.get_service_execution_metrics(...) -> ServiceExecutionMetrics

Description ​

Get the resource usage metrics for a specific service execution (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_executions.get_service_execution_metrics(
    id="id",
)

Parameters ​

id: str — The unique ID of a service execution.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_executions.get_service_execution_logs(...) -> typing.Optional[ServiceExecutionLogs]

Description ​

Get the logs for a specific service execution (identified by its ID). If the service execution has not started yet or no logs are available, a HTTP 204 (No Content) response is returned with a "Retry-After" header. Use the optional 'limit' query parameter to retrieve only the last X log messages. Use the optional 'raw' parameter to download logs as plain text instead of JSON.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_executions.get_service_execution_logs(
    id="id",
)

Parameters ​

id: str — The unique ID of a service execution.

limit: typing.Optional[int] — Maximum number of log messages to retrieve (returns the last X messages, upper system limit at 100000)

raw: typing.Optional[bool] — Return raw plain text logs instead of JSON (triggers download)

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_executions.get_service_execution_lineage(...) -> ServiceExecutionLineage

Description ​

Get the service execution (identified by its ID) together with all service executions transitively triggered beneath it, as a flat list of lineage nodes ordered by creation time ascending. A caller who can access the given service execution can see its full descendant subtree in full detail, including descendants running under other tenants' applications the caller otherwise has no permission on. The response is capped at a configured maximum number of nodes; when the lineage exceeds that cap, 'truncated' is set to true and only the shallowest (breadth-first) nodes are returned.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_executions.get_service_execution_lineage(
    id="id",
)

Parameters ​

id: str — The unique ID of a service execution.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_executions.get_service_execution_costs(...) -> typing.Optional[typing.List[CostEntry]]

Description ​

Get the costs for a specific service execution (identified by its ID). If the service execution has not started yet or no costs are available, a HTTP 204 (No Content) response is returned with a "Retry-After" header.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_executions.get_service_execution_costs(
    id="id",
)

Parameters ​

id: str — The unique ID of a service execution.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Organizations ​

client.organizations.get_organization(...) -> OrganizationDto

Description ​

Get an organization by its ID.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.get_organization(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.update_organization(...) -> OrganizationDto

Description ​

Update the display name and description of an existing organization. Requires OWNER or MAINTAINER role on the organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.update_organization(
    id="id",
    display_name="Acme Quantum Labs",
)

Parameters ​

id: str — The unique ID of an organization.

display_name: str — The display name of the organization.

description: typing.Optional[str] — A description of the organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.delete_organization(...)

Description ​

Delete an organization by its ID.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.delete_organization(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.get_organization_provider_token(...) -> ProviderToken

Description ​

Get the provider token of a given type for the organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.get_organization_provider_token(
    id="id",
    type="type",
)

Parameters ​

id: str — The unique ID of an organization.

type: str — The quantum provider identifier (e.g., DWAVE, AZURE, AWS, or IBM).

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.update_organization_provider_token(...)

Description ​

Set or update a provider token for the organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.update_organization_provider_token(
    id="id",
    type="type",
    request={
        "key": "value"
    },
)

Parameters ​

id: str — The unique ID of an organization.

type: str — The quantum provider identifier (e.g., DWAVE, AZURE, AWS, or IBM).

request: typing.Dict[str, typing.Any]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.delete_organization_provider_token(...)

Description ​

Delete a provider token for the organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.delete_organization_provider_token(
    id="id",
    type="type",
)

Parameters ​

id: str — The unique ID of an organization.

type: str — The quantum provider identifier (e.g., DWAVE, AZURE, AWS, or IBM).

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.get_organization_member(...) -> MemberDto

Description ​

Get a specific member of an organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.get_organization_member(
    id="id",
    user_id="userId",
)

Parameters ​

id: str — The unique ID of an organization.

user_id: str — The unique ID of a user.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.update_organization_member_permission(...) -> AccessPermissionDto

Description ​

Update the permission role of a member in an organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.update_organization_member_permission(
    id="id",
    user_id="userId",
)

Parameters ​

id: str — The unique ID of an organization.

user_id: str — The unique ID of a user.

request: AccessPermissionDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.delete_organization_member(...)

Description ​

Delete a member from an organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.delete_organization_member(
    id="id",
    user_id="userId",
)

Parameters ​

id: str — The unique ID of an organization.

user_id: str — The unique ID of a user.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.get_organizations() -> typing.List[OrganizationDto]

Description ​

Get all organizations visible to the current user.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.get_organizations()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.create_organization(...) -> OrganizationDto

Description ​

Create a new organization. The calling user becomes the owner of the organization. Organizations allow multiple users to collaborate on shared resources such as services, algorithms, and applications. A billing email is required for invoicing purposes.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.create_organization(
    display_name="Acme Quantum Labs",
    billing_email="billing@acme.com",
)

Parameters ​

display_name: str — The display name of the organization.

billing_email: str — The billing email address for the organization.

description: typing.Optional[str] — A description of the organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.get_organization_members(...) -> typing.List[MemberDto]

Description ​

Get all members of an organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.get_organization_members(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.add_organization_member(...) -> AccessPermissionDto

Description ​

Add a member to an organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.add_organization_member(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request: AccessPermissionDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.get_organization_image(...) -> typing.Iterator[bytes]

Description ​

Get the profile image of an organization. Returns binary image content (not JSON).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.get_organization_image(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.update_organization_image(...)

Description ​

Update the profile image of an organization. Accepts binary file upload (multipart/form-data).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.update_organization_image(
    id="id",
    file="file",
)

Parameters ​

id: str — The unique ID of an organization.

file: str — The organization image file to upload.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.delete_organization_image(...)

Description ​

Remove the profile image of an organization, so that it falls back to its initials. Requires OWNER role on the organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.delete_organization_image(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.get_organization_provider_token_availability(...) -> typing.Dict[str, bool]

Description ​

Check which quantum provider tokens are configured for the organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.get_organization_provider_token_availability(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.get_organization_profile(...) -> OrganizationProfileDto

Description ​

Get the public profile of an organization by its ID. Accessible by any authenticated user.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.get_organization_profile(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.organizations.search_organizations(...) -> typing.List[OrganizationSearchResultDto]

Description ​

Search organizations by name or description. The query parameter 'q' is required, must be at least 3 characters long, contain at least one alphanumeric character, and supports wildcards but not special characters.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.organizations.search_organizations(
    q="q",
)

Parameters ​

q: str — Search query (min 3 chars, at least one alphanumeric character, supports wildcards).

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Billing ​

client.billing.get_organization_allowance_configuration(...) -> typing.Optional[PayAsYouGoAllowanceConfigurationDto]

Description ​

Get the Pay-as-you-go Allowance configuration for an organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_organization_allowance_configuration(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.update_organization_allowance_configuration(...) -> PayAsYouGoAllowanceConfigurationDto

Description ​

Set or update the Pay-as-you-go Allowance configuration for an organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient, Money
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.update_organization_allowance_configuration(
    id="id",
    allowance=Money(
        amount="1.50",
        currency="EUR",
    ),
)

Parameters ​

id: str — The unique ID of an organization.

request: UpdatePayAsYouGoAllowanceRequest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.delete_organization_allowance_configuration(...)

Description ​

Delete the Pay-as-you-go Allowance configuration for an organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.delete_organization_allowance_configuration(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_user_allowance_configuration() -> typing.Optional[PayAsYouGoAllowanceConfigurationDto]

Description ​

Get the current user's Pay-as-you-go Allowance configuration.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_user_allowance_configuration()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.update_user_allowance_configuration(...) -> PayAsYouGoAllowanceConfigurationDto

Description ​

Update the current user's Pay-as-you-go Allowance configuration.

Usage ​

python
from qhub.api.platform import HubPlatformClient, Money
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.update_user_allowance_configuration(
    allowance=Money(
        amount="1.50",
        currency="EUR",
    ),
)

Parameters ​

request: UpdatePayAsYouGoAllowanceRequest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.delete_user_allowance_configuration()

Description ​

Delete the current user's Pay-as-you-go Allowance configuration.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.delete_user_allowance_configuration()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_budget() -> typing.Optional[BudgetDto]

Description ​

Get the windowed budget for the calling tenant.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_budget()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.update_budget(...) -> BudgetDto

Description ​

Set or update the windowed budget for the calling tenant. Organization writes require OWNER.

Usage ​

python
from qhub.api.platform import HubPlatformClient, Money
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.update_budget(
    amount=Money(
        amount="1.50",
        currency="EUR",
    ),
    window_mode="FIXED",
    anchor="anchor",
    enforcement="HARD",
)

Parameters ​

amount: Money — Budget amount enforced over the configured window. Must be non-negative.

window_mode: UpdateBudgetRequestWindowMode — Window shape: FIXED (named or custom-length calendar period) or ROLLING (trailing N days).

anchor: str — Anchor date the window is aligned to.

enforcement: UpdateBudgetRequestEnforcement — HARD blocks new spend once exceeded; SOFT only notifies.

period: typing.Optional[UpdateBudgetRequestPeriod] — Named period for a FIXED window. Required when windowMode is FIXED.

custom_days: typing.Optional[int] — Length in days for a FIXED window with the CUSTOM period.

rolling_days: typing.Optional[int] — Trailing window length in days. Required when windowMode is ROLLING.

warn_threshold_percent: typing.Optional[int] — Percent of the budget at which a warning is raised (1-100). Defaults to 80.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.delete_budget()

Description ​

Delete the windowed budget for the calling tenant. Organization writes require OWNER.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.delete_budget()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.create_account_link(...) -> RevenueAccountLink

Description ​

Create a Stripe Express link for the organization's revenue account, provisioning the account on demand. Requires the caller to be an OWNER of the organization. Returns an onboarding link if account setup is not yet complete, or a dashboard link once the account is active.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.create_account_link(
    id="id",
    refresh_url="https://hub.kipu-quantum.com/settings/billing/revenue/onboarding/refresh",
    return_url="https://hub.kipu-quantum.com/settings/billing/revenue/onboarding/return",
)

Parameters ​

id: str — The unique ID of an organization.

request: CreateRevenueAccountLinkRequest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.create_platform_subscription_checkout(...) -> PlatformSubscriptionCheckoutSessionDto

Description ​

Initiates a Stripe Checkout flow (mode=subscription) for purchasing a Platform Subscription for the organization. Requires the caller to be an OWNER of the organization. The returned checkoutUrl must be opened in the user's browser to complete payment.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.create_platform_subscription_checkout(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request: CreatePlatformSubscriptionRequestDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.create_portal_link(...) -> BillingPortalLink

Description ​

Create a Stripe Billing Portal session for an organization and return its URL.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.create_portal_link(
    id="id",
    return_url="https://hub.kipu-quantum.com/billing/portal/success",
)

Parameters ​

id: str — The unique ID of an organization.

request: CreateBillingPortalSessionRequest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.create_credits_checkout(...) -> CreditTopUpSessionDto

Description ​

Initiates a Stripe Checkout flow for buying prepaid platform credits for the organization. Requires the caller to be an OWNER of the organization. The returned checkoutUrl must be opened in the user's browser to complete payment.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.create_credits_checkout(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request: CreateCreditTopUpRequestDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.create_account_link1(...) -> RevenueAccountLink

Description ​

Create a Stripe Express link for the current user's revenue account, provisioning the account on demand. Returns an onboarding link if account setup is not yet complete, or a dashboard link once the account is active.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.create_account_link1(
    refresh_url="https://hub.kipu-quantum.com/settings/billing/revenue/onboarding/refresh",
    return_url="https://hub.kipu-quantum.com/settings/billing/revenue/onboarding/return",
)

Parameters ​

request: CreateRevenueAccountLinkRequest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.create_platform_subscription_checkout1(...) -> PlatformSubscriptionCheckoutSessionDto

Description ​

Initiates a Stripe Checkout flow (mode=subscription) for purchasing a Platform Subscription for the current user. The returned checkoutUrl must be opened in the user's browser to complete payment.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.create_platform_subscription_checkout1()

Parameters ​

request: CreatePlatformSubscriptionRequestDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.create_portal_link1(...) -> BillingPortalLink

Description ​

Create a Stripe Billing Portal session for the current user and return its URL.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.create_portal_link1(
    return_url="https://hub.kipu-quantum.com/billing/portal/success",
)

Parameters ​

request: CreateBillingPortalSessionRequest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.create_credits_checkout1(...) -> CreditTopUpSessionDto

Description ​

Initiates a Stripe Checkout flow for buying prepaid platform credits for the current user. The returned checkoutUrl must be opened in the user's browser to complete payment.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.create_credits_checkout1()

Parameters ​

request: CreateCreditTopUpRequestDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_organization_revenue(...) -> typing.List[RevenueReportDto]

Description ​

Get the revenue earned by an organization as a service provider, broken down by period at the requested granularity. from and to are ISO-8601 instants; granularity defaults to MONTH.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment
import datetime

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_organization_revenue(
    id="id",
    from_=datetime.datetime.fromisoformat("2024-01-15T09:30:00+00:00"),
    to=datetime.datetime.fromisoformat("2024-01-15T09:30:00+00:00"),
)

Parameters ​

id: str — The unique ID of an organization.

from: datetime.datetime

to: datetime.datetime

granularity: typing.Optional[GetOrganizationRevenueRequestGranularity]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_revenue_account(...) -> RevenueAccountDto

Description ​

Get the revenue account for an organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_revenue_account(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.delete_revenue_account(...)

Description ​

Delete the revenue account for an organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.delete_revenue_account(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_platform_subscription(...) -> typing.Optional[PlatformSubscriptionDto]

Description ​

Get the organization's current Platform Subscription (ACTIVE or CANCEL_PENDING), or 204 when there is none. Requires the caller to be at least a VIEWER of the organization. Price and renewal date are fetched live from Stripe and are null when Stripe is unreachable.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_platform_subscription(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_organization_allowance_usage(...) -> typing.Optional[PayAsYouGoAllowanceUsageDto]

Description ​

Get current Pay-as-you-go Allowance usage for an organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_organization_allowance_usage(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_organization_spending_limit_usage(...) -> SpendingLimitUsage

Description ​

Get spending limit usage for an organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_organization_spending_limit_usage(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_organization_cost_report(...) -> CostReport

Description ​

Get an aggregated cost report for an organization the caller is a member of.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_organization_cost_report(
    id="id",
    from_="from",
    to="to",
)

Parameters ​

id: str — The unique ID of an organization.

from: str

to: str

granularity: typing.Optional[GetOrganizationCostReportRequestGranularity]

group_by: typing.Optional[GetOrganizationCostReportRequestGroupBy]

workload_classes: typing.Optional[typing.Union[GetOrganizationCostReportRequestWorkloadClassesItem, typing.Sequence[GetOrganizationCostReportRequestWorkloadClassesItem]]]

role: typing.Optional[typing.Union[GetOrganizationCostReportRequestRoleItem, typing.Sequence[GetOrganizationCostReportRequestRoleItem]]] — Filter by role. PROVIDER selects rows where the tenant acts as Service Provider (running their own services on platform infrastructure at the platform rate). CONSUMER selects rows where the tenant acts as Service Consumer (paying for another tenant's services at the marked-up rate set by the upstream Pricing Plan). Repeatable; passing both is equivalent to omitting the filter.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_organization_billing_history(...) -> PageResponseBillingHistoryEntryDto

Description ​

Get the unified billing timeline of an organization the caller owns. Same query parameters and defaults as /my/billing-history.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_organization_billing_history(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

from: typing.Optional[datetime.datetime] — Inclusive lower bound on occurredAt. ISO-8601 instant. Defaults to now() - 90 days.

to: typing.Optional[datetime.datetime] — Inclusive upper bound on occurredAt. ISO-8601 instant. Defaults to now().

type: typing.Optional[typing.Union[GetOrganizationBillingHistoryRequestTypeItem, typing.Sequence[GetOrganizationBillingHistoryRequestTypeItem]]] — Filter by billing history entry type. Repeat the parameter to allow multiple types.

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_billing_account(...) -> BillingAccountDto

Description ​

Get the billing account for an organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_billing_account(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_organization_balance(...) -> TenantBalanceDto

Description ​

Get the ledger balance of an organization the caller is a member of.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_organization_balance(
    id="id",
)

Parameters ​

id: str — The unique ID of an organization.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_my_revenue(...) -> typing.List[RevenueReportDto]

Description ​

Get the revenue earned by the current user as a service provider, broken down by period at the requested granularity. from and to are ISO-8601 instants; granularity defaults to MONTH.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment
import datetime

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_my_revenue(
    from_=datetime.datetime.fromisoformat("2024-01-15T09:30:00+00:00"),
    to=datetime.datetime.fromisoformat("2024-01-15T09:30:00+00:00"),
)

Parameters ​

from: datetime.datetime

to: datetime.datetime

granularity: typing.Optional[GetMyRevenueRequestGranularity]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_revenue_account1() -> RevenueAccountDto

Description ​

Get the current user's revenue account.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_revenue_account1()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.delete_revenue_account1()

Description ​

Delete the current user's revenue account.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.delete_revenue_account1()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_platform_subscription1() -> typing.Optional[PlatformSubscriptionDto]

Description ​

Get the current user's current Platform Subscription (ACTIVE or CANCEL_PENDING), or 204 when there is none. Price and renewal date are fetched live from Stripe and are null when Stripe is unreachable.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_platform_subscription1()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_user_allowance_usage() -> typing.Optional[PayAsYouGoAllowanceUsageDto]

Description ​

Get the current user's Pay-as-you-go Allowance usage.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_user_allowance_usage()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_user_spending_limit_usage() -> SpendingLimitUsage

Description ​

Get the current user's spending limit usage.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_user_spending_limit_usage()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_my_cost_report(...) -> CostReport

Description ​

Get an aggregated cost report (total, time-series buckets, optional breakdown).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_my_cost_report(
    from_="from",
    to="to",
)

Parameters ​

from: str

to: str

granularity: typing.Optional[GetMyCostReportRequestGranularity]

group_by: typing.Optional[GetMyCostReportRequestGroupBy]

workload_classes: typing.Optional[typing.Union[GetMyCostReportRequestWorkloadClassesItem, typing.Sequence[GetMyCostReportRequestWorkloadClassesItem]]]

role: typing.Optional[typing.Union[GetMyCostReportRequestRoleItem, typing.Sequence[GetMyCostReportRequestRoleItem]]] — Filter by role. PROVIDER selects rows where the tenant acts as Service Provider (running their own services on platform infrastructure at the platform rate). CONSUMER selects rows where the tenant acts as Service Consumer (paying for another tenant's services at the marked-up rate set by the upstream Pricing Plan). Repeatable; passing both is equivalent to omitting the filter.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_my_billing_history(...) -> PageResponseBillingHistoryEntryDto

Description ​

Get the current user's unified billing timeline (credits, credit/debit adjustments, recorded invoices, daily usage rollups) within the requested period. from and to are ISO-8601 instants and default to the last 90 days. type is optional and may be repeated to filter by multiple entry types. Pagination defaults to 50 items per page sorted by occurredAt descending.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_my_billing_history()

Parameters ​

from: typing.Optional[datetime.datetime] — Inclusive lower bound on occurredAt. ISO-8601 instant. Defaults to now() - 90 days.

to: typing.Optional[datetime.datetime] — Inclusive upper bound on occurredAt. ISO-8601 instant. Defaults to now().

type: typing.Optional[typing.Union[GetMyBillingHistoryRequestTypeItem, typing.Sequence[GetMyBillingHistoryRequestTypeItem]]] — Filter by billing history entry type. Repeat the parameter to allow multiple types.

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_billing_account1() -> BillingAccountDto

Description ​

Get the current user's billing account, creating it if it does not exist.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_billing_account1()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_my_balance() -> TenantBalanceDto

Description ​

Get the current user's ledger balance, derived from credits, credit adjustments, debit adjustments, and recorded invoices.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_my_balance()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.billing.get_budget_usage() -> typing.Optional[BudgetUsage]

Description ​

Get budget usage for the calling tenant's current window.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.billing.get_budget_usage()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Users ​

client.users.get_user_provider_token(...) -> ProviderToken

Description ​

Get the provider token of a given type for the current user.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.users.get_user_provider_token(
    type="type",
)

Parameters ​

type: str — The quantum provider identifier (e.g., DWAVE, AZURE, AWS, or IBM).

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.users.update_user_provider_token(...)

Description ​

Set or update a provider token for the current user.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.users.update_user_provider_token(
    type="type",
    request={
        "key": "value"
    },
)

Parameters ​

type: str — The quantum provider identifier (e.g., DWAVE, AZURE, AWS, or IBM).

request: typing.Dict[str, typing.Any]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.users.delete_user_provider_token(...)

Description ​

Delete a provider token for the current user.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.users.delete_user_provider_token(
    type="type",
)

Parameters ​

type: str — The quantum provider identifier (e.g., DWAVE, AZURE, AWS, or IBM).

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.users.decline_invitation(...)

Description ​

Decline an organization invitation.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.users.decline_invitation(
    invitation_id="invitationId",
)

Parameters ​

invitation_id: str — The unique ID of an invitation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.users.accept_invitation(...)

Description ​

Accept an organization invitation.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.users.accept_invitation(
    invitation_id="invitationId",
)

Parameters ​

invitation_id: str — The unique ID of an invitation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.users.get_user_provider_token_availability() -> typing.Dict[str, bool]

Description ​

Check which quantum provider tokens are configured for the current user.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.users.get_user_provider_token_availability()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.users.get_my_invitations() -> typing.List[InvitationDto]

Description ​

Get all pending organization invitations for the current user.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.users.get_my_invitations()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.users.get_my_accounts() -> typing.List[AccountDto]

Description ​

Get all accounts visible to the current user.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.users.get_my_accounts()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

User Notifications ​

client.user_notifications.mark_notification_as_read(...)

Description ​

Mark a single notification as read for the current user. This is idempotent, marking an already-read notification has no effect.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.user_notifications.mark_notification_as_read(
    notification_id="notificationId",
)

Parameters ​

notification_id: str — The unique ID of a user notification.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.user_notifications.mark_all_notifications_as_read()

Description ​

Mark all notifications as read.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.user_notifications.mark_all_notifications_as_read()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.user_notifications.get_my_notifications(...) -> PageResponseUserNotificationDto

Description ​

Get the current user's notifications.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.user_notifications.get_my_notifications()

Parameters ​

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.user_notifications.get_my_unread_notification_count() -> int

Description ​

Get the current user's unread notification count.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.user_notifications.get_my_unread_notification_count()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Managed Services ​

client.managed_services.download_managed_service_source(...) -> typing.Iterator[bytes]

Description ​

Download the source code of a managed service. Returns binary content (not JSON).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.managed_services.download_managed_service_source(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.managed_services.update_managed_service_source(...)

Description ​

Update the source reference (repository URL or registry image) of a managed service.

Usage ​

python
from qhub.api.platform import HubPlatformClient, ServiceSourceFile
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.managed_services.update_managed_service_source(
    id="id",
    request=ServiceSourceFile(
        type="file",
    ),
)

Parameters ​

id: str — The unique ID of a service.

request: UpdateManagedServiceSourceRequestBody

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.managed_services.upload_managed_service_source(...)

Description ​

Upload and update the source code of a managed service (binary file). Accepts binary file upload (multipart/form-data).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.managed_services.upload_managed_service_source(
    id="id",
    file="example_file",
)

Parameters ​

id: str — The unique ID of a service.

file: core.File — The service source archive file to upload.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.managed_services.update_managed_service_runtime_configuration(...)

Description ​

Update the runtime configuration of a managed service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.managed_services.update_managed_service_runtime_configuration(
    id="id",
    runtime="DOCKER",
)

Parameters ​

id: str — The unique ID of a service.

request: ServiceRuntimeConfiguration

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.managed_services.update_managed_service_resource_configuration(...)

Description ​

Update the resource configuration of a managed service.

Usage ​

python
from qhub.api.platform import HubPlatformClient, ServiceResourceConfigurationCpu
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.managed_services.update_managed_service_resource_configuration(
    id="id",
    request=ServiceResourceConfigurationCpu(
        amount=1000,
        unit="m",
        type="cpu",
    ),
)

Parameters ​

id: str — The unique ID of a service.

request: UpdateManagedServiceResourceConfigurationRequestBody

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.managed_services.add_managed_service_pricing_plan(...) -> PricingPlanDto

Description ​

Add or replace the pricing plan of a managed service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.managed_services.add_managed_service_pricing_plan(
    id="id",
    type="FREE",
)

Parameters ​

id: str — The unique ID of a service.

type: CreateManagedServicePricingPlanRequestType — The type of the pricing plan.

profit_percentage: typing.Optional[float] — The profit markup in percent, e.g., 20 for a 20% profit margin.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.managed_services.delete_managed_service_pricing_plan(...)

Description ​

Delete the pricing plan of a managed service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.managed_services.delete_managed_service_pricing_plan(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.managed_services.build_managed_service(...)

Description ​

Trigger a build for a managed service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.managed_services.build_managed_service(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.managed_services.create_managed_service(...) -> ServiceDto

Description ​

Create a new managed service that is built and hosted on the platform. Requires a source (file upload, container registry, or Git repository) and optionally accepts runtime and resource configurations. The service must be built before it can be published and consumed.

Usage ​

python
from qhub.api.platform import HubPlatformClient, ServiceSourceFile
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.managed_services.create_managed_service(
    name="my-quantum-service",
    source=ServiceSourceFile(
        type="file",
    ),
)

Parameters ​

name: str — The unique name of the service. Used as an identifier in URLs and API calls.

source: CreateManagedServiceRequestSource — The source from which the service is built (file upload, container registry, or Git repository).

summary: typing.Optional[str] — A short summary of the service.

description: typing.Optional[str] — A detailed description of what the service does and how to use it.

runtime_configuration: typing.Optional[ServiceRuntimeConfiguration] — Runtime configuration including the runtime type and environment variables.

resource_configurations: typing.Optional[typing.List[CreateManagedServiceRequestResourceConfigurationsItem]] — Resource configurations for CPU, memory, and GPU limits.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.managed_services.get_managed_service_build_status(...) -> BuildJobDto

Description ​

Get the current build status of a managed service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.managed_services.get_managed_service_build_status(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.managed_services.get_managed_service_build_logs(...) -> typing.List[LogEntry]

Description ​

Get the build logs of a managed service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.managed_services.get_managed_service_build_logs(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Implementations ​

client.implementations.set_implementation_visibility(...)

Description ​

Set the visibility of an implementation (identified by its ID) to PUBLIC or PRIVATE.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.set_implementation_visibility(
    id="id",
    type="PRIVATE",
)

Parameters ​

id: str — The unique ID of an implementation.

request: UpdateVisibilityRequest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.update_implementation_summary(...)

Description ​

Set the summary of an implementation (identified by its ID). Pass null to clear.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.update_implementation_summary(
    id="id",
)

Parameters ​

id: str — The unique ID of an implementation.

summary: typing.Optional[str] — Short description of the implementation. Pass null to clear.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.update_implementation_access_permission(...)

Description ​

Update an access permission for an implementation (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.update_implementation_access_permission(
    id="id",
    member_id="memberId",
    role="VIEWER",
)

Parameters ​

id: str — The unique ID of an implementation.

member_id: str — The ID of the member (user ID) whose role to update.

role: UpdateMemberRequestRole — The role to assign to the member.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.remove_implementation_access_permission(...)

Description ​

Remove an access permission from an implementation (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.remove_implementation_access_permission(
    id="id",
    member_id="memberId",
)

Parameters ​

id: str — The unique ID of an implementation.

member_id: str — The ID of the member (user ID) to remove.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.update_implementation_display_name(...)

Description ​

Set the display name of an implementation (identified by its ID). Pass null to clear.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.update_implementation_display_name(
    id="id",
)

Parameters ​

id: str — The unique ID of an implementation.

display_name: typing.Optional[str] — Human-readable display name. Pass null to clear.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.get_implementations(...) -> PageResponseImplementationDto

Description ​

Get a page of implementations. The access filter selects which bucket is returned. Sorting is supported by createdAt, displayName and name; any other sort field is rejected with 400.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.get_implementations()

Parameters ​

access: typing.Optional[GetImplementationsRequestAccess] — Which bucket of results to return. GRANTED (default) returns the results the caller holds an access permission for, INTERNAL returns the results with INTERNAL visibility regardless of the caller, PUBLIC returns the results with PUBLIC visibility regardless of the caller, ALL returns the union of all three.

q: typing.Optional[str] — Free-text search. Matches a case-insensitive fragment of the name, display name or summary. Omitted or blank returns the unfiltered list.

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.create_implementation(...) -> ImplementationDto

Description ​

Create a new implementation with a backing Git repository. Implementations contain the source code for quantum algorithms or services. The caller becomes the owner and the repository is provisioned automatically.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.create_implementation(
    name="my-quantum-algorithm",
)

Parameters ​

name: str — The name of the implementation.

display_name: typing.Optional[str] — Human-readable display name.

summary: typing.Optional[str] — Short description of the implementation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.get_implementation_access_permissions(...) -> typing.List[AccessPermissionDto]

Description ​

Get all access permissions for an implementation (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.get_implementation_access_permissions(
    id="id",
)

Parameters ​

id: str — The unique ID of an implementation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.add_implementation_access_permission(...)

Description ​

Add an access permission to an implementation (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.add_implementation_access_permission(
    id_path_param="id",
    id="id",
    role="VIEWER",
)

Parameters ​

id_path_param: str — The unique ID of an implementation.

id: str — The ID of the user to add as a member.

role: AddMemberRequestRole — The role to assign to the new member.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.get_permission_for_implementation(...)

Description ​

Get the current user's permission for an implementation. Use the UUID as slug for ID-based lookup, or combine a repository name as slug with the ?namespace= query parameter for full-path lookup. Returns the permission level in the x-access-permission response header.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.get_permission_for_implementation(
    slug="slug",
)

Parameters ​

slug: str — The implementation's unique ID or the repository name.

namespace: typing.Optional[str] — Required if the slug is the repository name.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.get_implementation_file(...) -> typing.Iterator[bytes]

Description ​

Download a file from an implementation's repository. The file path is specified as a sub-path after /files/, e.g., /implementations/{id}/files/src/main.py to download src/main.py from the repository root. Returns binary file content (not JSON).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.get_implementation_file(
    id="id",
)

Parameters ​

id: str — The unique ID of an implementation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.get_implementation_file_info(...)

Description ​

Get metadata of a file in an implementation's repository. The file path is specified as a sub-path after /files/, e.g., /implementations/{id}/files/src/main.py. Returns metadata in response headers: x-file-path, x-file-name, x-file-size (bytes), x-file-encoding, x-blob-id, x-commit-id, x-last-commit-id, x-ref.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.get_implementation_file_info(
    id="id",
)

Parameters ​

id: str — The unique ID of an implementation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.get_implementation(...) -> ImplementationDto

Description ​

Get a specific implementation (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.get_implementation(
    id="id",
)

Parameters ​

id: str — The unique ID of an implementation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.delete_implementation(...)

Description ​

Delete a specific implementation (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.delete_implementation(
    id="id",
)

Parameters ​

id: str — The unique ID of an implementation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.get_implementation_tree(...) -> TreeNode

Description ​

Get the repository tree of an implementation (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.get_implementation_tree(
    id="id",
)

Parameters ​

id: str — The unique ID of an implementation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.get_implementation_metadata(...) -> RepositoryMetadata

Description ​

Get the repository details of an implementation (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.get_implementation_metadata(
    id="id",
)

Parameters ​

id: str — The unique ID of an implementation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.implementations.get_implementation_languages(...) -> typing.Dict[str, float]

Description ​

Get the language statistics of an implementation's repository (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.implementations.get_implementation_languages(
    id="id",
)

Parameters ​

id: str — The unique ID of an implementation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Git Integrations ​

client.git_integrations.update_git_lab_integration(...) -> UpdateGitLabIntegrationResponse

Description ​

Rotates the Personal Access Token and display name of an existing GitLab git integration, keeping the same integration id.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.git_integrations.update_git_lab_integration(
    id="id",
    name="My GitLab",
    personal_access_token="personalAccessToken",
)

Parameters ​

id: str — The unique ID of a git integration.

name: str — A display name for this integration.

personal_access_token: str — The new GitLab personal access token.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.git_integrations.sync_git_integration_repositories(...) -> SyncGitIntegrationRepositoriesResponse

Description ​

Triggers an asynchronous Repository Sync for a Git integration on demand (see the Repository Cache, ADR-0072). Returns immediately with the integration in PENDING; poll GET /git-integrations/{id} for the outcome. A no-op returning the current state if a sync for this integration is already in flight.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.git_integrations.sync_git_integration_repositories(
    id="id",
)

Parameters ​

id: str — The unique ID of a git integration.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.git_integrations.create_git_lab_integration(...) -> CreateGitLabIntegrationResponse

Description ​

Registers a new GitLab Personal Access Token validated against the GitLab API.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.git_integrations.create_git_lab_integration(
    name="My GitLab",
    personal_access_token="personalAccessToken",
)

Parameters ​

name: str — A display name for this integration.

personal_access_token: str — The GitLab personal access token.

gitlab_url: typing.Optional[str] — The GitLab instance URL. Defaults to https://gitlab.com if not specified.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.git_integrations.create_git_hub_integration(...) -> CreateGitHubIntegrationResponse

Description ​

Associates a GitHub App installation with the current user account.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.git_integrations.create_git_hub_integration(
    installation_id=12345678,
)

Parameters ​

installation_id: int — GitHub App installation ID assigned by GitHub when the app is installed

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.git_integrations.get_git_integrations() -> typing.List[GetGitIntegrationsResponseItem]

Description ​

Retrieves all Git provider integrations (GitHub and GitLab) for the current tenant.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.git_integrations.get_git_integrations()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.git_integrations.get_git_integration(...) -> GetGitIntegrationResponse

Description ​

Retrieves a specific Git integration by its ID.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.git_integrations.get_git_integration(
    id="id",
)

Parameters ​

id: str — The unique ID of a git integration.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.git_integrations.delete_git_integration(...)

Description ​

Deletes a Git integration by its ID.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.git_integrations.delete_git_integration(
    id="id",
)

Parameters ​

id: str — The unique ID of a git integration.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.git_integrations.get_git_integration_repositories(...) -> PageResponseGitRepositoryDto

Description ​

Lists the repositories cached for a specific Git integration (see the Repository Cache, ADR-0072).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.git_integrations.get_git_integration_repositories(
    id="id",
)

Parameters ​

id: str — The unique ID of a git integration.

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.git_integrations.get_git_repositories(...) -> PageResponseGitRepositoryDto

Description ​

Lists the repositories cached across all Git integrations for the current tenant (see the Repository Cache, ADR-0072).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.git_integrations.get_git_repositories()

Parameters ​

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

External Services ​

client.external_services.update_external_service_security_configuration(...)

Description ​

Updates the security configuration of an external service.

Usage ​

python
from qhub.api.platform import HubPlatformClient, ServiceSecurityConfigurationAccessToken
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.external_services.update_external_service_security_configuration(
    id="id",
    request=ServiceSecurityConfigurationAccessToken(
        header_name="Authorization",
        token_value="Bearer my-secret-token",
        type="ACCESS_TOKEN",
    ),
)

Parameters ​

id: str — The unique ID of a service.

request: UpdateExternalServiceSecurityConfigurationRequestBody

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.external_services.add_external_service_pricing_plan(...) -> PricingPlanDto

Description ​

Adds a free pricing plan to an external service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.external_services.add_external_service_pricing_plan(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.external_services.delete_external_service_pricing_plan(...)

Description ​

Deletes the pricing plan of an external service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.external_services.delete_external_service_pricing_plan(
    id="id",
)

Parameters ​

id: str — The unique ID of a service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.external_services.create_external_service(...) -> ServiceDto

Description ​

Creates a new external service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.external_services.create_external_service(
    name="my-quantum-service",
    url="https://api.example.com/v1",
)

Parameters ​

name: str — The unique name of the service. Used as an identifier in URLs and API calls.

url: str — The base URL of the external service endpoint.

summary: typing.Optional[str] — A short summary of the service.

description: typing.Optional[str] — A detailed description of what the service does and how to use it.

security_configuration: typing.Optional[CreateExternalServiceRequestSecurityConfiguration] — The security configuration for authenticating with the external service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Data Pools ​

client.data_pools.get_data_pool(...) -> DataPoolDto

Description ​

Get a specific data pool (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pools.get_data_pool(
    id="id",
)

Parameters ​

id: str — The unique ID of a data pool.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pools.update_data_pool(...) -> DataPoolDto

Description ​

Update an existing data pool (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pools.update_data_pool(
    id="id",
    name="my-data-pool",
)

Parameters ​

id: str — The unique ID of a data pool.

name: str — The name of the data pool. Must be at least 3 characters and at most 255 characters long.

short_description: typing.Optional[str] — Short description of the data pool.

description: typing.Optional[str] — Detailed description of the data pool.

tags: typing.Optional[typing.List[str]] — List of tags associated with the data pool. Tags are saved in lowercase and can be used for filtering and searching.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pools.delete_data_pool(...)

Description ​

Delete a specific data pool (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pools.delete_data_pool(
    id="id",
)

Parameters ​

id: str — The unique ID of a data pool.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pools.get_data_pools() -> typing.List[DataPoolDto]

Description ​

Get a list of all data pools for the current user or organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pools.get_data_pools()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pools.create_data_pool(...) -> DataPoolDto

Description ​

Create a new data pool in the current user's account or the specified organization. A data pool is a container for files that can be shared with other users/organizations or used in service executions (via grants). The caller becomes the owner of the created data pool.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pools.create_data_pool(
    name="my-data-pool",
)

Parameters ​

name: str — The name of the data pool. Must be at least 3 characters and at most 255 characters long.

short_description: typing.Optional[str] — A short description of the data pool. Must be at most 60 characters long.

description: typing.Optional[str] — A description of the data pool and it's files.

tags: typing.Optional[typing.List[str]] — List of tags associated with the data pool. Tags are saved in lowercase and can be used for filtering and searching.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pools.get_data_pool_files(...) -> typing.List[DataPoolFileDto]

Description ​

Get all files associated with a specific data pool (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pools.get_data_pool_files(
    id="id",
)

Parameters ​

id: str — The unique ID of a data pool.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pools.add_data_pool_file(...) -> DataPoolFileDto

Description ​

Add a new file to a specific data pool (identified by its ID). Accepts binary file upload (multipart/form-data).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pools.add_data_pool_file(
    id="id",
    file="example_file",
)

Parameters ​

id: str — The unique ID of a data pool.

file: core.File — The file to upload to the data pool.

filename: typing.Optional[str] — Custom filename to use instead of the original upload filename.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pools.get_data_pool_file(...) -> typing.Iterator[bytes]

Description ​

Get the content of a specific file from a data pool (both file and data pool identified by their ID). Returns binary file content (not JSON).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pools.get_data_pool_file(
    id="id",
    file_id="fileId",
)

Parameters ​

id: str — The unique ID of a data pool.

file_id: str — The unique ID of a data pool file.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pools.delete_data_pool_file(...)

Description ​

Delete a specific file from a data pool (both file and data pool identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pools.delete_data_pool_file(
    id="id",
    file_id="fileId",
)

Parameters ​

id: str — The unique ID of a data pool.

file_id: str — The unique ID of a data pool file.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Data Pool Shares ​

client.data_pool_shares.update_data_pool_share_role(...) -> ShareDto

Description ​

Update the role of an existing data pool share.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pool_shares.update_data_pool_share_role(
    id="id",
    share_id="shareId",
)

Parameters ​

id: str — The unique ID of a data pool.

share_id: str — The unique ID of a resource share.

request: UpdateResourceShareRoleDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pool_shares.delete_data_pool_share(...)

Description ​

Revoke a share that was previously granted on a data pool. This removes the shared access for the target tenant. Requires GRANT permission on the data pool.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pool_shares.delete_data_pool_share(
    id="id",
    share_id="shareId",
)

Parameters ​

id: str — The unique ID of a data pool.

share_id: str — The unique ID of a resource share.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pool_shares.update_data_pool_share_constraint(...) -> TimeBasedConstraintDto

Description ​

Update an existing constraint on a data pool share.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pool_shares.update_data_pool_share_constraint(
    id="id",
    share_id="shareId",
    constraint_id="constraintId",
    valid_from="validFrom",
    valid_until="validUntil",
    type="TIME_BASED",
)

Parameters ​

id: str — The unique ID of a data pool.

share_id: str — The unique ID of a resource share.

constraint_id: str — The unique ID of a share constraint.

request: TimeBasedConstraintDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pool_shares.delete_data_pool_share_constraint(...)

Description ​

Delete an existing constraint on a data pool share.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pool_shares.delete_data_pool_share_constraint(
    id="id",
    share_id="shareId",
    constraint_id="constraintId",
)

Parameters ​

id: str — The unique ID of a data pool.

share_id: str — The unique ID of a resource share.

constraint_id: str — The unique ID of a share constraint.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pool_shares.get_shares_for_data_pool(...) -> typing.List[ShareDto]

Description ​

List all shares for a given data pool.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pool_shares.get_shares_for_data_pool(
    id="id",
)

Parameters ​

id: str — The unique ID of a data pool.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pool_shares.share_data_pool(...) -> ShareDto

Description ​

Share a data pool with other tenants.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pool_shares.share_data_pool(
    id="id",
)

Parameters ​

id: str — The unique ID of a data pool.

request: CreateShareRequestDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.data_pool_shares.add_data_pool_share_constraint(...) -> TimeBasedConstraintDto

Description ​

Add a new constraint to an existing data pool share.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pool_shares.add_data_pool_share_constraint(
    id="id",
    share_id="shareId",
    valid_from="validFrom",
    valid_until="validUntil",
    type="TIME_BASED",
)

Parameters ​

id: str — The unique ID of a data pool.

share_id: str — The unique ID of a resource share.

request: CreateTimeBasedConstraintDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Algorithms ​

client.algorithms.get_algorithm(...) -> AlgorithmDto

Description ​

Get a specific algorithm (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.get_algorithm(
    id="id",
)

Parameters ​

id: str — The unique ID of an algorithm.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.update_algorithm(...) -> AlgorithmDto

Description ​

Update an existing algorithm (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.update_algorithm(
    id="id",
    name="Shor\'s Algorithm",
    computation_model="CLASSIC",
)

Parameters ​

id: str — The unique ID of an algorithm.

name: str — The name of the algorithm.

computation_model: UpdateAlgorithmRequestComputationModel — The computation model used by the algorithm.

acronym: typing.Optional[str] — A short acronym or abbreviation for the algorithm.

intent: typing.Optional[str] — The intent or purpose of the algorithm, describing what problem it aims to solve.

problem: typing.Optional[str] — A description of the problem that the algorithm addresses.

input_format: typing.Optional[str] — The expected input format for the algorithm.

output_format: typing.Optional[str] — The expected output format of the algorithm.

algo_parameter: typing.Optional[str] — The parameters that the algorithm accepts.

solution: typing.Optional[str] — A description of the solution approach or methodology used by the algorithm.

assumptions: typing.Optional[str] — Assumptions or preconditions required for the algorithm to work correctly.

nisq_ready: typing.Optional[bool] — Whether this algorithm is suitable for Noisy Intermediate-Scale Quantum (NISQ) devices.

speed_up: typing.Optional[str] — The theoretical speed-up provided by the algorithm compared to classical approaches.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.delete_algorithm(...)

Description ​

Delete a specific algorithm (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.delete_algorithm(
    id="id",
)

Parameters ​

id: str — The unique ID of an algorithm.

force: typing.Optional[bool] — If true, deletes the algorithm even if it has active relations or is linked to use cases.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.set_algorithm_visibility(...)

Description ​

Set the visibility of an algorithm (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.set_algorithm_visibility(
    id="id",
    type="PRIVATE",
)

Parameters ​

id: str — The unique ID of an algorithm.

request: UpdateVisibilityRequest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.get_algorithm_sketch(...) -> AlgorithmSketchDto

Description ​

Get a specific sketch of an algorithm (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.get_algorithm_sketch(
    id="id",
    sketch_id="sketchId",
)

Parameters ​

id: str — The unique ID of an algorithm.

sketch_id: str — The unique ID of an algorithm sketch.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.update_algorithm_sketch(...) -> AlgorithmSketchDto

Description ​

Update a specific sketch of an algorithm (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.update_algorithm_sketch(
    id="id",
    sketch_id="sketchId",
)

Parameters ​

id: str — The unique ID of an algorithm.

sketch_id: str — The unique ID of an algorithm sketch.

description: typing.Optional[str]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.delete_algorithm_sketch(...)

Description ​

Delete a specific sketch of an algorithm (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.delete_algorithm_sketch(
    id="id",
    sketch_id="sketchId",
)

Parameters ​

id: str — The unique ID of an algorithm.

sketch_id: str — The unique ID of an algorithm sketch.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.get_algorithm_sketch_image(...) -> typing.Iterator[bytes]

Description ​

Get the image of a specific sketch of an algorithm (both identified by their IDs). Returns binary image content (not JSON).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.get_algorithm_sketch_image(
    id="id",
    sketch_id="sketchId",
)

Parameters ​

id: str — The unique ID of an algorithm.

sketch_id: str — The unique ID of an algorithm sketch.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.upload_algorithm_sketch_image(...)

Description ​

Upload the image for a specific sketch of an algorithm (both identified by their IDs). Accepts binary file upload (multipart/form-data).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.upload_algorithm_sketch_image(
    id="id",
    sketch_id="sketchId",
    file="example_file",
)

Parameters ​

id: str — The unique ID of an algorithm.

sketch_id: str — The unique ID of an algorithm sketch.

file: core.File — The sketch image file to upload.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.get_algorithm_relation(...) -> AlgorithmRelationDto

Description ​

Get a specific relation of an algorithm (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.get_algorithm_relation(
    id="id",
    relation_id="relationId",
)

Parameters ​

id: str — The unique ID of an algorithm.

relation_id: str — The unique ID of an algorithm relation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.update_algorithm_relation(...) -> AlgorithmRelationDto

Description ​

Update a specific relation of an algorithm (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.update_algorithm_relation(
    id="id",
    relation_id="relationId",
    source_algorithm_id="sourceAlgorithmId",
    target_algorithm_id="targetAlgorithmId",
    relation_type_id="relationTypeId",
)

Parameters ​

id: str — The unique ID of an algorithm.

relation_id: str — The unique ID of an algorithm relation.

source_algorithm_id: str — The ID of the source algorithm in the relation.

target_algorithm_id: str — The ID of the target algorithm in the relation.

relation_type_id: str — The ID of the relation type that describes how the two algorithms are related.

description: typing.Optional[str] — An optional description providing additional context about the relation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.delete_algorithm_relation(...)

Description ​

Delete a specific relation of an algorithm (both identified by their IDs).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.delete_algorithm_relation(
    id="id",
    relation_id="relationId",
)

Parameters ​

id: str — The unique ID of an algorithm.

relation_id: str — The unique ID of an algorithm relation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.get_algorithms(...) -> PageResponseAlgorithmOverviewDto

Description ​

Get a page of algorithms. The access filter selects which bucket is returned.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.get_algorithms()

Parameters ​

access: typing.Optional[GetAlgorithmsRequestAccess] — Which bucket of results to return. GRANTED (default) returns the results the caller holds an access permission for, INTERNAL returns the results with INTERNAL visibility regardless of the caller, PUBLIC returns the results with PUBLIC visibility regardless of the caller, ALL returns the union of all three.

q: typing.Optional[str] — Free-text search. Matches a case-insensitive fragment of the name, acronym, intent, problem, solution or assumptions. Omitted or blank returns the unfiltered list.

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.create_algorithm(...) -> AlgorithmDto

Description ​

Create a new algorithm in the current user's account or the specified organization. Algorithms describe quantum or hybrid computation methods and can be linked to use cases. The caller becomes the owner of the created algorithm.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.create_algorithm(
    name="Shor\'s Algorithm",
    computation_model="CLASSIC",
)

Parameters ​

name: str — The name of the algorithm.

computation_model: CreateAlgorithmRequestComputationModel — The computation model used by the algorithm.

acronym: typing.Optional[str] — A short acronym or abbreviation for the algorithm.

intent: typing.Optional[str] — The intent or purpose of the algorithm, describing what problem it aims to solve.

problem: typing.Optional[str] — A description of the problem that the algorithm addresses.

input_format: typing.Optional[str] — The expected input format for the algorithm.

output_format: typing.Optional[str] — The expected output format of the algorithm.

algo_parameter: typing.Optional[str] — The parameters that the algorithm accepts.

solution: typing.Optional[str] — A description of the solution approach or methodology used by the algorithm.

assumptions: typing.Optional[str] — Assumptions or preconditions required for the algorithm to work correctly.

nisq_ready: typing.Optional[bool] — Whether this algorithm is suitable for Noisy Intermediate-Scale Quantum (NISQ) devices.

speed_up: typing.Optional[str] — The theoretical speed-up provided by the algorithm compared to classical approaches.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.create_algorithm_sketch(...) -> AlgorithmSketchDto

Description ​

Create a new sketch for a specific algorithm (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.create_algorithm_sketch(
    id="id",
)

Parameters ​

id: str — The unique ID of an algorithm.

description: typing.Optional[str]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.get_algorithm_relations(...) -> typing.List[AlgorithmRelationDto]

Description ​

Get all relations for a specific algorithm (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.get_algorithm_relations(
    id="id",
)

Parameters ​

id: str — The unique ID of an algorithm.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.create_algorithm_relation(...) -> AlgorithmRelationDto

Description ​

Create a new relation for a specific algorithm (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.create_algorithm_relation(
    id="id",
    source_algorithm_id="sourceAlgorithmId",
    target_algorithm_id="targetAlgorithmId",
    relation_type_id="relationTypeId",
)

Parameters ​

id: str — The unique ID of an algorithm.

source_algorithm_id: str — The ID of the source algorithm in the relation.

target_algorithm_id: str — The ID of the target algorithm in the relation.

relation_type_id: str — The ID of the relation type that describes how the two algorithms are related.

description: typing.Optional[str] — An optional description providing additional context about the relation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.get_algorithm_access_permissions(...) -> typing.List[AccessPermissionDto]

Description ​

Get all access permissions for a specific algorithm (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.get_algorithm_access_permissions(
    id="id",
)

Parameters ​

id: str — The unique ID of an algorithm.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.add_algorithm_access_permission(...)

Description ​

Add an access permission to a specific algorithm (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.add_algorithm_access_permission(
    id="id",
)

Parameters ​

id: str — The unique ID of an algorithm.

request: AccessPermissionDto

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.get_algorithm_relation_types() -> PageResponseAlgorithmRelationTypeDto

Description ​

Get all available algorithm relation types.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.get_algorithm_relation_types()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.algorithms.remove_algorithm_access_permission(...)

Description ​

Remove an access permission from a specific algorithm (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.algorithms.remove_algorithm_access_permission(
    id="id",
    sid="sid",
)

Parameters ​

id: str — The unique ID of an algorithm.

sid: str — The security identifier (user SID or organization SID) of the permission holder to remove.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Workflow User Tasks ​

client.workflow_user_tasks.submit_response(...)

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.workflow_user_tasks.submit_response(
    task_id="taskId",
)

Parameters ​

task_id: str

response_value: typing.Optional[typing.Dict[str, typing.Any]]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Subscriptions ​

client.subscriptions.create_subscription(...) -> SubscriptionDto

Description ​

Create a subscription to an internally or publicly published service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.subscriptions.create_subscription(
    service_id="serviceId",
    application_id="applicationId",
)

Parameters ​

service_id: str — The ID of the service to subscribe to.

application_id: str — The ID of the application that will hold the subscription.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.subscriptions.get_subscription(...) -> SubscriptionDto

Description ​

Get a specific subscription (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.subscriptions.get_subscription(
    id="id",
)

Parameters ​

id: str — The unique ID of a subscription.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.subscriptions.delete_subscription(...)

Description ​

Remove a specific subscription. This will revoke access to the subscribed service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.subscriptions.delete_subscription(
    id="id",
)

Parameters ​

id: str — The unique ID of a subscription.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.subscriptions.get_service_executions_by_subscription(...) -> typing.List[ServiceExecutionDto]

Description ​

Get a list of all service executions related to a specific subscription.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.subscriptions.get_service_executions_by_subscription(
    id="id",
)

Parameters ​

id: str — The unique ID of a subscription.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Service Jobs ​

client.service_jobs.get_service_jobs(...) -> PageResponseServiceJobDto

Description ​

Get a paginated list of service jobs. Optionally filter by serviceId, tags, IDs, and creation date range. Supports sorting by: createdAt, startedAt, endedAt, status, serviceId. Default sort is createdAt descending (newest first).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_jobs.get_service_jobs()

Parameters ​

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

created_after: typing.Optional[datetime.datetime] — Filter service jobs created after this timestamp (ISO 8601 format, e.g., 2024-01-01T00:00:00Z, or milliseconds since epoch)

created_before: typing.Optional[datetime.datetime] — Filter service jobs created before this timestamp (ISO 8601 format, e.g., 2024-12-31T23:59:59Z', or milliseconds since epoch)

service_id: typing.Optional[str] — Filter by a certain service id

tags: typing.Optional[typing.Union[str, typing.Sequence[str]]] — Filter by tags (returns service jobs that have ANY of the specified tags)

ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] — Filter by ID pattern (supports wildcards with '', e.g., 'f81d4fae-' or '*-00a0c91e6bf6')

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_jobs.create_service_job(...) -> ServiceJobDto

Description ​

Create and start a new service job.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_jobs.create_service_job(
    service_id="serviceId",
)

Parameters ​

service_id: str — The ID fo the service for which the job is created.

input: typing.Optional[typing.Dict[str, typing.Any]] — Input data for the service job. This can be any JSON object that the service expects as input. The structure and content of this object depend on the specific service being executed.

tags: typing.Optional[typing.List[str]] — List of tags associated with the service job. Tags are saved in lowercase and can be used for filtering and searching.

store_input: typing.Optional[bool] — Flag indicating whether the input data should be persisted along with the service job (when set to true). If set to false or omitted, the input will not be stored. Default is false.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_jobs.rerun_service_job(...) -> ServiceJobDto

Description ​

Rerun an existing service job with the same configuration (input, tags, service). Creates a new service job with a new ID. Note: Only service jobs with stored input can be rerun (created with 'storeInput: true').

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_jobs.rerun_service_job(
    id="id",
)

Parameters ​

id: str — The unique ID of a service job.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.service_jobs.get_service_job(...) -> ServiceJobDto

Description ​

Get a specific service job (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.service_jobs.get_service_job(
    id="id",
)

Parameters ​

id: str — The unique ID of a service job.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Entitlements ​

client.entitlements.check_job_eligibility(...) -> EntitlementDecision

Description ​

Evaluates whether a job submission with the specified parameters would be allowed under the caller's current entitlements. This is intended to be used as a pre-flight check before actually submitting a job, to provide better error messages and avoid unnecessary job submissions that would be rejected anyway. Note that the actual submission endpoint will still perform its own eligibility check and may reject the submission even if this endpoint returns ALLOW, due to potential state changes in between the eligibility check and the submission.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.entitlements.check_job_eligibility(
    provider="AZURE",
    backend_id="azure.ionq.simulator",
    workload_type="JOB",
)

Parameters ​

provider: JobEligibilityRequestProvider — Provider that owns the target backend.

backend_id: str — Fully-qualified backend identifier as listed in the catalog backend registry.

workload_type: JobEligibilityRequestWorkloadType — Type of workload the caller intends to submit.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.entitlements.get_entitlements() -> Entitlements

Description ​

Fetches the entitlements for the current tenant. The entitlements are resolved based on the tenant's attributes and the configured entitlement rules. This endpoint can be used by clients to determine which features or services the tenant is entitled to use.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.entitlements.get_entitlements()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Data Pool Grants ​

client.data_pool_grants.create_data_pool_grant(...) -> DataPoolGrant

Description ​

Create a short-lived access grant for a specific data pool (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.data_pool_grants.create_data_pool_grant(
    id="id",
    application_id="applicationId",
    permission="permission",
)

Parameters ​

id: str — The unique ID of a data pool.

application_id: str — The ID of the application to grant access to.

permission: str — The permission level to grant (VIEW, MODIFY, or GRANT).

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Authentication ​

client.authentication.resolve_auth_token() -> ResolveAuthTokenResponse

Description ​

Resolve the principal associated with the given authentication token.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.authentication.resolve_auth_token()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Applications ​

client.applications.get_applications() -> typing.List[ApplicationDto]

Description ​

Get a list of all applications for the current user or organization.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.applications.get_applications()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.applications.create_application(...) -> ApplicationDto

Description ​

Create a new application in the current user's account or the specified organization. Applications are used to subscribe to services and execute them. Each application gets its own set of access keys for authenticating service calls.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.applications.create_application(
    name="my-application",
)

Parameters ​

name: str — The name of the application.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.applications.get_application(...) -> ApplicationDto

Description ​

Get a specific application (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.applications.get_application(
    id="id",
)

Parameters ​

id: str — The unique ID of an application.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.applications.delete_application(...)

Description ​

Delete an application (identified by its ID).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.applications.delete_application(
    id="id",
)

Parameters ​

id: str — The unique ID of an application.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.applications.get_application_subscriptions(...) -> typing.List[SubscriptionDto]

Description ​

List all subscriptions of an application.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.applications.get_application_subscriptions(
    id="id",
)

Parameters ​

id: str — The unique ID of an application.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.applications.get_application_access_keys(...) -> typing.List[AccessKey]

Description ​

List of access keys for an application. Use these access keys to generate access tokens to authenticate service execution requests for subscribed services.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.applications.get_application_access_keys(
    id="id",
)

Parameters ​

id: str — The unique ID of an application.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Marketplace ​

client.marketplace.get_file(...) -> typing.Iterator[bytes]

Description ​

Download a file from a marketplace implementation's repository. The file path is specified as a sub-path after /files/, e.g., /marketplace/implementations/{id}/files/src/main.py.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_file(
    id="id",
)

Parameters ​

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_file_info(...)

Description ​

Get metadata of a file in a marketplace implementation's repository. The file path is specified as a sub-path after /files/, e.g., /marketplace/implementations/{id}/files/src/main.py. Returns metadata in response headers: x-file-path, x-file-name, x-file-size (bytes), x-file-encoding, x-blob-id, x-commit-id, x-last-commit-id, x-ref.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_file_info(
    id="id",
)

Parameters ​

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_marketplace_use_cases(...) -> PageResponseMarketplaceUseCaseOverviewDto

Description ​

Returns a list of all publicly available use cases in the marketplace.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_marketplace_use_cases()

Parameters ​

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_marketplace_use_case(...) -> MarketplaceUseCaseDetailsDto

Description ​

Returns the full details of a specific marketplace use case.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_marketplace_use_case(
    id="id",
)

Parameters ​

id: str — The unique ID of a use case.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_marketplace_use_case_sketch_image(...) -> typing.Iterator[bytes]

Description ​

Get the image of a specific sketch of a marketplace use case. Returns binary image content (not JSON).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_marketplace_use_case_sketch_image(
    id="id",
    sketch_id="sketchId",
)

Parameters ​

id: str — The unique ID of a use case.

sketch_id: str — The unique ID of a use case sketch.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_marketplace_use_case_author_image(...) -> typing.Iterator[bytes]

Description ​

Get the profile image of a specific author of a marketplace use case. Returns binary image content (not JSON).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_marketplace_use_case_author_image(
    id="id",
    author_id="authorId",
)

Parameters ​

id: str — The unique ID of a use case.

author_id: str — The unique ID of a use case author.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_marketplace_services(...) -> PageResponseMarketplaceServiceOverviewDto

Description ​

Returns a paginated list of all publicly published services in the marketplace.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_marketplace_services()

Parameters ​

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_marketplace_service(...) -> MarketplaceServiceDetailsDto

Description ​

Returns the full details of a specific marketplace service, including pricing plan, contacts, links, and API specification metadata.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_marketplace_service(
    id="id",
)

Parameters ​

id: str — The unique ID of the marketplace service.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_marketplace_service_openapi(...) -> str

Description ​

Get the OpenAPI specification of a specific marketplace service.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_marketplace_service_openapi(
    id="id",
)

Parameters ​

id: str — The unique ID of the marketplace service.

format: typing.Optional[GetMarketplaceServiceOpenapiRequestFormat] — Output format: JSON or YAML. Default: JSON.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_marketplace_implementations(...) -> PageResponseMarketplaceImplementationOverviewDto

Description ​

Returns a list of all publicly available implementations in the marketplace.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_marketplace_implementations()

Parameters ​

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_marketplace_implementation(...) -> MarketplaceImplementationDetailsDto

Description ​

Returns the full details of a specific marketplace implementation.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_marketplace_implementation(
    id="id",
)

Parameters ​

id: str — The unique ID of an implementation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_tree(...) -> TreeNode

Description ​

Get the repository tree of a marketplace implementation.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_tree(
    id="id",
)

Parameters ​

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_metadata(...) -> RepositoryMetadata

Description ​

Get the repository metadata of a marketplace implementation.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_metadata(
    id="id",
)

Parameters ​

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_languages(...) -> typing.Dict[str, float]

Description ​

Get the language statistics of a marketplace implementation's repository.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_languages(
    id="id",
)

Parameters ​

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_marketplace_algorithms(...) -> PageResponseMarketplaceAlgorithmOverviewDto

Description ​

Returns a list of all publicly available algorithms in the marketplace.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_marketplace_algorithms()

Parameters ​

page: typing.Optional[int] — Zero-based page index (0..N)

size: typing.Optional[int] — The size of the page to be returned

sort: typing.Optional[str] — Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_marketplace_algorithm(...) -> MarketplaceAlgorithmDetailsDto

Description ​

Returns the full details of a specific marketplace algorithm.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_marketplace_algorithm(
    id="id",
)

Parameters ​

id: str — The unique ID of an algorithm.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.marketplace.get_marketplace_algorithm_sketch_image(...) -> typing.Iterator[bytes]

Description ​

Get the image of a specific sketch of a marketplace algorithm. Returns binary image content (not JSON).

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.marketplace.get_marketplace_algorithm_sketch_image(
    id="id",
    sketch_id="sketchId",
)

Parameters ​

id: str — The unique ID of an algorithm.

sketch_id: str — The unique ID of an algorithm sketch.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Quantum Workloads ​

client.quantum_workloads.get_quantum_workload_costs(...) -> typing.Optional[QuantumWorkloadCosts]

Description ​

Get the aggregated total cost for a specific quantum workload (job or session) identified by its ID. A metered workload that carries no billable usage reports a total cost of zero. As long as the workload has not been metered at all, a HTTP 204 (No Content) response is returned with a "Retry-After" header. For detailed workload costs use the '/quantum-jobs/{id}/costs' endpoint.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.quantum_workloads.get_quantum_workload_costs(
    id="id",
)

Parameters ​

id: str — The unique ID of a quantum workload.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.quantum_workloads.get_quantum_job_costs(...) -> typing.Optional[typing.List[CostEntry]]

Description ​

Get the costs for a specific quantum job (identified by its ID). A metered job that carries no billable usage reports an empty list. As long as the quantum job has not been metered at all, a HTTP 204 (No Content) response is returned with a "Retry-After" header.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.quantum_workloads.get_quantum_job_costs(
    id="id",
)

Parameters ​

id: str — The unique ID of a quantum job.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Products ​

client.products.get_products() -> typing.List[PlatformProductDto]

Description ​

Returns all currently active platform offerings together with their metered prices. Publicly accessible: no authentication required.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.products.get_products()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Announcements ​

client.announcements.get_announcements() -> typing.List[AnnouncementDto]

Description ​

Get the platform-wide announcements to display, newest first. Message bodies are Markdown.

Usage ​

python
from qhub.api.platform import HubPlatformClient
from qhub.api.platform.environment import HubPlatformClientEnvironment

client = HubPlatformClient(
    api_key="<value>",
    environment=HubPlatformClientEnvironment.DEFAULT,
)

client.announcements.get_announcements()

Parameters ​

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

TypeScript reference ​

Workflow Services ​

client.workflowServices.getWorkflowModel(id) -> void

Description ​

Get the current workflow model of a workflow service.

Usage ​

typescript
await client.workflowServices.getWorkflowModel("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: WorkflowServicesClient.RequestOptions

client.workflowServices.updateWorkflowModel(id, { ...params }) -> void

Description ​

Update the workflow model of an existing workflow service.

Usage ​

typescript
await client.workflowServices.updateWorkflowModel("id");

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.UpdateWorkflowServiceRequest

requestOptions: WorkflowServicesClient.RequestOptions

client.workflowServices.createWorkflowService({ ...params }) -> HubPlatform.ServiceDto

Description ​

Create a new workflow service.

Usage ​

typescript
await client.workflowServices.createWorkflowService({
    name: "my-quantum-service"
});

Parameters ​

request: HubPlatform.CreateWorkflowServiceRequest

requestOptions: WorkflowServicesClient.RequestOptions

client.workflowServices.addWorkflowServicePricingPlan(id) -> HubPlatform.PricingPlanDto

Description ​

Add a pricing plan to the workflow service.

Usage ​

typescript
await client.workflowServices.addWorkflowServicePricingPlan("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: WorkflowServicesClient.RequestOptions

client.workflowServices.deployWorkflowModel(id) -> void

Description ​

Deploy a workflow service model to the platform's workflow engine.

Usage ​

typescript
await client.workflowServices.deployWorkflowModel("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: WorkflowServicesClient.RequestOptions

Use Cases ​

client.useCases.getUseCase(id) -> HubPlatform.UseCaseDto

Description ​

Get a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.getUseCase("id");

Parameters ​

id: string — The unique ID of a use case.

requestOptions: UseCasesClient.RequestOptions

client.useCases.updateUseCase(id, { ...params }) -> HubPlatform.UseCaseDto

Description ​

Update an existing use case (identified by its ID).

Usage ​

typescript
await client.useCases.updateUseCase("id", {
    title: "Quantum Portfolio Optimization"
});

Parameters ​

id: string — The unique ID of a use case.

request: HubPlatform.UpdateUseCaseRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.deleteUseCase(id) -> void

Description ​

Delete a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.deleteUseCase("id");

Parameters ​

id: string — The unique ID of a use case.

requestOptions: UseCasesClient.RequestOptions

client.useCases.setUseCaseVisibility(id, { ...params }) -> void

Description ​

Set the visibility of a use case (identified by its ID).

Usage ​

typescript
await client.useCases.setUseCaseVisibility("id", {
    type: "PRIVATE"
});

Parameters ​

id: string — The unique ID of a use case.

request: HubPlatform.UpdateVisibilityRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.getUseCaseSketch(id, sketchId) -> HubPlatform.UseCaseSketchDto

Description ​

Get a specific sketch of a use case (both identified by their IDs).

Usage ​

typescript
await client.useCases.getUseCaseSketch("id", "sketchId");

Parameters ​

id: string — The unique ID of a use case.

sketchId: string — The unique ID of a use case sketch.

requestOptions: UseCasesClient.RequestOptions

client.useCases.updateUseCaseSketch(id, sketchId, { ...params }) -> HubPlatform.UseCaseSketchDto

Description ​

Update a specific sketch of a use case (both identified by their IDs).

Usage ​

typescript
await client.useCases.updateUseCaseSketch("id", "sketchId");

Parameters ​

id: string — The unique ID of a use case.

sketchId: string — The unique ID of a use case sketch.

request: HubPlatform.UpdateUseCaseSketchRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.deleteUseCaseSketch(id, sketchId) -> void

Description ​

Delete a specific sketch of a use case (both identified by their IDs).

Usage ​

typescript
await client.useCases.deleteUseCaseSketch("id", "sketchId");

Parameters ​

id: string — The unique ID of a use case.

sketchId: string — The unique ID of a use case sketch.

requestOptions: UseCasesClient.RequestOptions

client.useCases.getUseCaseSketchImage(id, sketchId) -> core.BinaryResponse

Description ​

Get the image of a specific sketch of a use case (both identified by their IDs). Returns binary image content (not JSON).

Usage ​

typescript
await client.useCases.getUseCaseSketchImage("id", "sketchId");

Parameters ​

id: string — The unique ID of a use case.

sketchId: string — The unique ID of a use case sketch.

requestOptions: UseCasesClient.RequestOptions

client.useCases.uploadUseCaseSketchImage(id, sketchId, { ...params }) -> void

Description ​

Upload the image for a specific sketch of a use case (both identified by their IDs). Accepts binary file upload (multipart/form-data).

Usage ​

typescript
await client.useCases.uploadUseCaseSketchImage("id", "sketchId", {
    file: fs.createReadStream("/path/to/your/file")
});

Parameters ​

id: string

sketchId: string

request: HubPlatform.UploadUseCaseSketchImageRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.updateUseCaseDemoIntegration(id, { ...params }) -> HubPlatform.DemoWithStatus

Description ​

Swap the git integration used by the demo of a specific use case (identified by its ID). The new integration must have access to the demo's existing repository; repository and branch stay unchanged. No build is triggered.

Usage ​

typescript
await client.useCases.updateUseCaseDemoIntegration("id", {
    gitIntegrationId: "550e8400-e29b-41d4-a716-446655440000"
});

Parameters ​

id: string — The unique ID of a use case.

request: HubPlatform.UpdateDemoIntegrationRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.updateUseCaseDemoEnvironment(id, { ...params }) -> HubPlatform.DemoWithStatus

Description ​

Replace the environment variables of the demo for a specific use case (identified by its ID). The provided map fully replaces the existing environment. Keys are uppercased and whitespace is replaced with underscores; entries with blank values are removed.

Usage ​

typescript
await client.useCases.updateUseCaseDemoEnvironment("id", {
    environment: {
        "key": "value"
    }
});

Parameters ​

id: string — The unique ID of a use case.

request: HubPlatform.UpdateDemoEnvironmentRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.getUseCaseAuthor(id, authorId) -> HubPlatform.UseCaseAuthorDto

Description ​

Get a specific author of a use case (both identified by their IDs).

Usage ​

typescript
await client.useCases.getUseCaseAuthor("id", "authorId");

Parameters ​

id: string — The unique ID of a use case.

authorId: string — The unique ID of a use case author.

requestOptions: UseCasesClient.RequestOptions

client.useCases.updateUseCaseAuthor(id, authorId, { ...params }) -> HubPlatform.UseCaseAuthorDto

Description ​

Update a specific author of a use case (both identified by their IDs).

Usage ​

typescript
await client.useCases.updateUseCaseAuthor("id", "authorId", {
    name: "Jane Doe"
});

Parameters ​

id: string — The unique ID of a use case.

authorId: string — The unique ID of a use case author.

request: HubPlatform.UpdateUseCaseAuthorRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.deleteUseCaseAuthor(id, authorId) -> void

Description ​

Delete a specific author of a use case (both identified by their IDs).

Usage ​

typescript
await client.useCases.deleteUseCaseAuthor("id", "authorId");

Parameters ​

id: string — The unique ID of a use case.

authorId: string — The unique ID of a use case author.

requestOptions: UseCasesClient.RequestOptions

client.useCases.getUseCases({ ...params }) -> HubPlatform.PageResponseUseCaseOverviewDto

Description ​

Get a page of use cases. The access filter selects which bucket is returned.

Usage ​

typescript
await client.useCases.getUseCases();

Parameters ​

request: HubPlatform.GetUseCasesRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.createUseCase({ ...params }) -> HubPlatform.UseCaseDto

Description ​

Create a new use case in the current user's account or the specified organization. Use cases describe real-world quantum computing applications and can link to algorithms, services, and demos. The caller becomes the owner of the created use case.

Usage ​

typescript
await client.useCases.createUseCase({
    title: "Quantum Portfolio Optimization"
});

Parameters ​

request: HubPlatform.CreateUseCaseRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.createUseCaseSketch(id, { ...params }) -> HubPlatform.UseCaseSketchDto

Description ​

Create a new sketch for a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.createUseCaseSketch("id");

Parameters ​

id: string — The unique ID of a use case.

request: HubPlatform.CreateUseCaseSketchRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.linkServiceToUseCase(id, serviceDefinitionId) -> void

Description ​

Link a service to a specific use case (both identified by their IDs).

Usage ​

typescript
await client.useCases.linkServiceToUseCase("id", "serviceDefinitionId");

Parameters ​

id: string — The unique ID of a use case.

serviceDefinitionId: string — The unique ID of a service definition.

requestOptions: UseCasesClient.RequestOptions

client.useCases.unlinkServiceFromUseCase(id, serviceDefinitionId) -> void

Description ​

Unlink a service from a specific use case (both identified by their IDs).

Usage ​

typescript
await client.useCases.unlinkServiceFromUseCase("id", "serviceDefinitionId");

Parameters ​

id: string — The unique ID of a use case.

serviceDefinitionId: string — The unique ID of a service definition.

requestOptions: UseCasesClient.RequestOptions

client.useCases.getUseCaseLogo(id) -> core.BinaryResponse

Description ​

Get the logo of a specific use case (identified by its ID). Returns binary image content (not JSON).

Usage ​

typescript
await client.useCases.getUseCaseLogo("id");

Parameters ​

id: string — The unique ID of a use case.

requestOptions: UseCasesClient.RequestOptions

client.useCases.uploadUseCaseLogo(id, { ...params }) -> void

Description ​

Upload the logo for a specific use case (identified by its ID). Accepts binary file upload (multipart/form-data).

Usage ​

typescript
await client.useCases.uploadUseCaseLogo("id", {
    file: fs.createReadStream("/path/to/your/file")
});

Parameters ​

id: string

request: HubPlatform.UploadUseCaseLogoRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.getUseCaseDemo(id) -> HubPlatform.DemoWithStatus

Description ​

Get the demo with current build status for a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.getUseCaseDemo("id");

Parameters ​

id: string — The unique ID of a use case.

requestOptions: UseCasesClient.RequestOptions

client.useCases.createUseCaseDemo(id, { ...params }) -> HubPlatform.DemoWithStatus

Description ​

Create a demo for a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.createUseCaseDemo("id", {
    useCaseId: "550e8400-e29b-41d4-a716-446655440000",
    gitIntegrationId: "550e8400-e29b-41d4-a716-446655440000",
    repositoryType: "GITHUB",
    repositoryUrl: "https://github.com/myorg/my-demo-app"
});

Parameters ​

id: string — The unique ID of a use case.

request: HubPlatform.CreateDemoRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.deleteUseCaseDemo(id) -> void

Description ​

Delete the demo of a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.deleteUseCaseDemo("id");

Parameters ​

id: string — The unique ID of a use case.

requestOptions: UseCasesClient.RequestOptions

client.useCases.triggerUseCaseDemoBuild(id) -> void

Description ​

Trigger a build for the demo of a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.triggerUseCaseDemoBuild("id");

Parameters ​

id: string — The unique ID of a use case.

requestOptions: UseCasesClient.RequestOptions

client.useCases.getUseCaseAuthors(id) -> HubPlatform.UseCaseAuthorDto[]

Description ​

Get all authors of a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.getUseCaseAuthors("id");

Parameters ​

id: string — The unique ID of a use case.

requestOptions: UseCasesClient.RequestOptions

client.useCases.createUseCaseAuthor(id, { ...params }) -> HubPlatform.UseCaseAuthorDto

Description ​

Create a new author for a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.createUseCaseAuthor("id", {
    name: "Jane Doe"
});

Parameters ​

id: string — The unique ID of a use case.

request: HubPlatform.CreateUseCaseAuthorRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.getUseCaseAuthorImage(id, authorId) -> core.BinaryResponse

Description ​

Get the image of a specific author of a use case (both identified by their IDs). Returns binary image content (not JSON).

Usage ​

typescript
await client.useCases.getUseCaseAuthorImage("id", "authorId");

Parameters ​

id: string — The unique ID of a use case.

authorId: string — The unique ID of a use case author.

requestOptions: UseCasesClient.RequestOptions

client.useCases.uploadUseCaseAuthorImage(id, authorId, { ...params }) -> void

Description ​

Upload the image for a specific author of a use case (both identified by their IDs). Accepts binary file upload (multipart/form-data).

Usage ​

typescript
await client.useCases.uploadUseCaseAuthorImage("id", "authorId", {
    file: fs.createReadStream("/path/to/your/file")
});

Parameters ​

id: string

authorId: string

request: HubPlatform.UploadUseCaseAuthorImageRequest

requestOptions: UseCasesClient.RequestOptions

client.useCases.deleteUseCaseAuthorImage(id, authorId) -> void

Description ​

Delete the image of a specific author of a use case (both identified by their IDs).

Usage ​

typescript
await client.useCases.deleteUseCaseAuthorImage("id", "authorId");

Parameters ​

id: string — The unique ID of a use case.

authorId: string — The unique ID of a use case author.

requestOptions: UseCasesClient.RequestOptions

client.useCases.linkAlgorithmToUseCase(id, algorithmId) -> void

Description ​

Link an algorithm to a specific use case (both identified by their IDs).

Usage ​

typescript
await client.useCases.linkAlgorithmToUseCase("id", "algorithmId");

Parameters ​

id: string — The unique ID of a use case.

algorithmId: string — The unique ID of an algorithm.

requestOptions: UseCasesClient.RequestOptions

client.useCases.unlinkAlgorithmFromUseCase(id, algorithmId) -> void

Description ​

Unlink an algorithm from a specific use case (both identified by their IDs).

Usage ​

typescript
await client.useCases.unlinkAlgorithmFromUseCase("id", "algorithmId");

Parameters ​

id: string — The unique ID of a use case.

algorithmId: string — The unique ID of an algorithm.

requestOptions: UseCasesClient.RequestOptions

client.useCases.getUseCaseAccessPermissions(id) -> HubPlatform.AccessPermissionDto[]

Description ​

Get all access permissions for a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.getUseCaseAccessPermissions("id");

Parameters ​

id: string — The unique ID of a use case.

requestOptions: UseCasesClient.RequestOptions

client.useCases.addUseCaseAccessPermission(id, { ...params }) -> void

Description ​

Add an access permission to a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.addUseCaseAccessPermission("id", {});

Parameters ​

id: string — The unique ID of a use case.

request: HubPlatform.AccessPermissionDto

requestOptions: UseCasesClient.RequestOptions

client.useCases.getLinkedServicesByUseCase(id) -> HubPlatform.ServiceDto[]

Description ​

Get all services linked to a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.getLinkedServicesByUseCase("id");

Parameters ​

id: string — The unique ID of a use case.

requestOptions: UseCasesClient.RequestOptions

client.useCases.getUseCaseDemoRuntimeLogs(id) -> HubPlatform.LogEntry[]

Description ​

Get the runtime logs for the demo of a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.getUseCaseDemoRuntimeLogs("id");

Parameters ​

id: string — The unique ID of a use case.

requestOptions: UseCasesClient.RequestOptions

client.useCases.getUseCaseDemoBuildLogs(id) -> HubPlatform.LogEntry[]

Description ​

Get the build logs for the demo of a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.getUseCaseDemoBuildLogs("id");

Parameters ​

id: string — The unique ID of a use case.

requestOptions: UseCasesClient.RequestOptions

client.useCases.getLinkedAlgorithmsByUseCase(id) -> HubPlatform.AlgorithmDto[]

Description ​

Get all algorithms linked to a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.getLinkedAlgorithmsByUseCase("id");

Parameters ​

id: string — The unique ID of a use case.

requestOptions: UseCasesClient.RequestOptions

client.useCases.removeUseCaseAccessPermission(id, sid) -> void

Description ​

Remove an access permission from a specific use case (identified by its ID).

Usage ​

typescript
await client.useCases.removeUseCaseAccessPermission("id", "sid");

Parameters ​

id: string — The unique ID of a use case.

sid: string — The security identifier (user SID or organization SID) of the permission holder to remove.

requestOptions: UseCasesClient.RequestOptions

Services ​

client.services.updateServiceSummary(id, { ...params }) -> void

Description ​

Update the summary of a service.

Usage ​

typescript
await client.services.updateServiceSummary("id", {
    summary: "summary"
});

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.UpdateServiceSummaryRequest

requestOptions: ServicesClient.RequestOptions

client.services.updateServicePublication(id, { ...params }) -> void

Description ​

Publish a service. scope=PUBLIC publishes to the marketplace; scope=INTERNAL publishes within the organization only. Idempotent: calling twice with the same scope has no effect.

Usage ​

typescript
await client.services.updateServicePublication("id", {
    scope: "PUBLIC"
});

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.PublicationRequest

requestOptions: ServicesClient.RequestOptions

client.services.deleteServicePublication(id, { ...params }) -> void

Description ​

Unpublishes the service (lifecycle → CREATED). Idempotent. Fails with 409 if the service has active subscriptions or use-case relations unless force=true.

Usage ​

typescript
await client.services.deleteServicePublication("id");

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.DeleteServicePublicationRequest

requestOptions: ServicesClient.RequestOptions

client.services.getServiceOpenApi(id, { ...params }) -> string

Description ​

Get the OpenAPI specification of a service.

Usage ​

typescript
await client.services.getServiceOpenApi("id");

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.GetServiceOpenApiRequest

requestOptions: ServicesClient.RequestOptions

client.services.updateServiceOpenApi(id, { ...params }) -> void

Description ​

Update the OpenAPI specification of a service (multipart/form-data). Accepts binary file upload (multipart/form-data).

Usage ​

typescript
await client.services.updateServiceOpenApi("id", {
    file: fs.createReadStream("/path/to/your/file")
});

Parameters ​

id: string

request: HubPlatform.UpdateServiceOpenApiRequest

requestOptions: ServicesClient.RequestOptions

client.services.updateServiceLinks(id, { ...params }) -> void

Description ​

Replace the links of a service. Pass an empty array to clear links.

Usage ​

typescript
await client.services.updateServiceLinks("id", [{
        type: "TERMS_OF_SERVICE",
        name: "API Documentation",
        url: "https://docs.example.com"
    }]);

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.ServiceLink[]

requestOptions: ServicesClient.RequestOptions

client.services.updateServiceDisplayName(id, { ...params }) -> void

Description ​

Update the display name of a service.

Usage ​

typescript
await client.services.updateServiceDisplayName("id", {
    displayName: "displayName"
});

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.UpdateServiceDisplayNameRequest

requestOptions: ServicesClient.RequestOptions

client.services.updateServiceDescription(id, { ...params }) -> void

Description ​

Update the description of a service.

Usage ​

typescript
await client.services.updateServiceDescription("id", {
    description: "description"
});

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.UpdateServiceDescriptionRequest

requestOptions: ServicesClient.RequestOptions

client.services.updateServiceContacts(id, { ...params }) -> void

Description ​

Replace the contact list of a service. Pass an empty array to clear contacts.

Usage ​

typescript
await client.services.updateServiceContacts("id", [{
        type: "EMAIL",
        contact: "support@example.com"
    }]);

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.ServiceContact[]

requestOptions: ServicesClient.RequestOptions

client.services.getServices({ ...params }) -> HubPlatform.ServiceOverviewDto[]

Description ​

Get a list of all services, optionally filtered by lifecycle.

Usage ​

typescript
await client.services.getServices();

Parameters ​

request: HubPlatform.GetServicesRequest

requestOptions: ServicesClient.RequestOptions

client.services.getService(id) -> HubPlatform.ServiceDto

Description ​

Get a specific service (identified by its ID).

Usage ​

typescript
await client.services.getService("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: ServicesClient.RequestOptions

client.services.deleteService(id) -> void

Description ​

Delete a service (identified by its ID).

Usage ​

typescript
await client.services.deleteService("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: ServicesClient.RequestOptions

client.services.getServiceSubscriptions(id) -> HubPlatform.SubscriptionDto[]

Description ​

Get active subscriptions for a service.

Usage ​

typescript
await client.services.getServiceSubscriptions("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: ServicesClient.RequestOptions

client.services.getServiceStatistics(id) -> HubPlatform.ServiceStatistics

Description ​

Get usage statistics for a specific service, including star count, subscription count, and execution statistics (total, this month, last month, last three months).

Usage ​

typescript
await client.services.getServiceStatistics("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: ServicesClient.RequestOptions

client.services.checkServiceNameAvailability({ ...params }) -> boolean

Description ​

Check whether a service name is available (not yet taken).

Usage ​

typescript
await client.services.checkServiceNameAvailability({
    name: "name"
});

Parameters ​

request: HubPlatform.CheckServiceNameAvailabilityRequest

requestOptions: ServicesClient.RequestOptions

Service Shares ​

client.serviceShares.updateServiceShareRole(id, shareId, { ...params }) -> HubPlatform.ShareDto

Description ​

Update the role of an existing service share.

Usage ​

typescript
await client.serviceShares.updateServiceShareRole("id", "shareId", {});

Parameters ​

id: string — The unique ID of a service.

shareId: string — The unique ID of a resource share.

request: HubPlatform.UpdateResourceShareRoleDto

requestOptions: ServiceSharesClient.RequestOptions

client.serviceShares.deleteServiceShare(id, shareId) -> void

Description ​

Revoke a share that was previously granted on a service. This removes the shared access for the target tenant. Requires GRANT permission on the service.

Usage ​

typescript
await client.serviceShares.deleteServiceShare("id", "shareId");

Parameters ​

id: string — The unique ID of a service.

shareId: string — The unique ID of a resource share.

requestOptions: ServiceSharesClient.RequestOptions

client.serviceShares.updateServiceShareConstraint(id, shareId, constraintId, { ...params }) -> HubPlatform.TimeBasedConstraintDto

Description ​

Update an existing constraint on a service share.

Usage ​

typescript
await client.serviceShares.updateServiceShareConstraint("id", "shareId", "constraintId", {
    validFrom: "validFrom",
    validUntil: "validUntil",
    type: "TIME_BASED"
});

Parameters ​

id: string — The unique ID of a service.

shareId: string — The unique ID of a resource share.

constraintId: string — The unique ID of a share constraint.

request: HubPlatform.TimeBasedConstraintDto

requestOptions: ServiceSharesClient.RequestOptions

client.serviceShares.deleteServiceShareConstraint(id, shareId, constraintId) -> void

Description ​

Delete an existing constraint on a service share.

Usage ​

typescript
await client.serviceShares.deleteServiceShareConstraint("id", "shareId", "constraintId");

Parameters ​

id: string — The unique ID of a service.

shareId: string — The unique ID of a resource share.

constraintId: string — The unique ID of a share constraint.

requestOptions: ServiceSharesClient.RequestOptions

client.serviceShares.getSharesForService(id) -> HubPlatform.ShareDto[]

Description ​

List all shares for a given service.

Usage ​

typescript
await client.serviceShares.getSharesForService("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: ServiceSharesClient.RequestOptions

client.serviceShares.shareService(id, { ...params }) -> HubPlatform.ShareDto

Description ​

Share a service with other tenants.

Usage ​

typescript
await client.serviceShares.shareService("id", {});

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.CreateShareRequestDto

requestOptions: ServiceSharesClient.RequestOptions

client.serviceShares.addServiceShareConstraint(id, shareId, { ...params }) -> HubPlatform.TimeBasedConstraintDto

Description ​

Add a new constraint to an existing service share.

Usage ​

typescript
await client.serviceShares.addServiceShareConstraint("id", "shareId", {
    validFrom: "validFrom",
    validUntil: "validUntil",
    type: "TIME_BASED"
});

Parameters ​

id: string — The unique ID of a service.

shareId: string — The unique ID of a resource share.

request: HubPlatform.CreateTimeBasedConstraintDto

requestOptions: ServiceSharesClient.RequestOptions

Service Executions ​

client.serviceExecutions.cancelServiceExecution(id) -> void

Description ​

Cancel a specific service execution (identified by its ID). Only service executions that are pending or currently running can be cancelled.

Usage ​

typescript
await client.serviceExecutions.cancelServiceExecution("id");

Parameters ​

id: string — The unique ID of a service execution.

requestOptions: ServiceExecutionsClient.RequestOptions

client.serviceExecutions.getServiceExecution(id) -> HubPlatform.GetServiceExecutionResponse

Description ​

Get a specific service execution (identified by its ID), either a managed or workflow service execution. The response type depends on the underlying service execution type: A workflow service execution returns the type WorkflowServiceExecutionDto and managed service execution returns the type ServiceExecutionDto.

Usage ​

typescript
await client.serviceExecutions.getServiceExecution("id");

Parameters ​

id: string — The unique ID of a service execution.

requestOptions: ServiceExecutionsClient.RequestOptions

client.serviceExecutions.headServiceExecution(id) -> Headers

Description ​

Check if the tenant has view permission for a specific service execution (identified by its ID).

Usage ​

typescript
await client.serviceExecutions.headServiceExecution("id");

Parameters ​

id: string — The unique ID of a service execution.

requestOptions: ServiceExecutionsClient.RequestOptions

client.serviceExecutions.getServiceExecutions({ ...params }) -> HubPlatform.PageResponseServiceExecutionDto

Description ​

Get all service executions with pagination support. Optionally filter by applicationId, serviceId, tags, IDs, and creation date range. Supports sorting by: createdAt, startedAt, endedAt, status, serviceId, applicationId. Default sort is createdAt descending (newest first).

Usage ​

typescript
await client.serviceExecutions.getServiceExecutions();

Parameters ​

request: HubPlatform.GetServiceExecutionsRequest

requestOptions: ServiceExecutionsClient.RequestOptions

client.serviceExecutions.getServiceExecutionResult(id) -> Record<string, any> | undefined

Description ​

Get the results for a specific service execution (identified by its ID). If the service execution has not been completed yet or no results are available, a HTTP 204 (No Content) response is returned with a "Retry-After" header.

Usage ​

typescript
await client.serviceExecutions.getServiceExecutionResult("id");

Parameters ​

id: string — The unique ID of a service execution.

requestOptions: ServiceExecutionsClient.RequestOptions

client.serviceExecutions.getServiceExecutionResultFile(id) -> core.BinaryResponse

Description ​

Download a specific result file from a service execution. The file path is specified as a sub-path after /results/, e.g., /service-executions/{id}/results/output.json to download the file output.json from the service output. Returns binary file content (not JSON).

Usage ​

typescript
await client.serviceExecutions.getServiceExecutionResultFile("id");

Parameters ​

id: string — The unique ID of a service execution.

requestOptions: ServiceExecutionsClient.RequestOptions

client.serviceExecutions.getServiceExecutionObservabilityFiles(id) -> Record<string, any> | undefined

Description ​

Get the list of observability files for a specific service execution (identified by its ID). Only accessible by service owners and creators with at least VIEWER role on the service.

Usage ​

typescript
await client.serviceExecutions.getServiceExecutionObservabilityFiles("id");

Parameters ​

id: string — The unique ID of a service execution.

requestOptions: ServiceExecutionsClient.RequestOptions

client.serviceExecutions.getServiceExecutionObservabilityFile(id, filename) -> core.BinaryResponse

Description ​

Download a specific observability file for a service execution. Only accessible by service owners and creators with at least VIEWER role on the service. Returns binary file content (not JSON).

Usage ​

typescript
await client.serviceExecutions.getServiceExecutionObservabilityFile("id", "filename");

Parameters ​

id: string — The unique ID of a service execution.

filename: string — The name of the observability file to download (as listed by the observability files endpoint).

requestOptions: ServiceExecutionsClient.RequestOptions

client.serviceExecutions.getServiceExecutionMetrics(id) -> HubPlatform.ServiceExecutionMetrics

Description ​

Get the resource usage metrics for a specific service execution (identified by its ID).

Usage ​

typescript
await client.serviceExecutions.getServiceExecutionMetrics("id");

Parameters ​

id: string — The unique ID of a service execution.

requestOptions: ServiceExecutionsClient.RequestOptions

client.serviceExecutions.getServiceExecutionLogs(id, { ...params }) -> HubPlatform.ServiceExecutionLogs | undefined

Description ​

Get the logs for a specific service execution (identified by its ID). If the service execution has not started yet or no logs are available, a HTTP 204 (No Content) response is returned with a "Retry-After" header. Use the optional 'limit' query parameter to retrieve only the last X log messages. Use the optional 'raw' parameter to download logs as plain text instead of JSON.

Usage ​

typescript
await client.serviceExecutions.getServiceExecutionLogs("id");

Parameters ​

id: string — The unique ID of a service execution.

request: HubPlatform.GetServiceExecutionLogsRequest

requestOptions: ServiceExecutionsClient.RequestOptions

client.serviceExecutions.getServiceExecutionLineage(id) -> HubPlatform.ServiceExecutionLineage

Description ​

Get the service execution (identified by its ID) together with all service executions transitively triggered beneath it, as a flat list of lineage nodes ordered by creation time ascending. A caller who can access the given service execution can see its full descendant subtree in full detail, including descendants running under other tenants' applications the caller otherwise has no permission on. The response is capped at a configured maximum number of nodes; when the lineage exceeds that cap, 'truncated' is set to true and only the shallowest (breadth-first) nodes are returned.

Usage ​

typescript
await client.serviceExecutions.getServiceExecutionLineage("id");

Parameters ​

id: string — The unique ID of a service execution.

requestOptions: ServiceExecutionsClient.RequestOptions

client.serviceExecutions.getServiceExecutionCosts(id) -> HubPlatform.CostEntry[] | undefined

Description ​

Get the costs for a specific service execution (identified by its ID). If the service execution has not started yet or no costs are available, a HTTP 204 (No Content) response is returned with a "Retry-After" header.

Usage ​

typescript
await client.serviceExecutions.getServiceExecutionCosts("id");

Parameters ​

id: string — The unique ID of a service execution.

requestOptions: ServiceExecutionsClient.RequestOptions

Organizations ​

client.organizations.getOrganization(id) -> HubPlatform.OrganizationDto

Description ​

Get an organization by its ID.

Usage ​

typescript
await client.organizations.getOrganization("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: OrganizationsClient.RequestOptions

client.organizations.updateOrganization(id, { ...params }) -> HubPlatform.OrganizationDto

Description ​

Update the display name and description of an existing organization. Requires OWNER or MAINTAINER role on the organization.

Usage ​

typescript
await client.organizations.updateOrganization("id", {
    displayName: "Acme Quantum Labs"
});

Parameters ​

id: string — The unique ID of an organization.

request: HubPlatform.UpdateOrganizationRequest

requestOptions: OrganizationsClient.RequestOptions

client.organizations.deleteOrganization(id) -> void

Description ​

Delete an organization by its ID.

Usage ​

typescript
await client.organizations.deleteOrganization("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: OrganizationsClient.RequestOptions

client.organizations.getOrganizationProviderToken(id, type) -> HubPlatform.ProviderToken

Description ​

Get the provider token of a given type for the organization.

Usage ​

typescript
await client.organizations.getOrganizationProviderToken("id", "type");

Parameters ​

id: string — The unique ID of an organization.

type: string — The quantum provider identifier (e.g., DWAVE, AZURE, AWS, or IBM).

requestOptions: OrganizationsClient.RequestOptions

client.organizations.updateOrganizationProviderToken(id, type, { ...params }) -> void

Description ​

Set or update a provider token for the organization.

Usage ​

typescript
await client.organizations.updateOrganizationProviderToken("id", "type", {
    "key": "value"
});

Parameters ​

id: string — The unique ID of an organization.

type: string — The quantum provider identifier (e.g., DWAVE, AZURE, AWS, or IBM).

request: Record<string, any>

requestOptions: OrganizationsClient.RequestOptions

client.organizations.deleteOrganizationProviderToken(id, type) -> void

Description ​

Delete a provider token for the organization.

Usage ​

typescript
await client.organizations.deleteOrganizationProviderToken("id", "type");

Parameters ​

id: string — The unique ID of an organization.

type: string — The quantum provider identifier (e.g., DWAVE, AZURE, AWS, or IBM).

requestOptions: OrganizationsClient.RequestOptions

client.organizations.getOrganizationMember(id, userId) -> HubPlatform.MemberDto

Description ​

Get a specific member of an organization.

Usage ​

typescript
await client.organizations.getOrganizationMember("id", "userId");

Parameters ​

id: string — The unique ID of an organization.

userId: string — The unique ID of a user.

requestOptions: OrganizationsClient.RequestOptions

client.organizations.updateOrganizationMemberPermission(id, userId, { ...params }) -> HubPlatform.AccessPermissionDto

Description ​

Update the permission role of a member in an organization.

Usage ​

typescript
await client.organizations.updateOrganizationMemberPermission("id", "userId", {});

Parameters ​

id: string — The unique ID of an organization.

userId: string — The unique ID of a user.

request: HubPlatform.AccessPermissionDto

requestOptions: OrganizationsClient.RequestOptions

client.organizations.deleteOrganizationMember(id, userId) -> void

Description ​

Delete a member from an organization.

Usage ​

typescript
await client.organizations.deleteOrganizationMember("id", "userId");

Parameters ​

id: string — The unique ID of an organization.

userId: string — The unique ID of a user.

requestOptions: OrganizationsClient.RequestOptions

client.organizations.getOrganizations() -> HubPlatform.OrganizationDto[]

Description ​

Get all organizations visible to the current user.

Usage ​

typescript
await client.organizations.getOrganizations();

Parameters ​

requestOptions: OrganizationsClient.RequestOptions

client.organizations.createOrganization({ ...params }) -> HubPlatform.OrganizationDto

Description ​

Create a new organization. The calling user becomes the owner of the organization. Organizations allow multiple users to collaborate on shared resources such as services, algorithms, and applications. A billing email is required for invoicing purposes.

Usage ​

typescript
await client.organizations.createOrganization({
    displayName: "Acme Quantum Labs",
    billingEmail: "billing@acme.com"
});

Parameters ​

request: HubPlatform.CreateOrganizationRequest

requestOptions: OrganizationsClient.RequestOptions

client.organizations.getOrganizationMembers(id) -> HubPlatform.MemberDto[]

Description ​

Get all members of an organization.

Usage ​

typescript
await client.organizations.getOrganizationMembers("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: OrganizationsClient.RequestOptions

client.organizations.addOrganizationMember(id, { ...params }) -> HubPlatform.AccessPermissionDto

Description ​

Add a member to an organization.

Usage ​

typescript
await client.organizations.addOrganizationMember("id", {});

Parameters ​

id: string — The unique ID of an organization.

request: HubPlatform.AccessPermissionDto

requestOptions: OrganizationsClient.RequestOptions

client.organizations.getOrganizationImage(id) -> core.BinaryResponse

Description ​

Get the profile image of an organization. Returns binary image content (not JSON).

Usage ​

typescript
await client.organizations.getOrganizationImage("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: OrganizationsClient.RequestOptions

client.organizations.updateOrganizationImage(id, { ...params }) -> void

Description ​

Update the profile image of an organization. Accepts binary file upload (multipart/form-data).

Usage ​

typescript
await client.organizations.updateOrganizationImage("id", {
    file: "file"
});

Parameters ​

id: string — The unique ID of an organization.

request: HubPlatform.UpdateOrganizationImageRequest

requestOptions: OrganizationsClient.RequestOptions

client.organizations.deleteOrganizationImage(id) -> void

Description ​

Remove the profile image of an organization, so that it falls back to its initials. Requires OWNER role on the organization.

Usage ​

typescript
await client.organizations.deleteOrganizationImage("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: OrganizationsClient.RequestOptions

client.organizations.getOrganizationProviderTokenAvailability(id) -> Record<string, boolean>

Description ​

Check which quantum provider tokens are configured for the organization.

Usage ​

typescript
await client.organizations.getOrganizationProviderTokenAvailability("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: OrganizationsClient.RequestOptions

client.organizations.getOrganizationProfile(id) -> HubPlatform.OrganizationProfileDto

Description ​

Get the public profile of an organization by its ID. Accessible by any authenticated user.

Usage ​

typescript
await client.organizations.getOrganizationProfile("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: OrganizationsClient.RequestOptions

client.organizations.searchOrganizations({ ...params }) -> HubPlatform.OrganizationSearchResultDto[]

Description ​

Search organizations by name or description. The query parameter 'q' is required, must be at least 3 characters long, contain at least one alphanumeric character, and supports wildcards but not special characters.

Usage ​

typescript
await client.organizations.searchOrganizations({
    q: "q"
});

Parameters ​

request: HubPlatform.SearchOrganizationsRequest

requestOptions: OrganizationsClient.RequestOptions

Billing ​

client.billing.getOrganizationAllowanceConfiguration(id) -> HubPlatform.PayAsYouGoAllowanceConfigurationDto | undefined

Description ​

Get the Pay-as-you-go Allowance configuration for an organization.

Usage ​

typescript
await client.billing.getOrganizationAllowanceConfiguration("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: BillingClient.RequestOptions

client.billing.updateOrganizationAllowanceConfiguration(id, { ...params }) -> HubPlatform.PayAsYouGoAllowanceConfigurationDto

Description ​

Set or update the Pay-as-you-go Allowance configuration for an organization.

Usage ​

typescript
await client.billing.updateOrganizationAllowanceConfiguration("id", {
    allowance: {
        amount: "1.50",
        currency: "EUR"
    }
});

Parameters ​

id: string — The unique ID of an organization.

request: HubPlatform.UpdatePayAsYouGoAllowanceRequest

requestOptions: BillingClient.RequestOptions

client.billing.deleteOrganizationAllowanceConfiguration(id) -> void

Description ​

Delete the Pay-as-you-go Allowance configuration for an organization.

Usage ​

typescript
await client.billing.deleteOrganizationAllowanceConfiguration("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: BillingClient.RequestOptions

client.billing.getUserAllowanceConfiguration() -> HubPlatform.PayAsYouGoAllowanceConfigurationDto | undefined

Description ​

Get the current user's Pay-as-you-go Allowance configuration.

Usage ​

typescript
await client.billing.getUserAllowanceConfiguration();

Parameters ​

requestOptions: BillingClient.RequestOptions

client.billing.updateUserAllowanceConfiguration({ ...params }) -> HubPlatform.PayAsYouGoAllowanceConfigurationDto

Description ​

Update the current user's Pay-as-you-go Allowance configuration.

Usage ​

typescript
await client.billing.updateUserAllowanceConfiguration({
    allowance: {
        amount: "1.50",
        currency: "EUR"
    }
});

Parameters ​

request: HubPlatform.UpdatePayAsYouGoAllowanceRequest

requestOptions: BillingClient.RequestOptions

client.billing.deleteUserAllowanceConfiguration() -> void

Description ​

Delete the current user's Pay-as-you-go Allowance configuration.

Usage ​

typescript
await client.billing.deleteUserAllowanceConfiguration();

Parameters ​

requestOptions: BillingClient.RequestOptions

client.billing.getBudget() -> HubPlatform.BudgetDto | undefined

Description ​

Get the windowed budget for the calling tenant.

Usage ​

typescript
await client.billing.getBudget();

Parameters ​

requestOptions: BillingClient.RequestOptions

client.billing.updateBudget({ ...params }) -> HubPlatform.BudgetDto

Description ​

Set or update the windowed budget for the calling tenant. Organization writes require OWNER.

Usage ​

typescript
await client.billing.updateBudget({
    amount: {
        amount: "1.50",
        currency: "EUR"
    },
    windowMode: "FIXED",
    anchor: "anchor",
    enforcement: "HARD"
});

Parameters ​

request: HubPlatform.UpdateBudgetRequest

requestOptions: BillingClient.RequestOptions

client.billing.deleteBudget() -> void

Description ​

Delete the windowed budget for the calling tenant. Organization writes require OWNER.

Usage ​

typescript
await client.billing.deleteBudget();

Parameters ​

requestOptions: BillingClient.RequestOptions

client.billing.createAccountLink(id, { ...params }) -> HubPlatform.RevenueAccountLink

Description ​

Create a Stripe Express link for the organization's revenue account, provisioning the account on demand. Requires the caller to be an OWNER of the organization. Returns an onboarding link if account setup is not yet complete, or a dashboard link once the account is active.

Usage ​

typescript
await client.billing.createAccountLink("id", {
    refreshUrl: "https://hub.kipu-quantum.com/settings/billing/revenue/onboarding/refresh",
    returnUrl: "https://hub.kipu-quantum.com/settings/billing/revenue/onboarding/return"
});

Parameters ​

id: string — The unique ID of an organization.

request: HubPlatform.CreateRevenueAccountLinkRequest

requestOptions: BillingClient.RequestOptions

client.billing.createPlatformSubscriptionCheckout(id, { ...params }) -> HubPlatform.PlatformSubscriptionCheckoutSessionDto

Description ​

Initiates a Stripe Checkout flow (mode=subscription) for purchasing a Platform Subscription for the organization. Requires the caller to be an OWNER of the organization. The returned checkoutUrl must be opened in the user's browser to complete payment.

Usage ​

typescript
await client.billing.createPlatformSubscriptionCheckout("id", {});

Parameters ​

id: string — The unique ID of an organization.

request: HubPlatform.CreatePlatformSubscriptionRequestDto

requestOptions: BillingClient.RequestOptions

client.billing.createPortalLink(id, { ...params }) -> HubPlatform.BillingPortalLink

Description ​

Create a Stripe Billing Portal session for an organization and return its URL.

Usage ​

typescript
await client.billing.createPortalLink("id", {
    returnUrl: "https://hub.kipu-quantum.com/billing/portal/success"
});

Parameters ​

id: string — The unique ID of an organization.

request: HubPlatform.CreateBillingPortalSessionRequest

requestOptions: BillingClient.RequestOptions

client.billing.createCreditsCheckout(id, { ...params }) -> HubPlatform.CreditTopUpSessionDto

Description ​

Initiates a Stripe Checkout flow for buying prepaid platform credits for the organization. Requires the caller to be an OWNER of the organization. The returned checkoutUrl must be opened in the user's browser to complete payment.

Usage ​

typescript
await client.billing.createCreditsCheckout("id", {});

Parameters ​

id: string — The unique ID of an organization.

request: HubPlatform.CreateCreditTopUpRequestDto

requestOptions: BillingClient.RequestOptions

client.billing.createAccountLink1({ ...params }) -> HubPlatform.RevenueAccountLink

Description ​

Create a Stripe Express link for the current user's revenue account, provisioning the account on demand. Returns an onboarding link if account setup is not yet complete, or a dashboard link once the account is active.

Usage ​

typescript
await client.billing.createAccountLink1({
    refreshUrl: "https://hub.kipu-quantum.com/settings/billing/revenue/onboarding/refresh",
    returnUrl: "https://hub.kipu-quantum.com/settings/billing/revenue/onboarding/return"
});

Parameters ​

request: HubPlatform.CreateRevenueAccountLinkRequest

requestOptions: BillingClient.RequestOptions

client.billing.createPlatformSubscriptionCheckout1({ ...params }) -> HubPlatform.PlatformSubscriptionCheckoutSessionDto

Description ​

Initiates a Stripe Checkout flow (mode=subscription) for purchasing a Platform Subscription for the current user. The returned checkoutUrl must be opened in the user's browser to complete payment.

Usage ​

typescript
await client.billing.createPlatformSubscriptionCheckout1({});

Parameters ​

request: HubPlatform.CreatePlatformSubscriptionRequestDto

requestOptions: BillingClient.RequestOptions

client.billing.createPortalLink1({ ...params }) -> HubPlatform.BillingPortalLink

Description ​

Create a Stripe Billing Portal session for the current user and return its URL.

Usage ​

typescript
await client.billing.createPortalLink1({
    returnUrl: "https://hub.kipu-quantum.com/billing/portal/success"
});

Parameters ​

request: HubPlatform.CreateBillingPortalSessionRequest

requestOptions: BillingClient.RequestOptions

client.billing.createCreditsCheckout1({ ...params }) -> HubPlatform.CreditTopUpSessionDto

Description ​

Initiates a Stripe Checkout flow for buying prepaid platform credits for the current user. The returned checkoutUrl must be opened in the user's browser to complete payment.

Usage ​

typescript
await client.billing.createCreditsCheckout1({});

Parameters ​

request: HubPlatform.CreateCreditTopUpRequestDto

requestOptions: BillingClient.RequestOptions

client.billing.getOrganizationRevenue(id, { ...params }) -> HubPlatform.RevenueReportDto[]

Description ​

Get the revenue earned by an organization as a service provider, broken down by period at the requested granularity. from and to are ISO-8601 instants; granularity defaults to MONTH.

Usage ​

typescript
await client.billing.getOrganizationRevenue("id", {
    from: "2024-01-15T09:30:00Z",
    to: "2024-01-15T09:30:00Z"
});

Parameters ​

id: string — The unique ID of an organization.

request: HubPlatform.GetOrganizationRevenueRequest

requestOptions: BillingClient.RequestOptions

client.billing.getRevenueAccount(id) -> HubPlatform.RevenueAccountDto

Description ​

Get the revenue account for an organization.

Usage ​

typescript
await client.billing.getRevenueAccount("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: BillingClient.RequestOptions

client.billing.deleteRevenueAccount(id) -> void

Description ​

Delete the revenue account for an organization.

Usage ​

typescript
await client.billing.deleteRevenueAccount("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: BillingClient.RequestOptions

client.billing.getPlatformSubscription(id) -> HubPlatform.PlatformSubscriptionDto | undefined

Description ​

Get the organization's current Platform Subscription (ACTIVE or CANCEL_PENDING), or 204 when there is none. Requires the caller to be at least a VIEWER of the organization. Price and renewal date are fetched live from Stripe and are null when Stripe is unreachable.

Usage ​

typescript
await client.billing.getPlatformSubscription("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: BillingClient.RequestOptions

client.billing.getOrganizationAllowanceUsage(id) -> HubPlatform.PayAsYouGoAllowanceUsageDto | undefined

Description ​

Get current Pay-as-you-go Allowance usage for an organization.

Usage ​

typescript
await client.billing.getOrganizationAllowanceUsage("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: BillingClient.RequestOptions

client.billing.getOrganizationSpendingLimitUsage(id) -> HubPlatform.SpendingLimitUsage

Description ​

Get spending limit usage for an organization.

Usage ​

typescript
await client.billing.getOrganizationSpendingLimitUsage("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: BillingClient.RequestOptions

client.billing.getOrganizationCostReport(id, { ...params }) -> HubPlatform.CostReport

Description ​

Get an aggregated cost report for an organization the caller is a member of.

Usage ​

typescript
await client.billing.getOrganizationCostReport("id", {
    from: "from",
    to: "to"
});

Parameters ​

id: string — The unique ID of an organization.

request: HubPlatform.GetOrganizationCostReportRequest

requestOptions: BillingClient.RequestOptions

client.billing.getOrganizationBillingHistory(id, { ...params }) -> HubPlatform.PageResponseBillingHistoryEntryDto

Description ​

Get the unified billing timeline of an organization the caller owns. Same query parameters and defaults as /my/billing-history.

Usage ​

typescript
await client.billing.getOrganizationBillingHistory("id");

Parameters ​

id: string — The unique ID of an organization.

request: HubPlatform.GetOrganizationBillingHistoryRequest

requestOptions: BillingClient.RequestOptions

client.billing.getBillingAccount(id) -> HubPlatform.BillingAccountDto

Description ​

Get the billing account for an organization.

Usage ​

typescript
await client.billing.getBillingAccount("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: BillingClient.RequestOptions

client.billing.getOrganizationBalance(id) -> HubPlatform.TenantBalanceDto

Description ​

Get the ledger balance of an organization the caller is a member of.

Usage ​

typescript
await client.billing.getOrganizationBalance("id");

Parameters ​

id: string — The unique ID of an organization.

requestOptions: BillingClient.RequestOptions

client.billing.getMyRevenue({ ...params }) -> HubPlatform.RevenueReportDto[]

Description ​

Get the revenue earned by the current user as a service provider, broken down by period at the requested granularity. from and to are ISO-8601 instants; granularity defaults to MONTH.

Usage ​

typescript
await client.billing.getMyRevenue({
    from: "2024-01-15T09:30:00Z",
    to: "2024-01-15T09:30:00Z"
});

Parameters ​

request: HubPlatform.GetMyRevenueRequest

requestOptions: BillingClient.RequestOptions

client.billing.getRevenueAccount1() -> HubPlatform.RevenueAccountDto

Description ​

Get the current user's revenue account.

Usage ​

typescript
await client.billing.getRevenueAccount1();

Parameters ​

requestOptions: BillingClient.RequestOptions

client.billing.deleteRevenueAccount1() -> void

Description ​

Delete the current user's revenue account.

Usage ​

typescript
await client.billing.deleteRevenueAccount1();

Parameters ​

requestOptions: BillingClient.RequestOptions

client.billing.getPlatformSubscription1() -> HubPlatform.PlatformSubscriptionDto | undefined

Description ​

Get the current user's current Platform Subscription (ACTIVE or CANCEL_PENDING), or 204 when there is none. Price and renewal date are fetched live from Stripe and are null when Stripe is unreachable.

Usage ​

typescript
await client.billing.getPlatformSubscription1();

Parameters ​

requestOptions: BillingClient.RequestOptions

client.billing.getUserAllowanceUsage() -> HubPlatform.PayAsYouGoAllowanceUsageDto | undefined

Description ​

Get the current user's Pay-as-you-go Allowance usage.

Usage ​

typescript
await client.billing.getUserAllowanceUsage();

Parameters ​

requestOptions: BillingClient.RequestOptions

client.billing.getUserSpendingLimitUsage() -> HubPlatform.SpendingLimitUsage

Description ​

Get the current user's spending limit usage.

Usage ​

typescript
await client.billing.getUserSpendingLimitUsage();

Parameters ​

requestOptions: BillingClient.RequestOptions

client.billing.getMyCostReport({ ...params }) -> HubPlatform.CostReport

Description ​

Get an aggregated cost report (total, time-series buckets, optional breakdown).

Usage ​

typescript
await client.billing.getMyCostReport({
    from: "from",
    to: "to"
});

Parameters ​

request: HubPlatform.GetMyCostReportRequest

requestOptions: BillingClient.RequestOptions

client.billing.getMyBillingHistory({ ...params }) -> HubPlatform.PageResponseBillingHistoryEntryDto

Description ​

Get the current user's unified billing timeline (credits, credit/debit adjustments, recorded invoices, daily usage rollups) within the requested period. from and to are ISO-8601 instants and default to the last 90 days. type is optional and may be repeated to filter by multiple entry types. Pagination defaults to 50 items per page sorted by occurredAt descending.

Usage ​

typescript
await client.billing.getMyBillingHistory();

Parameters ​

request: HubPlatform.GetMyBillingHistoryRequest

requestOptions: BillingClient.RequestOptions

client.billing.getBillingAccount1() -> HubPlatform.BillingAccountDto

Description ​

Get the current user's billing account, creating it if it does not exist.

Usage ​

typescript
await client.billing.getBillingAccount1();

Parameters ​

requestOptions: BillingClient.RequestOptions

client.billing.getMyBalance() -> HubPlatform.TenantBalanceDto

Description ​

Get the current user's ledger balance, derived from credits, credit adjustments, debit adjustments, and recorded invoices.

Usage ​

typescript
await client.billing.getMyBalance();

Parameters ​

requestOptions: BillingClient.RequestOptions

client.billing.getBudgetUsage() -> HubPlatform.BudgetUsage | undefined

Description ​

Get budget usage for the calling tenant's current window.

Usage ​

typescript
await client.billing.getBudgetUsage();

Parameters ​

requestOptions: BillingClient.RequestOptions

Users ​

client.users.getUserProviderToken(type) -> HubPlatform.ProviderToken

Description ​

Get the provider token of a given type for the current user.

Usage ​

typescript
await client.users.getUserProviderToken("type");

Parameters ​

type: string — The quantum provider identifier (e.g., DWAVE, AZURE, AWS, or IBM).

requestOptions: UsersClient.RequestOptions

client.users.updateUserProviderToken(type, { ...params }) -> void

Description ​

Set or update a provider token for the current user.

Usage ​

typescript
await client.users.updateUserProviderToken("type", {
    "key": "value"
});

Parameters ​

type: string — The quantum provider identifier (e.g., DWAVE, AZURE, AWS, or IBM).

request: Record<string, any>

requestOptions: UsersClient.RequestOptions

client.users.deleteUserProviderToken(type) -> void

Description ​

Delete a provider token for the current user.

Usage ​

typescript
await client.users.deleteUserProviderToken("type");

Parameters ​

type: string — The quantum provider identifier (e.g., DWAVE, AZURE, AWS, or IBM).

requestOptions: UsersClient.RequestOptions

client.users.declineInvitation(invitationId) -> void

Description ​

Decline an organization invitation.

Usage ​

typescript
await client.users.declineInvitation("invitationId");

Parameters ​

invitationId: string — The unique ID of an invitation.

requestOptions: UsersClient.RequestOptions

client.users.acceptInvitation(invitationId) -> void

Description ​

Accept an organization invitation.

Usage ​

typescript
await client.users.acceptInvitation("invitationId");

Parameters ​

invitationId: string — The unique ID of an invitation.

requestOptions: UsersClient.RequestOptions

client.users.getUserProviderTokenAvailability() -> Record<string, boolean>

Description ​

Check which quantum provider tokens are configured for the current user.

Usage ​

typescript
await client.users.getUserProviderTokenAvailability();

Parameters ​

requestOptions: UsersClient.RequestOptions

client.users.getMyInvitations() -> HubPlatform.InvitationDto[]

Description ​

Get all pending organization invitations for the current user.

Usage ​

typescript
await client.users.getMyInvitations();

Parameters ​

requestOptions: UsersClient.RequestOptions

client.users.getMyAccounts() -> HubPlatform.AccountDto[]

Description ​

Get all accounts visible to the current user.

Usage ​

typescript
await client.users.getMyAccounts();

Parameters ​

requestOptions: UsersClient.RequestOptions

User Notifications ​

client.userNotifications.markNotificationAsRead(notificationId) -> void

Description ​

Mark a single notification as read for the current user. This is idempotent, marking an already-read notification has no effect.

Usage ​

typescript
await client.userNotifications.markNotificationAsRead("notificationId");

Parameters ​

notificationId: string — The unique ID of a user notification.

requestOptions: UserNotificationsClient.RequestOptions

client.userNotifications.markAllNotificationsAsRead() -> void

Description ​

Mark all notifications as read.

Usage ​

typescript
await client.userNotifications.markAllNotificationsAsRead();

Parameters ​

requestOptions: UserNotificationsClient.RequestOptions

client.userNotifications.getMyNotifications({ ...params }) -> HubPlatform.PageResponseUserNotificationDto

Description ​

Get the current user's notifications.

Usage ​

typescript
await client.userNotifications.getMyNotifications();

Parameters ​

request: HubPlatform.GetMyNotificationsRequest

requestOptions: UserNotificationsClient.RequestOptions

client.userNotifications.getMyUnreadNotificationCount() -> number

Description ​

Get the current user's unread notification count.

Usage ​

typescript
await client.userNotifications.getMyUnreadNotificationCount();

Parameters ​

requestOptions: UserNotificationsClient.RequestOptions

Managed Services ​

client.managedServices.downloadManagedServiceSource(id) -> core.BinaryResponse

Description ​

Download the source code of a managed service. Returns binary content (not JSON).

Usage ​

typescript
await client.managedServices.downloadManagedServiceSource("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: ManagedServicesClient.RequestOptions

client.managedServices.updateManagedServiceSource(id, { ...params }) -> void

Description ​

Update the source reference (repository URL or registry image) of a managed service.

Usage ​

typescript
await client.managedServices.updateManagedServiceSource("id", {
    type: "file"
});

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.UpdateManagedServiceSourceRequestBody

requestOptions: ManagedServicesClient.RequestOptions

client.managedServices.uploadManagedServiceSource(id, { ...params }) -> void

Description ​

Upload and update the source code of a managed service (binary file). Accepts binary file upload (multipart/form-data).

Usage ​

typescript
await client.managedServices.uploadManagedServiceSource("id", {
    file: fs.createReadStream("/path/to/your/file")
});

Parameters ​

id: string

request: HubPlatform.UploadManagedServiceSourceRequest

requestOptions: ManagedServicesClient.RequestOptions

client.managedServices.updateManagedServiceRuntimeConfiguration(id, { ...params }) -> void

Description ​

Update the runtime configuration of a managed service.

Usage ​

typescript
await client.managedServices.updateManagedServiceRuntimeConfiguration("id", {
    runtime: "DOCKER"
});

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.ServiceRuntimeConfiguration

requestOptions: ManagedServicesClient.RequestOptions

client.managedServices.updateManagedServiceResourceConfiguration(id, { ...params }) -> void

Description ​

Update the resource configuration of a managed service.

Usage ​

typescript
await client.managedServices.updateManagedServiceResourceConfiguration("id", {
    amount: 1000,
    unit: "m",
    type: "cpu"
});

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.UpdateManagedServiceResourceConfigurationRequestBody

requestOptions: ManagedServicesClient.RequestOptions

client.managedServices.addManagedServicePricingPlan(id, { ...params }) -> HubPlatform.PricingPlanDto

Description ​

Add or replace the pricing plan of a managed service.

Usage ​

typescript
await client.managedServices.addManagedServicePricingPlan("id", {
    type: "FREE"
});

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.CreateManagedServicePricingPlanRequest

requestOptions: ManagedServicesClient.RequestOptions

client.managedServices.deleteManagedServicePricingPlan(id) -> void

Description ​

Delete the pricing plan of a managed service.

Usage ​

typescript
await client.managedServices.deleteManagedServicePricingPlan("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: ManagedServicesClient.RequestOptions

client.managedServices.buildManagedService(id) -> void

Description ​

Trigger a build for a managed service.

Usage ​

typescript
await client.managedServices.buildManagedService("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: ManagedServicesClient.RequestOptions

client.managedServices.createManagedService({ ...params }) -> HubPlatform.ServiceDto

Description ​

Create a new managed service that is built and hosted on the platform. Requires a source (file upload, container registry, or Git repository) and optionally accepts runtime and resource configurations. The service must be built before it can be published and consumed.

Usage ​

typescript
await client.managedServices.createManagedService({
    name: "my-quantum-service",
    source: {
        type: "file"
    }
});

Parameters ​

request: HubPlatform.CreateManagedServiceRequest

requestOptions: ManagedServicesClient.RequestOptions

client.managedServices.getManagedServiceBuildStatus(id) -> HubPlatform.BuildJobDto

Description ​

Get the current build status of a managed service.

Usage ​

typescript
await client.managedServices.getManagedServiceBuildStatus("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: ManagedServicesClient.RequestOptions

client.managedServices.getManagedServiceBuildLogs(id) -> HubPlatform.LogEntry[]

Description ​

Get the build logs of a managed service.

Usage ​

typescript
await client.managedServices.getManagedServiceBuildLogs("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: ManagedServicesClient.RequestOptions

Implementations ​

client.implementations.setImplementationVisibility(id, { ...params }) -> void

Description ​

Set the visibility of an implementation (identified by its ID) to PUBLIC or PRIVATE.

Usage ​

typescript
await client.implementations.setImplementationVisibility("id", {
    type: "PRIVATE"
});

Parameters ​

id: string — The unique ID of an implementation.

request: HubPlatform.UpdateVisibilityRequest

requestOptions: ImplementationsClient.RequestOptions

client.implementations.updateImplementationSummary(id, { ...params }) -> void

Description ​

Set the summary of an implementation (identified by its ID). Pass null to clear.

Usage ​

typescript
await client.implementations.updateImplementationSummary("id");

Parameters ​

id: string — The unique ID of an implementation.

request: HubPlatform.UpdateSummaryRequest

requestOptions: ImplementationsClient.RequestOptions

client.implementations.updateImplementationAccessPermission(id, memberId, { ...params }) -> void

Description ​

Update an access permission for an implementation (identified by its ID).

Usage ​

typescript
await client.implementations.updateImplementationAccessPermission("id", "memberId", {
    role: "VIEWER"
});

Parameters ​

id: string — The unique ID of an implementation.

memberId: string — The ID of the member (user ID) whose role to update.

request: HubPlatform.UpdateMemberRequest

requestOptions: ImplementationsClient.RequestOptions

client.implementations.removeImplementationAccessPermission(id, memberId) -> void

Description ​

Remove an access permission from an implementation (identified by its ID).

Usage ​

typescript
await client.implementations.removeImplementationAccessPermission("id", "memberId");

Parameters ​

id: string — The unique ID of an implementation.

memberId: string — The ID of the member (user ID) to remove.

requestOptions: ImplementationsClient.RequestOptions

client.implementations.updateImplementationDisplayName(id, { ...params }) -> void

Description ​

Set the display name of an implementation (identified by its ID). Pass null to clear.

Usage ​

typescript
await client.implementations.updateImplementationDisplayName("id");

Parameters ​

id: string — The unique ID of an implementation.

request: HubPlatform.UpdateDisplayNameRequest

requestOptions: ImplementationsClient.RequestOptions

client.implementations.getImplementations({ ...params }) -> HubPlatform.PageResponseImplementationDto

Description ​

Get a page of implementations. The access filter selects which bucket is returned. Sorting is supported by createdAt, displayName and name; any other sort field is rejected with 400.

Usage ​

typescript
await client.implementations.getImplementations();

Parameters ​

request: HubPlatform.GetImplementationsRequest

requestOptions: ImplementationsClient.RequestOptions

client.implementations.createImplementation({ ...params }) -> HubPlatform.ImplementationDto

Description ​

Create a new implementation with a backing Git repository. Implementations contain the source code for quantum algorithms or services. The caller becomes the owner and the repository is provisioned automatically.

Usage ​

typescript
await client.implementations.createImplementation({
    name: "my-quantum-algorithm"
});

Parameters ​

request: HubPlatform.CreateImplementationRequest

requestOptions: ImplementationsClient.RequestOptions

client.implementations.getImplementationAccessPermissions(id) -> HubPlatform.AccessPermissionDto[]

Description ​

Get all access permissions for an implementation (identified by its ID).

Usage ​

typescript
await client.implementations.getImplementationAccessPermissions("id");

Parameters ​

id: string — The unique ID of an implementation.

requestOptions: ImplementationsClient.RequestOptions

client.implementations.addImplementationAccessPermission(idPathParam, { ...params }) -> void

Description ​

Add an access permission to an implementation (identified by its ID).

Usage ​

typescript
await client.implementations.addImplementationAccessPermission("id", {
    id: "id",
    role: "VIEWER"
});

Parameters ​

idPathParam: string — The unique ID of an implementation.

request: HubPlatform.AddMemberRequest

requestOptions: ImplementationsClient.RequestOptions

client.implementations.getPermissionForImplementation(slug, { ...params }) -> Headers

Description ​

Get the current user's permission for an implementation. Use the UUID as slug for ID-based lookup, or combine a repository name as slug with the ?namespace= query parameter for full-path lookup. Returns the permission level in the x-access-permission response header.

Usage ​

typescript
await client.implementations.getPermissionForImplementation("slug");

Parameters ​

slug: string — The implementation's unique ID or the repository name.

request: HubPlatform.GetPermissionForImplementationRequest

requestOptions: ImplementationsClient.RequestOptions

client.implementations.getImplementationFile(id) -> core.BinaryResponse

Description ​

Download a file from an implementation's repository. The file path is specified as a sub-path after /files/, e.g., /implementations/{id}/files/src/main.py to download src/main.py from the repository root. Returns binary file content (not JSON).

Usage ​

typescript
await client.implementations.getImplementationFile("id");

Parameters ​

id: string — The unique ID of an implementation.

requestOptions: ImplementationsClient.RequestOptions

client.implementations.getImplementationFileInfo(id) -> Headers

Description ​

Get metadata of a file in an implementation's repository. The file path is specified as a sub-path after /files/, e.g., /implementations/{id}/files/src/main.py. Returns metadata in response headers: x-file-path, x-file-name, x-file-size (bytes), x-file-encoding, x-blob-id, x-commit-id, x-last-commit-id, x-ref.

Usage ​

typescript
await client.implementations.getImplementationFileInfo("id");

Parameters ​

id: string — The unique ID of an implementation.

requestOptions: ImplementationsClient.RequestOptions

client.implementations.getImplementation(id) -> HubPlatform.ImplementationDto

Description ​

Get a specific implementation (identified by its ID).

Usage ​

typescript
await client.implementations.getImplementation("id");

Parameters ​

id: string — The unique ID of an implementation.

requestOptions: ImplementationsClient.RequestOptions

client.implementations.deleteImplementation(id) -> void

Description ​

Delete a specific implementation (identified by its ID).

Usage ​

typescript
await client.implementations.deleteImplementation("id");

Parameters ​

id: string — The unique ID of an implementation.

requestOptions: ImplementationsClient.RequestOptions

client.implementations.getImplementationTree(id) -> HubPlatform.TreeNode

Description ​

Get the repository tree of an implementation (identified by its ID).

Usage ​

typescript
await client.implementations.getImplementationTree("id");

Parameters ​

id: string — The unique ID of an implementation.

requestOptions: ImplementationsClient.RequestOptions

client.implementations.getImplementationMetadata(id) -> HubPlatform.RepositoryMetadata

Description ​

Get the repository details of an implementation (identified by its ID).

Usage ​

typescript
await client.implementations.getImplementationMetadata("id");

Parameters ​

id: string — The unique ID of an implementation.

requestOptions: ImplementationsClient.RequestOptions

client.implementations.getImplementationLanguages(id) -> Record<string, number>

Description ​

Get the language statistics of an implementation's repository (identified by its ID).

Usage ​

typescript
await client.implementations.getImplementationLanguages("id");

Parameters ​

id: string — The unique ID of an implementation.

requestOptions: ImplementationsClient.RequestOptions

Git Integrations ​

client.gitIntegrations.updateGitLabIntegration(id, { ...params }) -> HubPlatform.UpdateGitLabIntegrationResponse

Description ​

Rotates the Personal Access Token and display name of an existing GitLab git integration, keeping the same integration id.

Usage ​

typescript
await client.gitIntegrations.updateGitLabIntegration("id", {
    name: "My GitLab",
    personalAccessToken: "personalAccessToken"
});

Parameters ​

id: string — The unique ID of a git integration.

request: HubPlatform.UpdateGitLabAccessTokenRequest

requestOptions: GitIntegrationsClient.RequestOptions

client.gitIntegrations.syncGitIntegrationRepositories(id) -> HubPlatform.SyncGitIntegrationRepositoriesResponse

Description ​

Triggers an asynchronous Repository Sync for a Git integration on demand (see the Repository Cache, ADR-0072). Returns immediately with the integration in PENDING; poll GET /git-integrations/{id} for the outcome. A no-op returning the current state if a sync for this integration is already in flight.

Usage ​

typescript
await client.gitIntegrations.syncGitIntegrationRepositories("id");

Parameters ​

id: string — The unique ID of a git integration.

requestOptions: GitIntegrationsClient.RequestOptions

client.gitIntegrations.createGitLabIntegration({ ...params }) -> HubPlatform.CreateGitLabIntegrationResponse

Description ​

Registers a new GitLab Personal Access Token validated against the GitLab API.

Usage ​

typescript
await client.gitIntegrations.createGitLabIntegration({
    name: "My GitLab",
    personalAccessToken: "personalAccessToken"
});

Parameters ​

request: HubPlatform.CreateGitLabAccessTokenRequest

requestOptions: GitIntegrationsClient.RequestOptions

client.gitIntegrations.createGitHubIntegration({ ...params }) -> HubPlatform.CreateGitHubIntegrationResponse

Description ​

Associates a GitHub App installation with the current user account.

Usage ​

typescript
await client.gitIntegrations.createGitHubIntegration({
    installationId: 12345678
});

Parameters ​

request: HubPlatform.CreateGitHubInstallationRequest

requestOptions: GitIntegrationsClient.RequestOptions

client.gitIntegrations.getGitIntegrations() -> HubPlatform.GetGitIntegrationsResponseItem[]

Description ​

Retrieves all Git provider integrations (GitHub and GitLab) for the current tenant.

Usage ​

typescript
await client.gitIntegrations.getGitIntegrations();

Parameters ​

requestOptions: GitIntegrationsClient.RequestOptions

client.gitIntegrations.getGitIntegration(id) -> HubPlatform.GetGitIntegrationResponse

Description ​

Retrieves a specific Git integration by its ID.

Usage ​

typescript
await client.gitIntegrations.getGitIntegration("id");

Parameters ​

id: string — The unique ID of a git integration.

requestOptions: GitIntegrationsClient.RequestOptions

client.gitIntegrations.deleteGitIntegration(id) -> void

Description ​

Deletes a Git integration by its ID.

Usage ​

typescript
await client.gitIntegrations.deleteGitIntegration("id");

Parameters ​

id: string — The unique ID of a git integration.

requestOptions: GitIntegrationsClient.RequestOptions

client.gitIntegrations.getGitIntegrationRepositories(id, { ...params }) -> HubPlatform.PageResponseGitRepositoryDto

Description ​

Lists the repositories cached for a specific Git integration (see the Repository Cache, ADR-0072).

Usage ​

typescript
await client.gitIntegrations.getGitIntegrationRepositories("id");

Parameters ​

id: string — The unique ID of a git integration.

request: HubPlatform.GetGitIntegrationRepositoriesRequest

requestOptions: GitIntegrationsClient.RequestOptions

client.gitIntegrations.getGitRepositories({ ...params }) -> HubPlatform.PageResponseGitRepositoryDto

Description ​

Lists the repositories cached across all Git integrations for the current tenant (see the Repository Cache, ADR-0072).

Usage ​

typescript
await client.gitIntegrations.getGitRepositories();

Parameters ​

request: HubPlatform.GetGitRepositoriesRequest

requestOptions: GitIntegrationsClient.RequestOptions

External Services ​

client.externalServices.updateExternalServiceSecurityConfiguration(id, { ...params }) -> void

Description ​

Updates the security configuration of an external service.

Usage ​

typescript
await client.externalServices.updateExternalServiceSecurityConfiguration("id", {
    headerName: "Authorization",
    tokenValue: "Bearer my-secret-token",
    type: "ACCESS_TOKEN"
});

Parameters ​

id: string — The unique ID of a service.

request: HubPlatform.UpdateExternalServiceSecurityConfigurationRequestBody

requestOptions: ExternalServicesClient.RequestOptions

client.externalServices.addExternalServicePricingPlan(id) -> HubPlatform.PricingPlanDto

Description ​

Adds a free pricing plan to an external service.

Usage ​

typescript
await client.externalServices.addExternalServicePricingPlan("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: ExternalServicesClient.RequestOptions

client.externalServices.deleteExternalServicePricingPlan(id) -> void

Description ​

Deletes the pricing plan of an external service.

Usage ​

typescript
await client.externalServices.deleteExternalServicePricingPlan("id");

Parameters ​

id: string — The unique ID of a service.

requestOptions: ExternalServicesClient.RequestOptions

client.externalServices.createExternalService({ ...params }) -> HubPlatform.ServiceDto

Description ​

Creates a new external service.

Usage ​

typescript
await client.externalServices.createExternalService({
    name: "my-quantum-service",
    url: "https://api.example.com/v1"
});

Parameters ​

request: HubPlatform.CreateExternalServiceRequest

requestOptions: ExternalServicesClient.RequestOptions

Data Pools ​

client.dataPools.getDataPool(id) -> HubPlatform.DataPoolDto

Description ​

Get a specific data pool (identified by its ID).

Usage ​

typescript
await client.dataPools.getDataPool("id");

Parameters ​

id: string — The unique ID of a data pool.

requestOptions: DataPoolsClient.RequestOptions

client.dataPools.updateDataPool(id, { ...params }) -> HubPlatform.DataPoolDto

Description ​

Update an existing data pool (identified by its ID).

Usage ​

typescript
await client.dataPools.updateDataPool("id", {
    name: "my-data-pool"
});

Parameters ​

id: string — The unique ID of a data pool.

request: HubPlatform.UpdateDataPoolRequest

requestOptions: DataPoolsClient.RequestOptions

client.dataPools.deleteDataPool(id) -> void

Description ​

Delete a specific data pool (identified by its ID).

Usage ​

typescript
await client.dataPools.deleteDataPool("id");

Parameters ​

id: string — The unique ID of a data pool.

requestOptions: DataPoolsClient.RequestOptions

client.dataPools.getDataPools() -> HubPlatform.DataPoolDto[]

Description ​

Get a list of all data pools for the current user or organization.

Usage ​

typescript
await client.dataPools.getDataPools();

Parameters ​

requestOptions: DataPoolsClient.RequestOptions

client.dataPools.createDataPool({ ...params }) -> HubPlatform.DataPoolDto

Description ​

Create a new data pool in the current user's account or the specified organization. A data pool is a container for files that can be shared with other users/organizations or used in service executions (via grants). The caller becomes the owner of the created data pool.

Usage ​

typescript
await client.dataPools.createDataPool({
    name: "my-data-pool"
});

Parameters ​

request: HubPlatform.CreateDataPoolRequest

requestOptions: DataPoolsClient.RequestOptions

client.dataPools.getDataPoolFiles(id) -> HubPlatform.DataPoolFileDto[]

Description ​

Get all files associated with a specific data pool (identified by its ID).

Usage ​

typescript
await client.dataPools.getDataPoolFiles("id");

Parameters ​

id: string — The unique ID of a data pool.

requestOptions: DataPoolsClient.RequestOptions

client.dataPools.addDataPoolFile(id, { ...params }) -> HubPlatform.DataPoolFileDto

Description ​

Add a new file to a specific data pool (identified by its ID). Accepts binary file upload (multipart/form-data).

Usage ​

typescript
await client.dataPools.addDataPoolFile("id", {
    file: fs.createReadStream("/path/to/your/file")
});

Parameters ​

id: string

request: HubPlatform.AddDataPoolFileRequest

requestOptions: DataPoolsClient.RequestOptions

client.dataPools.getDataPoolFile(id, fileId) -> core.BinaryResponse

Description ​

Get the content of a specific file from a data pool (both file and data pool identified by their ID). Returns binary file content (not JSON).

Usage ​

typescript
await client.dataPools.getDataPoolFile("id", "fileId");

Parameters ​

id: string — The unique ID of a data pool.

fileId: string — The unique ID of a data pool file.

requestOptions: DataPoolsClient.RequestOptions

client.dataPools.deleteDataPoolFile(id, fileId) -> void

Description ​

Delete a specific file from a data pool (both file and data pool identified by their IDs).

Usage ​

typescript
await client.dataPools.deleteDataPoolFile("id", "fileId");

Parameters ​

id: string — The unique ID of a data pool.

fileId: string — The unique ID of a data pool file.

requestOptions: DataPoolsClient.RequestOptions

Data Pool Shares ​

client.dataPoolShares.updateDataPoolShareRole(id, shareId, { ...params }) -> HubPlatform.ShareDto

Description ​

Update the role of an existing data pool share.

Usage ​

typescript
await client.dataPoolShares.updateDataPoolShareRole("id", "shareId", {});

Parameters ​

id: string — The unique ID of a data pool.

shareId: string — The unique ID of a resource share.

request: HubPlatform.UpdateResourceShareRoleDto

requestOptions: DataPoolSharesClient.RequestOptions

client.dataPoolShares.deleteDataPoolShare(id, shareId) -> void

Description ​

Revoke a share that was previously granted on a data pool. This removes the shared access for the target tenant. Requires GRANT permission on the data pool.

Usage ​

typescript
await client.dataPoolShares.deleteDataPoolShare("id", "shareId");

Parameters ​

id: string — The unique ID of a data pool.

shareId: string — The unique ID of a resource share.

requestOptions: DataPoolSharesClient.RequestOptions

client.dataPoolShares.updateDataPoolShareConstraint(id, shareId, constraintId, { ...params }) -> HubPlatform.TimeBasedConstraintDto

Description ​

Update an existing constraint on a data pool share.

Usage ​

typescript
await client.dataPoolShares.updateDataPoolShareConstraint("id", "shareId", "constraintId", {
    validFrom: "validFrom",
    validUntil: "validUntil",
    type: "TIME_BASED"
});

Parameters ​

id: string — The unique ID of a data pool.

shareId: string — The unique ID of a resource share.

constraintId: string — The unique ID of a share constraint.

request: HubPlatform.TimeBasedConstraintDto

requestOptions: DataPoolSharesClient.RequestOptions

client.dataPoolShares.deleteDataPoolShareConstraint(id, shareId, constraintId) -> void

Description ​

Delete an existing constraint on a data pool share.

Usage ​

typescript
await client.dataPoolShares.deleteDataPoolShareConstraint("id", "shareId", "constraintId");

Parameters ​

id: string — The unique ID of a data pool.

shareId: string — The unique ID of a resource share.

constraintId: string — The unique ID of a share constraint.

requestOptions: DataPoolSharesClient.RequestOptions

client.dataPoolShares.getSharesForDataPool(id) -> HubPlatform.ShareDto[]

Description ​

List all shares for a given data pool.

Usage ​

typescript
await client.dataPoolShares.getSharesForDataPool("id");

Parameters ​

id: string — The unique ID of a data pool.

requestOptions: DataPoolSharesClient.RequestOptions

client.dataPoolShares.shareDataPool(id, { ...params }) -> HubPlatform.ShareDto

Description ​

Share a data pool with other tenants.

Usage ​

typescript
await client.dataPoolShares.shareDataPool("id", {});

Parameters ​

id: string — The unique ID of a data pool.

request: HubPlatform.CreateShareRequestDto

requestOptions: DataPoolSharesClient.RequestOptions

client.dataPoolShares.addDataPoolShareConstraint(id, shareId, { ...params }) -> HubPlatform.TimeBasedConstraintDto

Description ​

Add a new constraint to an existing data pool share.

Usage ​

typescript
await client.dataPoolShares.addDataPoolShareConstraint("id", "shareId", {
    validFrom: "validFrom",
    validUntil: "validUntil",
    type: "TIME_BASED"
});

Parameters ​

id: string — The unique ID of a data pool.

shareId: string — The unique ID of a resource share.

request: HubPlatform.CreateTimeBasedConstraintDto

requestOptions: DataPoolSharesClient.RequestOptions

Algorithms ​

client.algorithms.getAlgorithm(id) -> HubPlatform.AlgorithmDto

Description ​

Get a specific algorithm (identified by its ID).

Usage ​

typescript
await client.algorithms.getAlgorithm("id");

Parameters ​

id: string — The unique ID of an algorithm.

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.updateAlgorithm(id, { ...params }) -> HubPlatform.AlgorithmDto

Description ​

Update an existing algorithm (identified by its ID).

Usage ​

typescript
await client.algorithms.updateAlgorithm("id", {
    name: "Shor's Algorithm",
    computationModel: "CLASSIC"
});

Parameters ​

id: string — The unique ID of an algorithm.

request: HubPlatform.UpdateAlgorithmRequest

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.deleteAlgorithm(id, { ...params }) -> void

Description ​

Delete a specific algorithm (identified by its ID).

Usage ​

typescript
await client.algorithms.deleteAlgorithm("id");

Parameters ​

id: string — The unique ID of an algorithm.

request: HubPlatform.DeleteAlgorithmRequest

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.setAlgorithmVisibility(id, { ...params }) -> void

Description ​

Set the visibility of an algorithm (identified by its ID).

Usage ​

typescript
await client.algorithms.setAlgorithmVisibility("id", {
    type: "PRIVATE"
});

Parameters ​

id: string — The unique ID of an algorithm.

request: HubPlatform.UpdateVisibilityRequest

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.getAlgorithmSketch(id, sketchId) -> HubPlatform.AlgorithmSketchDto

Description ​

Get a specific sketch of an algorithm (both identified by their IDs).

Usage ​

typescript
await client.algorithms.getAlgorithmSketch("id", "sketchId");

Parameters ​

id: string — The unique ID of an algorithm.

sketchId: string — The unique ID of an algorithm sketch.

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.updateAlgorithmSketch(id, sketchId, { ...params }) -> HubPlatform.AlgorithmSketchDto

Description ​

Update a specific sketch of an algorithm (both identified by their IDs).

Usage ​

typescript
await client.algorithms.updateAlgorithmSketch("id", "sketchId");

Parameters ​

id: string — The unique ID of an algorithm.

sketchId: string — The unique ID of an algorithm sketch.

request: HubPlatform.UpdateAlgorithmSketchRequest

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.deleteAlgorithmSketch(id, sketchId) -> void

Description ​

Delete a specific sketch of an algorithm (both identified by their IDs).

Usage ​

typescript
await client.algorithms.deleteAlgorithmSketch("id", "sketchId");

Parameters ​

id: string — The unique ID of an algorithm.

sketchId: string — The unique ID of an algorithm sketch.

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.getAlgorithmSketchImage(id, sketchId) -> core.BinaryResponse

Description ​

Get the image of a specific sketch of an algorithm (both identified by their IDs). Returns binary image content (not JSON).

Usage ​

typescript
await client.algorithms.getAlgorithmSketchImage("id", "sketchId");

Parameters ​

id: string — The unique ID of an algorithm.

sketchId: string — The unique ID of an algorithm sketch.

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.uploadAlgorithmSketchImage(id, sketchId, { ...params }) -> void

Description ​

Upload the image for a specific sketch of an algorithm (both identified by their IDs). Accepts binary file upload (multipart/form-data).

Usage ​

typescript
await client.algorithms.uploadAlgorithmSketchImage("id", "sketchId", {
    file: fs.createReadStream("/path/to/your/file")
});

Parameters ​

id: string

sketchId: string

request: HubPlatform.UploadAlgorithmSketchImageRequest

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.getAlgorithmRelation(id, relationId) -> HubPlatform.AlgorithmRelationDto

Description ​

Get a specific relation of an algorithm (both identified by their IDs).

Usage ​

typescript
await client.algorithms.getAlgorithmRelation("id", "relationId");

Parameters ​

id: string — The unique ID of an algorithm.

relationId: string — The unique ID of an algorithm relation.

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.updateAlgorithmRelation(id, relationId, { ...params }) -> HubPlatform.AlgorithmRelationDto

Description ​

Update a specific relation of an algorithm (both identified by their IDs).

Usage ​

typescript
await client.algorithms.updateAlgorithmRelation("id", "relationId", {
    sourceAlgorithmId: "sourceAlgorithmId",
    targetAlgorithmId: "targetAlgorithmId",
    relationTypeId: "relationTypeId"
});

Parameters ​

id: string — The unique ID of an algorithm.

relationId: string — The unique ID of an algorithm relation.

request: HubPlatform.UpdateAlgorithmRelationRequest

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.deleteAlgorithmRelation(id, relationId) -> void

Description ​

Delete a specific relation of an algorithm (both identified by their IDs).

Usage ​

typescript
await client.algorithms.deleteAlgorithmRelation("id", "relationId");

Parameters ​

id: string — The unique ID of an algorithm.

relationId: string — The unique ID of an algorithm relation.

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.getAlgorithms({ ...params }) -> HubPlatform.PageResponseAlgorithmOverviewDto

Description ​

Get a page of algorithms. The access filter selects which bucket is returned.

Usage ​

typescript
await client.algorithms.getAlgorithms();

Parameters ​

request: HubPlatform.GetAlgorithmsRequest

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.createAlgorithm({ ...params }) -> HubPlatform.AlgorithmDto

Description ​

Create a new algorithm in the current user's account or the specified organization. Algorithms describe quantum or hybrid computation methods and can be linked to use cases. The caller becomes the owner of the created algorithm.

Usage ​

typescript
await client.algorithms.createAlgorithm({
    name: "Shor's Algorithm",
    computationModel: "CLASSIC"
});

Parameters ​

request: HubPlatform.CreateAlgorithmRequest

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.createAlgorithmSketch(id, { ...params }) -> HubPlatform.AlgorithmSketchDto

Description ​

Create a new sketch for a specific algorithm (identified by its ID).

Usage ​

typescript
await client.algorithms.createAlgorithmSketch("id");

Parameters ​

id: string — The unique ID of an algorithm.

request: HubPlatform.CreateAlgorithmSketchRequest

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.getAlgorithmRelations(id) -> HubPlatform.AlgorithmRelationDto[]

Description ​

Get all relations for a specific algorithm (identified by its ID).

Usage ​

typescript
await client.algorithms.getAlgorithmRelations("id");

Parameters ​

id: string — The unique ID of an algorithm.

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.createAlgorithmRelation(id, { ...params }) -> HubPlatform.AlgorithmRelationDto

Description ​

Create a new relation for a specific algorithm (identified by its ID).

Usage ​

typescript
await client.algorithms.createAlgorithmRelation("id", {
    sourceAlgorithmId: "sourceAlgorithmId",
    targetAlgorithmId: "targetAlgorithmId",
    relationTypeId: "relationTypeId"
});

Parameters ​

id: string — The unique ID of an algorithm.

request: HubPlatform.CreateAlgorithmRelationRequest

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.getAlgorithmAccessPermissions(id) -> HubPlatform.AccessPermissionDto[]

Description ​

Get all access permissions for a specific algorithm (identified by its ID).

Usage ​

typescript
await client.algorithms.getAlgorithmAccessPermissions("id");

Parameters ​

id: string — The unique ID of an algorithm.

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.addAlgorithmAccessPermission(id, { ...params }) -> void

Description ​

Add an access permission to a specific algorithm (identified by its ID).

Usage ​

typescript
await client.algorithms.addAlgorithmAccessPermission("id", {});

Parameters ​

id: string — The unique ID of an algorithm.

request: HubPlatform.AccessPermissionDto

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.getAlgorithmRelationTypes() -> HubPlatform.PageResponseAlgorithmRelationTypeDto

Description ​

Get all available algorithm relation types.

Usage ​

typescript
await client.algorithms.getAlgorithmRelationTypes();

Parameters ​

requestOptions: AlgorithmsClient.RequestOptions

client.algorithms.removeAlgorithmAccessPermission(id, sid) -> void

Description ​

Remove an access permission from a specific algorithm (identified by its ID).

Usage ​

typescript
await client.algorithms.removeAlgorithmAccessPermission("id", "sid");

Parameters ​

id: string — The unique ID of an algorithm.

sid: string — The security identifier (user SID or organization SID) of the permission holder to remove.

requestOptions: AlgorithmsClient.RequestOptions

Workflow User Tasks ​

client.workflowUserTasks.submitResponse(taskId, { ...params }) -> void

Usage ​

typescript
await client.workflowUserTasks.submitResponse("taskId");

Parameters ​

taskId: string

request: HubPlatform.SubmitResponseRequest

requestOptions: WorkflowUserTasksClient.RequestOptions

Subscriptions ​

client.subscriptions.createSubscription({ ...params }) -> HubPlatform.SubscriptionDto

Description ​

Create a subscription to an internally or publicly published service.

Usage ​

typescript
await client.subscriptions.createSubscription({
    serviceId: "serviceId",
    applicationId: "applicationId"
});

Parameters ​

request: HubPlatform.CreateSubscriptionRequest

requestOptions: SubscriptionsClient.RequestOptions

client.subscriptions.getSubscription(id) -> HubPlatform.SubscriptionDto

Description ​

Get a specific subscription (identified by its ID).

Usage ​

typescript
await client.subscriptions.getSubscription("id");

Parameters ​

id: string — The unique ID of a subscription.

requestOptions: SubscriptionsClient.RequestOptions

client.subscriptions.deleteSubscription(id) -> void

Description ​

Remove a specific subscription. This will revoke access to the subscribed service.

Usage ​

typescript
await client.subscriptions.deleteSubscription("id");

Parameters ​

id: string — The unique ID of a subscription.

requestOptions: SubscriptionsClient.RequestOptions

client.subscriptions.getServiceExecutionsBySubscription(id) -> HubPlatform.ServiceExecutionDto[]

Description ​

Get a list of all service executions related to a specific subscription.

Usage ​

typescript
await client.subscriptions.getServiceExecutionsBySubscription("id");

Parameters ​

id: string — The unique ID of a subscription.

requestOptions: SubscriptionsClient.RequestOptions

Service Jobs ​

client.serviceJobs.getServiceJobs({ ...params }) -> HubPlatform.PageResponseServiceJobDto

Description ​

Get a paginated list of service jobs. Optionally filter by serviceId, tags, IDs, and creation date range. Supports sorting by: createdAt, startedAt, endedAt, status, serviceId. Default sort is createdAt descending (newest first).

Usage ​

typescript
await client.serviceJobs.getServiceJobs();

Parameters ​

request: HubPlatform.GetServiceJobsRequest

requestOptions: ServiceJobsClient.RequestOptions

client.serviceJobs.createServiceJob({ ...params }) -> HubPlatform.ServiceJobDto

Description ​

Create and start a new service job.

Usage ​

typescript
await client.serviceJobs.createServiceJob({
    serviceId: "serviceId"
});

Parameters ​

request: HubPlatform.CreateServiceJobRequest

requestOptions: ServiceJobsClient.RequestOptions

client.serviceJobs.rerunServiceJob(id) -> HubPlatform.ServiceJobDto

Description ​

Rerun an existing service job with the same configuration (input, tags, service). Creates a new service job with a new ID. Note: Only service jobs with stored input can be rerun (created with 'storeInput: true').

Usage ​

typescript
await client.serviceJobs.rerunServiceJob("id");

Parameters ​

id: string — The unique ID of a service job.

requestOptions: ServiceJobsClient.RequestOptions

client.serviceJobs.getServiceJob(id) -> HubPlatform.ServiceJobDto

Description ​

Get a specific service job (identified by its ID).

Usage ​

typescript
await client.serviceJobs.getServiceJob("id");

Parameters ​

id: string — The unique ID of a service job.

requestOptions: ServiceJobsClient.RequestOptions

Entitlements ​

client.entitlements.checkJobEligibility({ ...params }) -> HubPlatform.EntitlementDecision

Description ​

Evaluates whether a job submission with the specified parameters would be allowed under the caller's current entitlements. This is intended to be used as a pre-flight check before actually submitting a job, to provide better error messages and avoid unnecessary job submissions that would be rejected anyway. Note that the actual submission endpoint will still perform its own eligibility check and may reject the submission even if this endpoint returns ALLOW, due to potential state changes in between the eligibility check and the submission.

Usage ​

typescript
await client.entitlements.checkJobEligibility({
    provider: "AZURE",
    backendId: "azure.ionq.simulator",
    workloadType: "JOB"
});

Parameters ​

request: HubPlatform.JobEligibilityRequest

requestOptions: EntitlementsClient.RequestOptions

client.entitlements.getEntitlements() -> HubPlatform.Entitlements

Description ​

Fetches the entitlements for the current tenant. The entitlements are resolved based on the tenant's attributes and the configured entitlement rules. This endpoint can be used by clients to determine which features or services the tenant is entitled to use.

Usage ​

typescript
await client.entitlements.getEntitlements();

Parameters ​

requestOptions: EntitlementsClient.RequestOptions

Data Pool Grants ​

client.dataPoolGrants.createDataPoolGrant(id, { ...params }) -> HubPlatform.DataPoolGrant

Description ​

Create a short-lived access grant for a specific data pool (identified by its ID).

Usage ​

typescript
await client.dataPoolGrants.createDataPoolGrant("id", {
    applicationId: "applicationId",
    permission: "permission"
});

Parameters ​

id: string — The unique ID of a data pool.

request: HubPlatform.CreateDataPoolGrantRequest

requestOptions: DataPoolGrantsClient.RequestOptions

Authentication ​

client.authentication.resolveAuthToken() -> HubPlatform.ResolveAuthTokenResponse

Description ​

Resolve the principal associated with the given authentication token.

Usage ​

typescript
await client.authentication.resolveAuthToken();

Parameters ​

requestOptions: AuthenticationClient.RequestOptions

Applications ​

client.applications.getApplications() -> HubPlatform.ApplicationDto[]

Description ​

Get a list of all applications for the current user or organization.

Usage ​

typescript
await client.applications.getApplications();

Parameters ​

requestOptions: ApplicationsClient.RequestOptions

client.applications.createApplication({ ...params }) -> HubPlatform.ApplicationDto

Description ​

Create a new application in the current user's account or the specified organization. Applications are used to subscribe to services and execute them. Each application gets its own set of access keys for authenticating service calls.

Usage ​

typescript
await client.applications.createApplication({
    name: "my-application"
});

Parameters ​

request: HubPlatform.CreateApplicationRequest

requestOptions: ApplicationsClient.RequestOptions

client.applications.getApplication(id) -> HubPlatform.ApplicationDto

Description ​

Get a specific application (identified by its ID).

Usage ​

typescript
await client.applications.getApplication("id");

Parameters ​

id: string — The unique ID of an application.

requestOptions: ApplicationsClient.RequestOptions

client.applications.deleteApplication(id) -> void

Description ​

Delete an application (identified by its ID).

Usage ​

typescript
await client.applications.deleteApplication("id");

Parameters ​

id: string — The unique ID of an application.

requestOptions: ApplicationsClient.RequestOptions

client.applications.getApplicationSubscriptions(id) -> HubPlatform.SubscriptionDto[]

Description ​

List all subscriptions of an application.

Usage ​

typescript
await client.applications.getApplicationSubscriptions("id");

Parameters ​

id: string — The unique ID of an application.

requestOptions: ApplicationsClient.RequestOptions

client.applications.getApplicationAccessKeys(id) -> HubPlatform.AccessKey[]

Description ​

List of access keys for an application. Use these access keys to generate access tokens to authenticate service execution requests for subscribed services.

Usage ​

typescript
await client.applications.getApplicationAccessKeys("id");

Parameters ​

id: string — The unique ID of an application.

requestOptions: ApplicationsClient.RequestOptions

Marketplace ​

client.marketplace.getFile(id) -> core.BinaryResponse

Description ​

Download a file from a marketplace implementation's repository. The file path is specified as a sub-path after /files/, e.g., /marketplace/implementations/{id}/files/src/main.py.

Usage ​

typescript
await client.marketplace.getFile("id");

Parameters ​

id: string

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getFileInfo(id) -> Headers

Description ​

Get metadata of a file in a marketplace implementation's repository. The file path is specified as a sub-path after /files/, e.g., /marketplace/implementations/{id}/files/src/main.py. Returns metadata in response headers: x-file-path, x-file-name, x-file-size (bytes), x-file-encoding, x-blob-id, x-commit-id, x-last-commit-id, x-ref.

Usage ​

typescript
await client.marketplace.getFileInfo("id");

Parameters ​

id: string

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getMarketplaceUseCases({ ...params }) -> HubPlatform.PageResponseMarketplaceUseCaseOverviewDto

Description ​

Returns a list of all publicly available use cases in the marketplace.

Usage ​

typescript
await client.marketplace.getMarketplaceUseCases();

Parameters ​

request: HubPlatform.GetMarketplaceUseCasesRequest

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getMarketplaceUseCase(id) -> HubPlatform.MarketplaceUseCaseDetailsDto

Description ​

Returns the full details of a specific marketplace use case.

Usage ​

typescript
await client.marketplace.getMarketplaceUseCase("id");

Parameters ​

id: string — The unique ID of a use case.

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getMarketplaceUseCaseSketchImage(id, sketchId) -> core.BinaryResponse

Description ​

Get the image of a specific sketch of a marketplace use case. Returns binary image content (not JSON).

Usage ​

typescript
await client.marketplace.getMarketplaceUseCaseSketchImage("id", "sketchId");

Parameters ​

id: string — The unique ID of a use case.

sketchId: string — The unique ID of a use case sketch.

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getMarketplaceUseCaseAuthorImage(id, authorId) -> core.BinaryResponse

Description ​

Get the profile image of a specific author of a marketplace use case. Returns binary image content (not JSON).

Usage ​

typescript
await client.marketplace.getMarketplaceUseCaseAuthorImage("id", "authorId");

Parameters ​

id: string — The unique ID of a use case.

authorId: string — The unique ID of a use case author.

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getMarketplaceServices({ ...params }) -> HubPlatform.PageResponseMarketplaceServiceOverviewDto

Description ​

Returns a paginated list of all publicly published services in the marketplace.

Usage ​

typescript
await client.marketplace.getMarketplaceServices();

Parameters ​

request: HubPlatform.GetMarketplaceServicesRequest

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getMarketplaceService(id) -> HubPlatform.MarketplaceServiceDetailsDto

Description ​

Returns the full details of a specific marketplace service, including pricing plan, contacts, links, and API specification metadata.

Usage ​

typescript
await client.marketplace.getMarketplaceService("id");

Parameters ​

id: string — The unique ID of the marketplace service.

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getMarketplaceServiceOpenapi(id, { ...params }) -> string

Description ​

Get the OpenAPI specification of a specific marketplace service.

Usage ​

typescript
await client.marketplace.getMarketplaceServiceOpenapi("id");

Parameters ​

id: string — The unique ID of the marketplace service.

request: HubPlatform.GetMarketplaceServiceOpenapiRequest

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getMarketplaceImplementations({ ...params }) -> HubPlatform.PageResponseMarketplaceImplementationOverviewDto

Description ​

Returns a list of all publicly available implementations in the marketplace.

Usage ​

typescript
await client.marketplace.getMarketplaceImplementations();

Parameters ​

request: HubPlatform.GetMarketplaceImplementationsRequest

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getMarketplaceImplementation(id) -> HubPlatform.MarketplaceImplementationDetailsDto

Description ​

Returns the full details of a specific marketplace implementation.

Usage ​

typescript
await client.marketplace.getMarketplaceImplementation("id");

Parameters ​

id: string — The unique ID of an implementation.

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getTree(id) -> HubPlatform.TreeNode

Description ​

Get the repository tree of a marketplace implementation.

Usage ​

typescript
await client.marketplace.getTree("id");

Parameters ​

id: string

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getMetadata(id) -> HubPlatform.RepositoryMetadata

Description ​

Get the repository metadata of a marketplace implementation.

Usage ​

typescript
await client.marketplace.getMetadata("id");

Parameters ​

id: string

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getLanguages(id) -> Record<string, number>

Description ​

Get the language statistics of a marketplace implementation's repository.

Usage ​

typescript
await client.marketplace.getLanguages("id");

Parameters ​

id: string

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getMarketplaceAlgorithms({ ...params }) -> HubPlatform.PageResponseMarketplaceAlgorithmOverviewDto

Description ​

Returns a list of all publicly available algorithms in the marketplace.

Usage ​

typescript
await client.marketplace.getMarketplaceAlgorithms();

Parameters ​

request: HubPlatform.GetMarketplaceAlgorithmsRequest

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getMarketplaceAlgorithm(id) -> HubPlatform.MarketplaceAlgorithmDetailsDto

Description ​

Returns the full details of a specific marketplace algorithm.

Usage ​

typescript
await client.marketplace.getMarketplaceAlgorithm("id");

Parameters ​

id: string — The unique ID of an algorithm.

requestOptions: MarketplaceClient.RequestOptions

client.marketplace.getMarketplaceAlgorithmSketchImage(id, sketchId) -> core.BinaryResponse

Description ​

Get the image of a specific sketch of a marketplace algorithm. Returns binary image content (not JSON).

Usage ​

typescript
await client.marketplace.getMarketplaceAlgorithmSketchImage("id", "sketchId");

Parameters ​

id: string — The unique ID of an algorithm.

sketchId: string — The unique ID of an algorithm sketch.

requestOptions: MarketplaceClient.RequestOptions

Quantum Workloads ​

client.quantumWorkloads.getQuantumWorkloadCosts(id) -> HubPlatform.QuantumWorkloadCosts | undefined

Description ​

Get the aggregated total cost for a specific quantum workload (job or session) identified by its ID. A metered workload that carries no billable usage reports a total cost of zero. As long as the workload has not been metered at all, a HTTP 204 (No Content) response is returned with a "Retry-After" header. For detailed workload costs use the '/quantum-jobs/{id}/costs' endpoint.

Usage ​

typescript
await client.quantumWorkloads.getQuantumWorkloadCosts("id");

Parameters ​

id: string — The unique ID of a quantum workload.

requestOptions: QuantumWorkloadsClient.RequestOptions

client.quantumWorkloads.getQuantumJobCosts(id) -> HubPlatform.CostEntry[] | undefined

Description ​

Get the costs for a specific quantum job (identified by its ID). A metered job that carries no billable usage reports an empty list. As long as the quantum job has not been metered at all, a HTTP 204 (No Content) response is returned with a "Retry-After" header.

Usage ​

typescript
await client.quantumWorkloads.getQuantumJobCosts("id");

Parameters ​

id: string — The unique ID of a quantum job.

requestOptions: QuantumWorkloadsClient.RequestOptions

Products ​

client.products.getProducts() -> HubPlatform.PlatformProductDto[]

Description ​

Returns all currently active platform offerings together with their metered prices. Publicly accessible: no authentication required.

Usage ​

typescript
await client.products.getProducts();

Parameters ​

requestOptions: ProductsClient.RequestOptions

Announcements ​

client.announcements.getAnnouncements() -> HubPlatform.AnnouncementDto[]

Description ​

Get the platform-wide announcements to display, newest first. Message bodies are Markdown.

Usage ​

typescript
await client.announcements.getAnnouncements();

Parameters ​

requestOptions: AnnouncementsClient.RequestOptions

Published under the CC-BY-4.0 License.

Copyright © 2023-present | Kipu Quantum GmbH