Skip to main content

platform-api-python-client

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

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.1.0
  • Package version: 4.41.0
  • Generator version: 7.26.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Packaging uses standard [project] metadata and [dependency-groups] (PEP 621/735). Install the package with python -m pip install .; install development dependencies with Poetry 2.2 or newer using poetry install, or pip 25.1 or newer using python -m pip install --group dev. The latter installs the group, not the package.

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/centml/platform/client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/centml/platform/client.git)

Then import the package:

import platform_api_python_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import platform_api_python_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import platform_api_python_client
from platform_api_python_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 = platform_api_python_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.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    cluster_registration_request = platform_api_python_client.ClusterRegistrationRequest() # ClusterRegistrationRequest | 

    try:
        # Create Cluster
        api_response = api_instance.create_cluster_clusters_post(cluster_registration_request)
        print("The response of EXTERNALApi->create_cluster_clusters_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling EXTERNALApi->create_cluster_clusters_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
EXTERNALApi create_cluster_clusters_post POST /clusters Create Cluster
EXTERNALApi create_compute_deployment_deployments_compute_post POST /deployments/compute Create Compute Deployment
EXTERNALApi create_cserve_deployment_deployments_cserve_post POST /deployments/cserve Retired Cserve Deployment
EXTERNALApi create_cserve_v2_deployment_deployments_cserve_v2_post POST /deployments/cserve_v2 Retired Cserve Deployment
EXTERNALApi create_cserve_v3_deployment_deployments_cserve_v3_post POST /deployments/cserve_v3 Retired Cserve Deployment
EXTERNALApi create_dynamo_deployment_deployments_dynamo_post POST /deployments/dynamo Create Dynamo Deployment
EXTERNALApi create_hardware_instance_hardware_instances_post POST /hardware-instances Create Hardware Instance
EXTERNALApi create_inference_deployment_deployments_inference_post POST /deployments/inference Create Inference Deployment
EXTERNALApi create_inference_v3_deployment_deployments_inference_v3_post POST /deployments/inference_v3 Create Inference V3 Deployment
EXTERNALApi create_job_deployment_deployments_job_post POST /deployments/job Create Job Deployment
EXTERNALApi create_new_organization_organizations_post POST /organizations Create New Organization
EXTERNALApi create_service_account_service_accounts_post POST /service-accounts Create Service Account
EXTERNALApi create_unified_deployment_deployments_post POST /deployments Create Unified Deployment
EXTERNALApi create_volume_endpoint_volumes_post POST /volumes Create Volume Endpoint
EXTERNALApi delete_cluster_clusters_cluster_id_delete DELETE /clusters/{cluster_id} Delete Cluster
EXTERNALApi delete_hardware_instance_hardware_instances_hardware_instance_id_delete DELETE /hardware-instances/{hardware_instance_id} Delete Hardware Instance
EXTERNALApi delete_service_account_service_accounts_workos_id_delete DELETE /service-accounts/{workos_id} Delete Service Account
EXTERNALApi delete_unified_deployment_deployments_deployment_id_delete DELETE /deployments/{deployment_id} Delete Unified Deployment
EXTERNALApi delete_user_vault_item_by_id_endpoint_user_vault_secret_id_delete DELETE /user_vault/{secret_id} Delete User Vault Item By Id Endpoint
EXTERNALApi delete_user_vault_item_endpoint_user_vault_delete DELETE /user_vault Delete User Vault Item Endpoint
EXTERNALApi delete_volume_endpoint_volumes_volume_id_delete DELETE /volumes/{volume_id} Delete Volume Endpoint
EXTERNALApi generate_service_account_secret_service_accounts_workos_id_secrets_post POST /service-accounts/{workos_id}/secrets Generate Service Account Secret
EXTERNALApi get_all_user_vault_items_endpoint_user_vault_get GET /user_vault Get All User Vault Items Endpoint
EXTERNALApi get_all_volumes_endpoint_volumes_get GET /volumes Get All Volumes Endpoint
EXTERNALApi get_clusters_clusters_get GET /clusters Get Clusters
EXTERNALApi get_compute_deployment_deployments_compute_deployment_id_get GET /deployments/compute/{deployment_id} Get Compute Deployment
EXTERNALApi get_credits_credits_get GET /credits Get Credits
EXTERNALApi get_cserve_deployment_deployments_cserve_deployment_id_get GET /deployments/cserve/{deployment_id} Retired Cserve Deployment Detail
EXTERNALApi get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get GET /deployments/cserve_v2/{deployment_id} Retired Cserve Deployment Detail
EXTERNALApi get_cserve_v3_deployment_deployments_cserve_v3_deployment_id_get GET /deployments/cserve_v3/{deployment_id} Retired Cserve Deployment Detail
EXTERNALApi get_current_org_gpu_quota_organizations_gpu_quota_get GET /organizations/gpu-quota Get Current Org Gpu Quota
EXTERNALApi get_deployment_logs_deployments_logs_deployment_id_get GET /deployments/logs/{deployment_id} Get Deployment Logs
EXTERNALApi get_deployment_logs_v3_deployments_logs_v3_deployment_id_revision_number_get GET /deployments/logs_v3/{deployment_id}/{revision_number} Get Deployment Logs V3
EXTERNALApi get_deployment_logs_v4_logs_deployment_id_revision_number_get GET /logs/{deployment_id}/{revision_number} Get Deployment Logs V4
EXTERNALApi get_deployment_pods_deployments_pods_deployment_id_revision_number_get GET /deployments/pods/{deployment_id}/{revision_number} Get Deployment Pods
EXTERNALApi get_deployment_revision_deployments_revisions_deployment_id_revision_number_get GET /deployments/revisions/{deployment_id}/{revision_number} Get Deployment Revision
EXTERNALApi get_deployment_revisions_deployments_revisions_deployment_id_get GET /deployments/revisions/{deployment_id} Get Deployment Revisions
EXTERNALApi get_deployment_status_deployments_status_deployment_id_get GET /deployments/status/{deployment_id} Get Deployment Status
EXTERNALApi get_deployment_status_v3_deployments_status_v3_deployment_id_get GET /deployments/status_v3/{deployment_id} Get Deployment Status V3
EXTERNALApi get_deployments_deployments_get GET /deployments Get Deployments
EXTERNALApi get_dynamo_deployment_deployments_dynamo_deployment_id_get GET /deployments/dynamo/{deployment_id} Get Dynamo Deployment
EXTERNALApi get_hardware_instances_hardware_instances_get GET /hardware-instances Get Hardware Instances
EXTERNALApi get_hardware_presets_hardware_instances_presets_get GET /hardware-instances/presets Get Hardware Presets
EXTERNALApi get_inference_deployment_deployments_inference_deployment_id_get GET /deployments/inference/{deployment_id} Get Inference Deployment
EXTERNALApi get_inference_v3_deployment_deployments_inference_v3_deployment_id_get GET /deployments/inference_v3/{deployment_id} Get Inference V3 Deployment
EXTERNALApi get_insight_insights_insight_id_get GET /insights/{insight_id} Get Insight
EXTERNALApi get_job_deployment_deployments_job_deployment_id_get GET /deployments/job/{deployment_id} Get Job Deployment
EXTERNALApi get_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_get GET /clusters/{cluster_id}/organizations/{organization_id}/gpu-quota Get Org Gpu Quota On Cluster
EXTERNALApi get_prebuilt_images_prebuilt_images_get GET /prebuilt-images Get Prebuilt Images
EXTERNALApi get_unified_deployment_deployments_deployment_id_get GET /deployments/{deployment_id} Get Unified Deployment
EXTERNALApi get_unified_deployment_logs_deployments_deployment_id_revisions_revision_number_logs_get GET /deployments/{deployment_id}/revisions/{revision_number}/logs Get Unified Deployment Logs
EXTERNALApi get_unified_deployment_pods_deployments_deployment_id_revisions_revision_number_pods_get GET /deployments/{deployment_id}/revisions/{revision_number}/pods Get Unified Deployment Pods
EXTERNALApi get_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_get GET /deployments/{deployment_id}/revisions/{revision_number} Get Unified Deployment Revision
EXTERNALApi get_unified_deployment_rollout_deployments_deployment_id_rollout_get GET /deployments/{deployment_id}/rollout Get Unified Deployment Rollout
EXTERNALApi get_unified_deployment_usage_deployments_deployment_id_usage_get GET /deployments/{deployment_id}/usage Get Unified Deployment Usage
EXTERNALApi get_usage_daily_bills_get GET /daily_bills Get Usage
EXTERNALApi get_usage_deployments_usage_deployment_id_get GET /deployments/usage/{deployment_id} Get Usage
EXTERNALApi get_user_vault_item_by_id_endpoint_user_vault_secret_id_get GET /user_vault/{secret_id} Get User Vault Item By Id Endpoint
EXTERNALApi get_volume_endpoint_volumes_volume_id_get GET /volumes/{volume_id} Get Volume Endpoint
EXTERNALApi get_volume_status_endpoint_volumes_status_volume_id_get GET /volumes/status/{volume_id} Get Volume Status Endpoint
EXTERNALApi invite_user_organizations_invite_post POST /organizations/invite Invite User
EXTERNALApi list_cluster_capacity_capacity_get GET /capacity List Cluster Capacity
EXTERNALApi list_cluster_org_gpu_quotas_clusters_cluster_id_gpu_quota_organizations_get GET /clusters/{cluster_id}/gpu-quota/organizations List Cluster Org Gpu Quotas
EXTERNALApi list_insights_insights_get GET /insights List Insights
EXTERNALApi list_service_accounts_service_accounts_get GET /service-accounts List Service Accounts
EXTERNALApi list_unified_deployment_revisions_deployments_deployment_id_revisions_get GET /deployments/{deployment_id}/revisions List Unified Deployment Revisions
EXTERNALApi put_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_put PUT /clusters/{cluster_id}/organizations/{organization_id}/gpu-quota Put Org Gpu Quota On Cluster
EXTERNALApi rollout_existing_revision_deployments_revisions_deployment_id_revision_number_put PUT /deployments/revisions/{deployment_id}/{revision_number} Rollout Existing Revision
EXTERNALApi rollout_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_put PUT /deployments/{deployment_id}/revisions/{revision_number} Rollout Unified Deployment Revision
EXTERNALApi setup_stripe_customer_payments_setup_post POST /payments/setup Setup Stripe Customer
EXTERNALApi update_cluster_clusters_cluster_id_put PUT /clusters/{cluster_id} Update Cluster
EXTERNALApi update_cluster_metadata_clusters_cluster_id_metadata_put PUT /clusters/{cluster_id}/metadata Update Cluster Metadata
EXTERNALApi update_compute_deployment_deployments_compute_put PUT /deployments/compute Update Compute Deployment
EXTERNALApi update_cserve_deployment_deployments_cserve_put PUT /deployments/cserve Retired Cserve Deployment
EXTERNALApi update_cserve_v2_deployment_deployments_cserve_v2_put PUT /deployments/cserve_v2 Retired Cserve Deployment
EXTERNALApi update_cserve_v3_deployment_deployments_cserve_v3_put PUT /deployments/cserve_v3 Retired Cserve Deployment
EXTERNALApi update_deployment_status_deployments_status_deployment_id_put PUT /deployments/status/{deployment_id} Update Deployment Status
EXTERNALApi update_deployment_status_v3_deployments_status_v3_deployment_id_put PUT /deployments/status_v3/{deployment_id} Update Deployment Status V3
EXTERNALApi update_dynamo_deployment_deployments_dynamo_put PUT /deployments/dynamo Update Dynamo Deployment
EXTERNALApi update_inference_deployment_deployments_inference_put PUT /deployments/inference Update Inference Deployment
EXTERNALApi update_inference_v3_deployment_deployments_inference_v3_put PUT /deployments/inference_v3 Update Inference V3 Deployment
EXTERNALApi update_insight_status_insights_insight_id_status_patch PATCH /insights/{insight_id}/status Update Insight Status
EXTERNALApi update_service_account_service_accounts_workos_id_put PUT /service-accounts/{workos_id} Update Service Account
EXTERNALApi update_unified_deployment_deployments_deployment_id_put PUT /deployments/{deployment_id} Update Unified Deployment
EXTERNALApi update_unified_deployment_rollout_deployments_deployment_id_rollout_put PUT /deployments/{deployment_id}/rollout Update Unified Deployment Rollout
EXTERNALApi update_unified_deployment_status_deployments_deployment_id_status_put PUT /deployments/{deployment_id}/status Update Unified Deployment Status
EXTERNALApi update_user_vault_item_endpoint_user_vault_put PUT /user_vault Update User Vault Item Endpoint

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

  • Type: Bearer authentication

Author

Metadata

Release files for platform-api-python-client 4.41.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for platform-api-python-client 4.41.0
File Size Uploaded Provenance Actions
platform_api_python_client-4.41.0.tar.gz 178.2 kB With provenance Details for platform_api_python_client-4.41.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for platform-api-python-client 4.41.0
File Interpreter ABI Platform Actions
platform_api_python_client-4.41.0-py3-none-any.whl Python 3 none any Details for platform_api_python_client-4.41.0-py3-none-any.whl

Total release size: 539.5 kB

Release files / platform_api_python_client-4.41.0.tar.gz

Download URL platform_api_python_client-4.41.0.tar.gz
Size 178.2 kB
Tags Source
SHA-256 checksum
How to use checksums
eaf0ccb23276b0e4000b3acc211344b875f42ded513127f530d39f485f5ca20a
BLAKE2b-256 checksum
How to use checksums
9275cd18613f29f4a57db4e2d27653ea255760aadd92ca0ccf0861c538415382
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / platform_api_python_client-4.41.0-py3-none-any.whl

Download URL platform_api_python_client-4.41.0-py3-none-any.whl
Size 361.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
606e876a3f4928b661164d43d8f9f4c62a629783938cdd9d0f3b13dd891105e4
BLAKE2b-256 checksum
How to use checksums
afc46e7c7d91e3f818d9deae0c3cbadde5ee3ceb02d7f4bd6e2dbde3f29fd2a7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Security for platform-api-python-client 4.41.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for platform_api_python_client-4.41.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page