qi-compute-api-client 0.58.0
An API client for the Compute Job Manager of Quantum Inspire.
Requires Python: <3.14,>=3.10

# compute-api-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The `compute_api_client` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)
project:

- API version: 0.1.0
- Package version: 1.0.0
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

- urllib3 >= 2.1.0, < 3.0.0
- python-dateutil >= 2.8.2
- aiohttp >= 3.8.4
- aiohttp-retry >= 2.8.3
- pydantic >= 2
- typing-extensions >= 4.7.1

## Getting Started

In your own code, to use this library to connect and interact with compute-api-client, you can run the following:

```python

import compute_api_client
from compute_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = compute_api_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
async with compute_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = compute_api_client.AlgorithmsApi(api_client)
    algorithm_in = compute_api_client.AlgorithmIn() # AlgorithmIn |

    try:
        # Create algorithm
        api_response = await api_instance.create_algorithm_algorithms_post(algorithm_in)
        print("The response of AlgorithmsApi->create_algorithm_algorithms_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AlgorithmsApi->create_algorithm_algorithms_post: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to _http://localhost_

| Class             | Method                                                                                                                                                                       | HTTP request                              | Description                                        |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -------------------------------------------------- |
| _AlgorithmsApi_   | [**create_algorithm_algorithms_post**](compute_api_client/docs/AlgorithmsApi.md#create_algorithm_algorithms_post)                                                            | **POST** /algorithms                      | Create algorithm                                   |
| _AlgorithmsApi_   | [**delete_algorithm_algorithms_id_delete**](compute_api_client/docs/AlgorithmsApi.md#delete_algorithm_algorithms_id_delete)                                                  | **DELETE** /algorithms/{id}               | Destroy algorithm                                  |
| _AlgorithmsApi_   | [**read_algorithm_algorithms_id_get**](compute_api_client/docs/AlgorithmsApi.md#read_algorithm_algorithms_id_get)                                                            | **GET** /algorithms/{id}                  | Retrieve algorithm                                 |
| _AlgorithmsApi_   | [**read_algorithms_algorithms_get**](compute_api_client/docs/AlgorithmsApi.md#read_algorithms_algorithms_get)                                                                | **GET** /algorithms                       | List algorithms                                    |
| _AlgorithmsApi_   | [**update_algorithm_algorithms_id_put**](compute_api_client/docs/AlgorithmsApi.md#update_algorithm_algorithms_id_put)                                                        | **PUT** /algorithms/{id}                  | Update algorithm                                   |
| _AuthConfigApi_   | [**auth_config_auth_config_get**](compute_api_client/docs/AuthConfigApi.md#auth_config_auth_config_get)                                                                      | **GET** /auth_config                      | Get suggested authentication configuration         |
| _BackendApi_      | [**create_backend_backends_post**](compute_api_client/docs/BackendApi.md#create_backend_backends_post)                                                                       | **POST** /backends                        | Create backend                                     |
| _BackendApi_      | [**read_backend_backends_id_get**](compute_api_client/docs/BackendApi.md#read_backend_backends_id_get)                                                                       | **GET** /backends/{id}                    | Retrieve backend                                   |
| _BackendApi_      | [**read_backend_self_backends_me_get**](compute_api_client/docs/BackendApi.md#read_backend_self_backends_me_get)                                                             | **GET** /backends/me                      | Retrieve backend                                   |
| _BackendApi_      | [**read_backends_backends_get**](compute_api_client/docs/BackendApi.md#read_backends_backends_get)                                                                           | **GET** /backends                         | List backends                                      |
| _BackendApi_      | [**update_backend_self_backends_me_patch**](compute_api_client/docs/BackendApi.md#update_backend_self_backends_me_patch)                                                     | **PATCH** /backends/me                    | Update backend                                     |
| _BackendTypesApi_ | [**read_backend_type_backend_types_id_get**](compute_api_client/docs/BackendTypesApi.md#read_backend_type_backend_types_id_get)                                              | **GET** /backend_types/{id}               | Retrieve backend type                              |
| _BackendTypesApi_ | [**read_backend_type_queue_backend_types_id_queue_get**](compute_api_client/docs/BackendTypesApi.md#read_backend_type_queue_backend_types_id_queue_get)                      | **GET** /backend_types/{id}/queue         | Retrieve backend type (batch) job queue statistics |
| _BackendTypesApi_ | [**read_backend_types_backend_types_get**](compute_api_client/docs/BackendTypesApi.md#read_backend_types_backend_types_get)                                                  | **GET** /backend_types/                   | List backend types                                 |
| _BackendTypesApi_ | [**update_backend_type_backend_types_me_patch**](compute_api_client/docs/BackendTypesApi.md#update_backend_type_backend_types_me_patch)                                      | **PATCH** /backend_types/me               | Update backend type                                |
| _BatchJobsApi_    | [**create_batch_job_batch_jobs_post**](compute_api_client/docs/BatchJobsApi.md#create_batch_job_batch_jobs_post)                                                             | **POST** /batch_jobs                      | Create batch job                                   |
| _BatchJobsApi_    | [**enqueue_batch_job_batch_jobs_id_enqueue_patch**](compute_api_client/docs/BatchJobsApi.md#enqueue_batch_job_batch_jobs_id_enqueue_patch)                                   | **PATCH** /batch_jobs/{id}/enqueue        | Enqueue batch job for execution                    |
| _BatchJobsApi_    | [**finish_batch_job_batch_jobs_id_finish_patch**](compute_api_client/docs/BatchJobsApi.md#finish_batch_job_batch_jobs_id_finish_patch)                                       | **PATCH** /batch_jobs/{id}/finish         | Finish batch job                                   |
| _BatchJobsApi_    | [**peek_batch_job_batch_jobs_peek_patch**](compute_api_client/docs/BatchJobsApi.md#peek_batch_job_batch_jobs_peek_patch)                                                     | **PATCH** /batch_jobs/peek                | Peek batch job                                     |
| _BatchJobsApi_    | [**pop_batch_job_batch_jobs_pop_patch**](compute_api_client/docs/BatchJobsApi.md#pop_batch_job_batch_jobs_pop_patch)                                                         | **PATCH** /batch_jobs/pop                 | Take batch job                                     |
| _BatchJobsApi_    | [**read_batch_jobs_batch_jobs_get**](compute_api_client/docs/BatchJobsApi.md#read_batch_jobs_batch_jobs_get)                                                                 | **GET** /batch_jobs                       | List batch jobs                                    |
| _BatchJobsApi_    | [**unpop_batch_job_batch_jobs_id_unpop_patch**](compute_api_client/docs/BatchJobsApi.md#unpop_batch_job_batch_jobs_id_unpop_patch)                                           | **PATCH** /batch_jobs/{id}/unpop          | Take batch job                                     |
| _CommitsApi_      | [**compile_commit_commits_id_compile_post**](compute_api_client/docs/CommitsApi.md#compile_commit_commits_id_compile_post)                                                   | **POST** /commits/{id}/compile            | Compile file in a commit                           |
| _CommitsApi_      | [**create_commit_commits_post**](compute_api_client/docs/CommitsApi.md#create_commit_commits_post)                                                                           | **POST** /commits                         | Create commit                                      |
| _CommitsApi_      | [**delete_commit_commits_id_delete**](compute_api_client/docs/CommitsApi.md#delete_commit_commits_id_delete)                                                                 | **DELETE** /commits/{id}                  | Destroy commit                                     |
| _CommitsApi_      | [**read_commit_commits_id_get**](compute_api_client/docs/CommitsApi.md#read_commit_commits_id_get)                                                                           | **GET** /commits/{id}                     | Get commit by ID                                   |
| _CommitsApi_      | [**read_commits_commits_get**](compute_api_client/docs/CommitsApi.md#read_commits_commits_get)                                                                               | **GET** /commits                          | List commits                                       |
| _FilesApi_        | [**create_file_files_post**](compute_api_client/docs/FilesApi.md#create_file_files_post)                                                                                     | **POST** /files                           | Create file                                        |
| _FilesApi_        | [**delete_file_files_id_delete**](compute_api_client/docs/FilesApi.md#delete_file_files_id_delete)                                                                           | **DELETE** /files/{id}                    | Destroy file                                       |
| _FilesApi_        | [**read_file_files_id_get**](compute_api_client/docs/FilesApi.md#read_file_files_id_get)                                                                                     | **GET** /files/{id}                       | Retrieve file                                      |
| _FilesApi_        | [**read_files_files_get**](compute_api_client/docs/FilesApi.md#read_files_files_get)                                                                                         | **GET** /files                            | List files                                         |
| _FinalResultsApi_ | [**create_final_result_final_results_post**](compute_api_client/docs/FinalResultsApi.md#create_final_result_final_results_post)                                              | **POST** /final_results                   | Create final result                                |
| _FinalResultsApi_ | [**read_final_result_by_job_id_final_results_job_job_id_get**](compute_api_client/docs/FinalResultsApi.md#read_final_result_by_job_id_final_results_job_job_id_get)          | **GET** /final_results/job/{job_id}       | Retrieve final result by job ID                    |
| _FinalResultsApi_ | [**read_final_result_final_results_id_get**](compute_api_client/docs/FinalResultsApi.md#read_final_result_final_results_id_get)                                              | **GET** /final_results/{id}               | Retrieve final result                              |
| _HealthApi_       | [**healthz_healthz_get**](compute_api_client/docs/HealthApi.md#healthz_healthz_get)                                                                                          | **GET** /healthz                          | Report health                                      |
| _JobsApi_         | [**create_job_jobs_post**](compute_api_client/docs/JobsApi.md#create_job_jobs_post)                                                                                          | **POST** /jobs                            | Create job                                         |
| _JobsApi_         | [**delete_job_jobs_id_delete**](compute_api_client/docs/JobsApi.md#delete_job_jobs_id_delete)                                                                                | **DELETE** /jobs/{id}                     | Destroy job                                        |
| _JobsApi_         | [**get_job_logs_jobs_id_logs_get**](compute_api_client/docs/JobsApi.md#get_job_logs_jobs_id_logs_get)                                                                        | **GET** /jobs/{id}/logs                   | Retrieve logs for a job                            |
| _JobsApi_         | [**read_job_jobs_id_get**](compute_api_client/docs/JobsApi.md#read_job_jobs_id_get)                                                                                          | **GET** /jobs/{id}                        | Retrieve job                                       |
| _JobsApi_         | [**read_jobs_jobs_get**](compute_api_client/docs/JobsApi.md#read_jobs_jobs_get)                                                                                              | **GET** /jobs                             | List jobs                                          |
| _JobsApi_         | [**update_job_status_jobs_id_patch**](compute_api_client/docs/JobsApi.md#update_job_status_jobs_id_patch)                                                                    | **PATCH** /jobs/{id}                      | Update Job Status                                  |
| _LanguagesApi_    | [**read_language_languages_id_get**](compute_api_client/docs/LanguagesApi.md#read_language_languages_id_get)                                                                 | **GET** /languages/{id}                   | Retrieve language                                  |
| _LanguagesApi_    | [**read_languages_languages_get**](compute_api_client/docs/LanguagesApi.md#read_languages_languages_get)                                                                     | **GET** /languages                        | List languages                                     |
| _MembersApi_      | [**create_member_members_post**](compute_api_client/docs/MembersApi.md#create_member_members_post)                                                                           | **POST** /members                         | Create member                                      |
| _MembersApi_      | [**delete_member_members_id_delete**](compute_api_client/docs/MembersApi.md#delete_member_members_id_delete)                                                                 | **DELETE** /members/{id}                  | Destroy member                                     |
| _MembersApi_      | [**read_member_members_id_get**](compute_api_client/docs/MembersApi.md#read_member_members_id_get)                                                                           | **GET** /members/{id}                     | Retrieve member                                    |
| _MembersApi_      | [**read_members_members_get**](compute_api_client/docs/MembersApi.md#read_members_members_get)                                                                               | **GET** /members                          | List members                                       |
| _PermissionsApi_  | [**read_permission_group_permission_groups_id_get**](compute_api_client/docs/PermissionsApi.md#read_permission_group_permission_groups_id_get)                               | **GET** /permission_groups/{id}           | Retrieve permission groups                         |
| _PermissionsApi_  | [**read_permission_groups_permission_groups_get**](compute_api_client/docs/PermissionsApi.md#read_permission_groups_permission_groups_get)                                   | **GET** /permission_groups/               | List permission groups                             |
| _PermissionsApi_  | [**read_permission_permissions_id_get**](compute_api_client/docs/PermissionsApi.md#read_permission_permissions_id_get)                                                       | **GET** /permissions/{id}                 | Retrieve permissions                               |
| _PermissionsApi_  | [**read_permissions_permissions_get**](compute_api_client/docs/PermissionsApi.md#read_permissions_permissions_get)                                                           | **GET** /permissions/                     | List permissions                                   |
| _ProjectsApi_     | [**create_project_projects_post**](compute_api_client/docs/ProjectsApi.md#create_project_projects_post)                                                                      | **POST** /projects                        | Create project                                     |
| _ProjectsApi_     | [**delete_project_projects_id_delete**](compute_api_client/docs/ProjectsApi.md#delete_project_projects_id_delete)                                                            | **DELETE** /projects/{id}                 | Destroy project                                    |
| _ProjectsApi_     | [**partial_update_project_projects_id_patch**](compute_api_client/docs/ProjectsApi.md#partial_update_project_projects_id_patch)                                              | **PATCH** /projects/{id}                  | Partially update project                           |
| _ProjectsApi_     | [**read_project_projects_id_get**](compute_api_client/docs/ProjectsApi.md#read_project_projects_id_get)                                                                      | **GET** /projects/{id}                    | Retrieve project                                   |
| _ProjectsApi_     | [**read_projects_projects_get**](compute_api_client/docs/ProjectsApi.md#read_projects_projects_get)                                                                          | **GET** /projects                         | List projects                                      |
| _ProjectsApi_     | [**update_project_projects_id_put**](compute_api_client/docs/ProjectsApi.md#update_project_projects_id_put)                                                                  | **PUT** /projects/{id}                    | Update project                                     |
| _ReservationsApi_ | [**create_reservation_reservations_post**](compute_api_client/docs/ReservationsApi.md#create_reservation_reservations_post)                                                  | **POST** /reservations                    | Create reservation                                 |
| _ReservationsApi_ | [**read_reservation_reservations_id_get**](compute_api_client/docs/ReservationsApi.md#read_reservation_reservations_id_get)                                                  | **GET** /reservations/{id}                | Retrieve reservation                               |
| _ReservationsApi_ | [**read_reservations_reservations_get**](compute_api_client/docs/ReservationsApi.md#read_reservations_reservations_get)                                                      | **GET** /reservations                     | List reservations                                  |
| _ReservationsApi_ | [**terminate_reservation_reservations_id_terminate_patch**](compute_api_client/docs/ReservationsApi.md#terminate_reservation_reservations_id_terminate_patch)                | **PATCH** /reservations/{id}/terminate    | Terminate reservation                              |
| _ResultsApi_      | [**create_result_results_post**](compute_api_client/docs/ResultsApi.md#create_result_results_post)                                                                           | **POST** /results                         | Create result                                      |
| _ResultsApi_      | [**delete_results_by_job_id_results_job_job_id_delete**](compute_api_client/docs/ResultsApi.md#delete_results_by_job_id_results_job_job_id_delete)                           | **DELETE** /results/job/{job_id}          | Delete results by job ID                           |
| _ResultsApi_      | [**read_result_results_id_get**](compute_api_client/docs/ResultsApi.md#read_result_results_id_get)                                                                           | **GET** /results/{id}                     | Retrieve result                                    |
| _ResultsApi_      | [**read_results_by_algorithm_id_results_algorithm_algorithm_id_get**](compute_api_client/docs/ResultsApi.md#read_results_by_algorithm_id_results_algorithm_algorithm_id_get) | **GET** /results/algorithm/{algorithm_id} | Retrieve results by algorithm ID                   |
| _ResultsApi_      | [**read_results_by_job_id_results_job_job_id_get**](compute_api_client/docs/ResultsApi.md#read_results_by_job_id_results_job_job_id_get)                                     | **GET** /results/job/{job_id}             | Retrieve results by job ID                         |
| _TeamsApi_        | [**read_team_teams_id_get**](compute_api_client/docs/TeamsApi.md#read_team_teams_id_get)                                                                                     | **GET** /teams/{id}                       | Retrieve teams                                     |
| _TeamsApi_        | [**read_teams_teams_get**](compute_api_client/docs/TeamsApi.md#read_teams_teams_get)                                                                                         | **GET** /teams/                           | List teams                                         |
| _TransactionsApi_ | [**read_transaction_transactions_id_get**](compute_api_client/docs/TransactionsApi.md#read_transaction_transactions_id_get)                                                  | **GET** /transactions/{id}                | Retrieve transactions                              |
| _TransactionsApi_ | [**read_transactions_transactions_get**](compute_api_client/docs/TransactionsApi.md#read_transactions_transactions_get)                                                      | **GET** /transactions/                    | List transactions                                  |
| _UsersApi_        | [**create_user_users_post**](compute_api_client/docs/UsersApi.md#create_user_users_post)                                                                                     | **POST** /users                           | Create user                                        |
| _UsersApi_        | [**delete_user_users_id_delete**](compute_api_client/docs/UsersApi.md#delete_user_users_id_delete)                                                                           | **DELETE** /users/{id}                    | Destroy user                                       |
| _UsersApi_        | [**read_user_users_id_get**](compute_api_client/docs/UsersApi.md#read_user_users_id_get)                                                                                     | **GET** /users/{id}                       | Retrieve user                                      |
| _UsersApi_        | [**read_users_users_get**](compute_api_client/docs/UsersApi.md#read_users_users_get)                                                                                         | **GET** /users                            | List users                                         |

## Documentation For Models

- [Algorithm](compute_api_client/docs/Algorithm.md)
- [AlgorithmIn](compute_api_client/docs/AlgorithmIn.md)
- [AlgorithmType](compute_api_client/docs/AlgorithmType.md)
- [AuthConfig](compute_api_client/docs/AuthConfig.md)
- [Backend](compute_api_client/docs/Backend.md)
- [BackendIn](compute_api_client/docs/BackendIn.md)
- [BackendMessage](compute_api_client/docs/BackendMessage.md)
- [BackendPatch](compute_api_client/docs/BackendPatch.md)
- [BackendStatus](compute_api_client/docs/BackendStatus.md)
- [BackendType](compute_api_client/docs/BackendType.md)
- [BackendTypePatch](compute_api_client/docs/BackendTypePatch.md)
- [BackendWithAuthentication](compute_api_client/docs/BackendWithAuthentication.md)
- [BatchJob](compute_api_client/docs/BatchJob.md)
- [BatchJobIn](compute_api_client/docs/BatchJobIn.md)
- [BatchJobStatus](compute_api_client/docs/BatchJobStatus.md)
- [Commit](compute_api_client/docs/Commit.md)
- [CommitIn](compute_api_client/docs/CommitIn.md)
- [CompilePayload](compute_api_client/docs/CompilePayload.md)
- [CompileStage](compute_api_client/docs/CompileStage.md)
- [Domain](compute_api_client/docs/Domain.md)
- [File](compute_api_client/docs/File.md)
- [FileIn](compute_api_client/docs/FileIn.md)
- [FinalResult](compute_api_client/docs/FinalResult.md)
- [FinalResultIn](compute_api_client/docs/FinalResultIn.md)
- [HTTPBadRequestError](compute_api_client/docs/HTTPBadRequestError.md)
- [HTTPNotFoundError](compute_api_client/docs/HTTPNotFoundError.md)
- [HTTPValidationError](compute_api_client/docs/HTTPValidationError.md)
- [Job](compute_api_client/docs/Job.md)
- [JobIn](compute_api_client/docs/JobIn.md)
- [JobLogLine](compute_api_client/docs/JobLogLine.md)
- [JobLogPage](compute_api_client/docs/JobLogPage.md)
- [JobPatch](compute_api_client/docs/JobPatch.md)
- [JobStatus](compute_api_client/docs/JobStatus.md)
- [Language](compute_api_client/docs/Language.md)
- [Member](compute_api_client/docs/Member.md)
- [MemberIn](compute_api_client/docs/MemberIn.md)
- [PageAlgorithm](compute_api_client/docs/PageAlgorithm.md)
- [PageBackend](compute_api_client/docs/PageBackend.md)
- [PageBackendType](compute_api_client/docs/PageBackendType.md)
- [PageBatchJob](compute_api_client/docs/PageBatchJob.md)
- [PageCommit](compute_api_client/docs/PageCommit.md)
- [PageFile](compute_api_client/docs/PageFile.md)
- [PageJob](compute_api_client/docs/PageJob.md)
- [PageLanguage](compute_api_client/docs/PageLanguage.md)
- [PageMember](compute_api_client/docs/PageMember.md)
- [PagePermission](compute_api_client/docs/PagePermission.md)
- [PagePermissionGroup](compute_api_client/docs/PagePermissionGroup.md)
- [PageProject](compute_api_client/docs/PageProject.md)
- [PageReservation](compute_api_client/docs/PageReservation.md)
- [PageResult](compute_api_client/docs/PageResult.md)
- [PageTeam](compute_api_client/docs/PageTeam.md)
- [PageTransaction](compute_api_client/docs/PageTransaction.md)
- [PageUser](compute_api_client/docs/PageUser.md)
- [Permission](compute_api_client/docs/Permission.md)
- [PermissionGroup](compute_api_client/docs/PermissionGroup.md)
- [Project](compute_api_client/docs/Project.md)
- [ProjectIn](compute_api_client/docs/ProjectIn.md)
- [ProjectPatch](compute_api_client/docs/ProjectPatch.md)
- [Queue](compute_api_client/docs/Queue.md)
- [Reservation](compute_api_client/docs/Reservation.md)
- [ReservationIn](compute_api_client/docs/ReservationIn.md)
- [Result](compute_api_client/docs/Result.md)
- [ResultIn](compute_api_client/docs/ResultIn.md)
- [Role](compute_api_client/docs/Role.md)
- [ShareType](compute_api_client/docs/ShareType.md)
- [Team](compute_api_client/docs/Team.md)
- [Transaction](compute_api_client/docs/Transaction.md)
- [User](compute_api_client/docs/User.md)
- [UserIn](compute_api_client/docs/UserIn.md)
- [ValidationError](compute_api_client/docs/ValidationError.md)
- [ValidationErrorLocInner](compute_api_client/docs/ValidationErrorLocInner.md)

<a id="documentation-for-authorization"></a>

## Documentation For Authorization

Authentication schemes defined for the API: <a id="user_bearer"></a>

### user_bearer

- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://auth.dev.quantum-inspire.com/authorize
- **Scopes**: N/A

<a id="backend"></a>

### backend

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header

## Author