platform_api_python_client.EXTERNALApi

All URIs are relative to http://localhost

Method	HTTP request	Description
add_user_request_support_user_requests_post	POST /support/user-requests	Add User Request
create_api_key_credentials_api_key_post	POST /credentials/api-key	Create Api Key
create_checkout_payments_checkout_post	POST /payments/checkout	Create Checkout
create_compute_deployment_deployments_compute_post	POST /deployments/compute	Create Compute Deployment
create_cserve_deployment_deployments_cserve_post	POST /deployments/cserve	Create Cserve Deployment
create_cserve_v2_deployment_deployments_cserve_v2_post	POST /deployments/cserve_v2	Create Cserve V2 Deployment
create_inference_deployment_deployments_inference_post	POST /deployments/inference	Create Inference Deployment
create_rag_deployment_deployments_rag_post	POST /deployments/rag	Create Rag Deployment
create_setup_payments_setup_checkout_post	POST /payments/setup_checkout	Create Setup
delete_api_key_credentials_api_key_id_delete	DELETE /credentials/api-key/{id}	Delete Api Key
delete_user_vault_item_endpoint_user_vault_delete	DELETE /user_vault	Delete User Vault Item Endpoint
get_all_user_vault_items_endpoint_user_vault_get	GET /user_vault	Get All User Vault Items Endpoint
get_api_keys_credentials_api_key_get	GET /credentials/api-key	Get Api Keys
get_clusters_clusters_get	GET /clusters	Get Clusters
get_compute_deployment_deployments_compute_deployment_id_get	GET /deployments/compute/{deployment_id}	Get Compute Deployment
get_credits_credits_get	GET /credits	Get Credits
get_cserve_deployment_deployments_cserve_deployment_id_get	GET /deployments/cserve/{deployment_id}	Get Cserve Deployment
get_cserve_recipe_deployments_cserve_recipes_get	GET /deployments/cserve/recipes	Get Cserve Recipe
get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get	GET /deployments/cserve_v2/{deployment_id}	Get Cserve V2 Deployment
get_deployment_logs_deployments_logs_deployment_id_get	GET /deployments/logs/{deployment_id}	Get Deployment Logs
get_deployment_status_deployments_status_deployment_id_get	GET /deployments/status/{deployment_id}	Get Deployment Status
get_deployments_deployments_get	GET /deployments	Get Deployments
get_hardware_instances_hardware_instances_get	GET /hardware-instances	Get Hardware Instances
get_inference_deployment_deployments_inference_deployment_id_get	GET /deployments/inference/{deployment_id}	Get Inference Deployment
get_payments_payments_get	GET /payments	Get Payments
get_prebuilt_images_prebuilt_images_get	GET /prebuilt-images	Get Prebuilt Images
get_rag_deployment_deployments_rag_deployment_id_get	GET /deployments/rag/{deployment_id}	Get Rag Deployment
get_usage_daily_bills_get	GET /daily_bills	Get Usage
get_usage_deployments_usage_deployment_id_get	GET /deployments/usage/{deployment_id}	Get Usage
setup_stripe_customer_payments_setup_post	POST /payments/setup	Setup Stripe Customer
update_deployment_status_deployments_status_deployment_id_put	PUT /deployments/status/{deployment_id}	Update Deployment Status
update_user_vault_item_endpoint_user_vault_put	PUT /user_vault	Update User Vault Item Endpoint

add_user_request_support_user_requests_post

object add_user_request_support_user_requests_post(user_support_email_request)

Add User Request

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.user_support_email_request import UserSupportEmailRequest
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)
    user_support_email_request = platform_api_python_client.UserSupportEmailRequest() # UserSupportEmailRequest | 

    try:
        # Add User Request
        api_response = api_instance.add_user_request_support_user_requests_post(user_support_email_request)
        print("The response of EXTERNALApi->add_user_request_support_user_requests_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->add_user_request_support_user_requests_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_support_email_request	UserSupportEmailRequest

Return type

object

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_api_key_credentials_api_key_post

APIKeyResponse create_api_key_credentials_api_key_post(api_key_request)

Create Api Key

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.api_key_request import APIKeyRequest
from platform_api_python_client.models.api_key_response import APIKeyResponse
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)
    api_key_request = platform_api_python_client.APIKeyRequest() # APIKeyRequest | 

    try:
        # Create Api Key
        api_response = api_instance.create_api_key_credentials_api_key_post(api_key_request)
        print("The response of EXTERNALApi->create_api_key_credentials_api_key_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_api_key_credentials_api_key_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
api_key_request	APIKeyRequest

Return type

APIKeyResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_checkout_payments_checkout_post

CreateCheckoutSessionResponse create_checkout_payments_checkout_post(create_checkout_request)

Create Checkout

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.create_checkout_request import CreateCheckoutRequest
from platform_api_python_client.models.create_checkout_session_response import CreateCheckoutSessionResponse
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)
    create_checkout_request = platform_api_python_client.CreateCheckoutRequest() # CreateCheckoutRequest | 

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

Parameters

Name	Type	Description	Notes
create_checkout_request	CreateCheckoutRequest

Return type

CreateCheckoutSessionResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_compute_deployment_deployments_compute_post

CreateComputeDeploymentResponse create_compute_deployment_deployments_compute_post(create_compute_deployment_request)

Create Compute Deployment

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.create_compute_deployment_request import CreateComputeDeploymentRequest
from platform_api_python_client.models.create_compute_deployment_response import CreateComputeDeploymentResponse
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)
    create_compute_deployment_request = platform_api_python_client.CreateComputeDeploymentRequest() # CreateComputeDeploymentRequest | 

    try:
        # Create Compute Deployment
        api_response = api_instance.create_compute_deployment_deployments_compute_post(create_compute_deployment_request)
        print("The response of EXTERNALApi->create_compute_deployment_deployments_compute_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_compute_deployment_deployments_compute_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_compute_deployment_request	CreateComputeDeploymentRequest

Return type

CreateComputeDeploymentResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_cserve_deployment_deployments_cserve_post

CreateCServeDeploymentResponse create_cserve_deployment_deployments_cserve_post(create_c_serve_deployment_request)

Create Cserve Deployment

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.create_c_serve_deployment_request import CreateCServeDeploymentRequest
from platform_api_python_client.models.create_c_serve_deployment_response import CreateCServeDeploymentResponse
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)
    create_c_serve_deployment_request = platform_api_python_client.CreateCServeDeploymentRequest() # CreateCServeDeploymentRequest | 

    try:
        # Create Cserve Deployment
        api_response = api_instance.create_cserve_deployment_deployments_cserve_post(create_c_serve_deployment_request)
        print("The response of EXTERNALApi->create_cserve_deployment_deployments_cserve_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_cserve_deployment_deployments_cserve_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_c_serve_deployment_request	CreateCServeDeploymentRequest

Return type

CreateCServeDeploymentResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_cserve_v2_deployment_deployments_cserve_v2_post

CreateCServeV2DeploymentResponse create_cserve_v2_deployment_deployments_cserve_v2_post(create_c_serve_v2_deployment_request)

Create Cserve V2 Deployment

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.create_c_serve_v2_deployment_request import CreateCServeV2DeploymentRequest
from platform_api_python_client.models.create_c_serve_v2_deployment_response import CreateCServeV2DeploymentResponse
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)
    create_c_serve_v2_deployment_request = platform_api_python_client.CreateCServeV2DeploymentRequest() # CreateCServeV2DeploymentRequest | 

    try:
        # Create Cserve V2 Deployment
        api_response = api_instance.create_cserve_v2_deployment_deployments_cserve_v2_post(create_c_serve_v2_deployment_request)
        print("The response of EXTERNALApi->create_cserve_v2_deployment_deployments_cserve_v2_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_cserve_v2_deployment_deployments_cserve_v2_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_c_serve_v2_deployment_request	CreateCServeV2DeploymentRequest

Return type

CreateCServeV2DeploymentResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_inference_deployment_deployments_inference_post

CreateInferenceDeploymentResponse create_inference_deployment_deployments_inference_post(create_inference_deployment_request)

Create Inference Deployment

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.create_inference_deployment_request import CreateInferenceDeploymentRequest
from platform_api_python_client.models.create_inference_deployment_response import CreateInferenceDeploymentResponse
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)
    create_inference_deployment_request = platform_api_python_client.CreateInferenceDeploymentRequest() # CreateInferenceDeploymentRequest | 

    try:
        # Create Inference Deployment
        api_response = api_instance.create_inference_deployment_deployments_inference_post(create_inference_deployment_request)
        print("The response of EXTERNALApi->create_inference_deployment_deployments_inference_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_inference_deployment_deployments_inference_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_inference_deployment_request	CreateInferenceDeploymentRequest

Return type

CreateInferenceDeploymentResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_rag_deployment_deployments_rag_post

CreateRagDeploymentResponse create_rag_deployment_deployments_rag_post(create_rag_deployment_request)

Create Rag Deployment

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.create_rag_deployment_request import CreateRagDeploymentRequest
from platform_api_python_client.models.create_rag_deployment_response import CreateRagDeploymentResponse
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)
    create_rag_deployment_request = platform_api_python_client.CreateRagDeploymentRequest() # CreateRagDeploymentRequest | 

    try:
        # Create Rag Deployment
        api_response = api_instance.create_rag_deployment_deployments_rag_post(create_rag_deployment_request)
        print("The response of EXTERNALApi->create_rag_deployment_deployments_rag_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_rag_deployment_deployments_rag_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_rag_deployment_request	CreateRagDeploymentRequest

Return type

CreateRagDeploymentResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_setup_payments_setup_checkout_post

CreateCheckoutSessionResponse create_setup_payments_setup_checkout_post(create_setup_checkout_request)

Create Setup

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.create_checkout_session_response import CreateCheckoutSessionResponse
from platform_api_python_client.models.create_setup_checkout_request import CreateSetupCheckoutRequest
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)
    create_setup_checkout_request = platform_api_python_client.CreateSetupCheckoutRequest() # CreateSetupCheckoutRequest | 

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

Parameters

Name	Type	Description	Notes
create_setup_checkout_request	CreateSetupCheckoutRequest

Return type

CreateCheckoutSessionResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_api_key_credentials_api_key_id_delete

object delete_api_key_credentials_api_key_id_delete(id)

Delete Api Key

Example

Bearer Authentication (HTTPBearer):

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)
    id = 'id_example' # str | 

    try:
        # Delete Api Key
        api_response = api_instance.delete_api_key_credentials_api_key_id_delete(id)
        print("The response of EXTERNALApi->delete_api_key_credentials_api_key_id_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->delete_api_key_credentials_api_key_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

object

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_user_vault_item_endpoint_user_vault_delete

object delete_user_vault_item_endpoint_user_vault_delete(user_vault_item_input)

Delete User Vault Item Endpoint

Delete an item of a specific type for the user.

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.user_vault_item_input import UserVaultItemInput
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)
    user_vault_item_input = platform_api_python_client.UserVaultItemInput() # UserVaultItemInput | 

    try:
        # Delete User Vault Item Endpoint
        api_response = api_instance.delete_user_vault_item_endpoint_user_vault_delete(user_vault_item_input)
        print("The response of EXTERNALApi->delete_user_vault_item_endpoint_user_vault_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->delete_user_vault_item_endpoint_user_vault_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_vault_item_input	UserVaultItemInput

Return type

object

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_user_vault_items_endpoint_user_vault_get

ListUserVaultItemsResponse get_all_user_vault_items_endpoint_user_vault_get(type=type, search_query=search_query)

Get All User Vault Items Endpoint

Retrieve all items of a specific type for the user.

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.list_user_vault_items_response import ListUserVaultItemsResponse
from platform_api_python_client.models.user_vault_type import UserVaultType
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)
    type = platform_api_python_client.UserVaultType() # UserVaultType |  (optional)
    search_query = 'search_query_example' # str |  (optional)

    try:
        # Get All User Vault Items Endpoint
        api_response = api_instance.get_all_user_vault_items_endpoint_user_vault_get(type=type, search_query=search_query)
        print("The response of EXTERNALApi->get_all_user_vault_items_endpoint_user_vault_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_all_user_vault_items_endpoint_user_vault_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
type	UserVaultType		[optional]
search_query	str		[optional]

Return type

ListUserVaultItemsResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_api_keys_credentials_api_key_get

ListAPIKeyResponse get_api_keys_credentials_api_key_get()

Get Api Keys

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.list_api_key_response import ListAPIKeyResponse
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)

    try:
        # Get Api Keys
        api_response = api_instance.get_api_keys_credentials_api_key_get()
        print("The response of EXTERNALApi->get_api_keys_credentials_api_key_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_api_keys_credentials_api_key_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ListAPIKeyResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_clusters_clusters_get

ListGetClusterResponse get_clusters_clusters_get()

Get Clusters

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.list_get_cluster_response import ListGetClusterResponse
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)

    try:
        # Get Clusters
        api_response = api_instance.get_clusters_clusters_get()
        print("The response of EXTERNALApi->get_clusters_clusters_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_clusters_clusters_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ListGetClusterResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_compute_deployment_deployments_compute_deployment_id_get

GetComputeDeploymentResponse get_compute_deployment_deployments_compute_deployment_id_get(deployment_id)

Get Compute Deployment

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.get_compute_deployment_response import GetComputeDeploymentResponse
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)
    deployment_id = 56 # int | 

    try:
        # Get Compute Deployment
        api_response = api_instance.get_compute_deployment_deployments_compute_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_compute_deployment_deployments_compute_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_compute_deployment_deployments_compute_deployment_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
deployment_id	int

Return type

GetComputeDeploymentResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_credits_credits_get

CreditsResponse get_credits_credits_get()

Get Credits

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.credits_response import CreditsResponse
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)

    try:
        # Get Credits
        api_response = api_instance.get_credits_credits_get()
        print("The response of EXTERNALApi->get_credits_credits_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_credits_credits_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CreditsResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_cserve_deployment_deployments_cserve_deployment_id_get

GetCServeDeploymentResponse get_cserve_deployment_deployments_cserve_deployment_id_get(deployment_id)

Get Cserve Deployment

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.get_c_serve_deployment_response import GetCServeDeploymentResponse
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)
    deployment_id = 56 # int | 

    try:
        # Get Cserve Deployment
        api_response = api_instance.get_cserve_deployment_deployments_cserve_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_cserve_deployment_deployments_cserve_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_cserve_deployment_deployments_cserve_deployment_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
deployment_id	int

Return type

GetCServeDeploymentResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_cserve_recipe_deployments_cserve_recipes_get

ListCServeRecipeResponse get_cserve_recipe_deployments_cserve_recipes_get(model=model, cluster_id=cluster_id)

Get Cserve Recipe

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.list_c_serve_recipe_response import ListCServeRecipeResponse
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)
    model = 'model_example' # str |  (optional)
    cluster_id = 56 # int |  (optional)

    try:
        # Get Cserve Recipe
        api_response = api_instance.get_cserve_recipe_deployments_cserve_recipes_get(model=model, cluster_id=cluster_id)
        print("The response of EXTERNALApi->get_cserve_recipe_deployments_cserve_recipes_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_cserve_recipe_deployments_cserve_recipes_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
model	str		[optional]
cluster_id	int		[optional]

Return type

ListCServeRecipeResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get

GetCServeV2DeploymentResponse get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get(deployment_id)

Get Cserve V2 Deployment

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.get_c_serve_v2_deployment_response import GetCServeV2DeploymentResponse
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)
    deployment_id = 56 # int | 

    try:
        # Get Cserve V2 Deployment
        api_response = api_instance.get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
deployment_id	int

Return type

GetCServeV2DeploymentResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_deployment_logs_deployments_logs_deployment_id_get

GetDeploymentLogResponse get_deployment_logs_deployments_logs_deployment_id_get(deployment_id, start_time, end_time, next_page_token=next_page_token)

Get Deployment Logs

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.get_deployment_log_response import GetDeploymentLogResponse
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)
    deployment_id = 56 # int | 
    start_time = 56 # int | 
    end_time = 56 # int | 
    next_page_token = 'next_page_token_example' # str |  (optional)

    try:
        # Get Deployment Logs
        api_response = api_instance.get_deployment_logs_deployments_logs_deployment_id_get(deployment_id, start_time, end_time, next_page_token=next_page_token)
        print("The response of EXTERNALApi->get_deployment_logs_deployments_logs_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_deployment_logs_deployments_logs_deployment_id_get: %s\n" % e)

Parameters

Name	Type	Notes
deployment_id	int
start_time	int
end_time	int
next_page_token	str	[optional]

Return type

GetDeploymentLogResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_deployment_status_deployments_status_deployment_id_get

DeploymentStatusResponse get_deployment_status_deployments_status_deployment_id_get(deployment_id)

Get Deployment Status

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.deployment_status_response import DeploymentStatusResponse
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)
    deployment_id = 56 # int | 

    try:
        # Get Deployment Status
        api_response = api_instance.get_deployment_status_deployments_status_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_deployment_status_deployments_status_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_deployment_status_deployments_status_deployment_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
deployment_id	int

Return type

DeploymentStatusResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_deployments_deployments_get

ListGetDeploymentResponse get_deployments_deployments_get(offset=offset, limit=limit, type=type, search_query=search_query)

Get Deployments

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.deployment_type import DeploymentType
from platform_api_python_client.models.list_get_deployment_response import ListGetDeploymentResponse
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)
    offset = 56 # int |  (optional)
    limit = 56 # int |  (optional)
    type = platform_api_python_client.DeploymentType() # DeploymentType |  (optional)
    search_query = 'search_query_example' # str |  (optional)

    try:
        # Get Deployments
        api_response = api_instance.get_deployments_deployments_get(offset=offset, limit=limit, type=type, search_query=search_query)
        print("The response of EXTERNALApi->get_deployments_deployments_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_deployments_deployments_get: %s\n" % e)

Parameters

Name	Type	Notes
offset	int	[optional]
limit	int	[optional]
type	DeploymentType	[optional]
search_query	str	[optional]

Return type

ListGetDeploymentResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_hardware_instances_hardware_instances_get

ListHardwareInstanceResponse get_hardware_instances_hardware_instances_get(cluster_id=cluster_id)

Get Hardware Instances

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.list_hardware_instance_response import ListHardwareInstanceResponse
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_id = 56 # int |  (optional)

    try:
        # Get Hardware Instances
        api_response = api_instance.get_hardware_instances_hardware_instances_get(cluster_id=cluster_id)
        print("The response of EXTERNALApi->get_hardware_instances_hardware_instances_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_hardware_instances_hardware_instances_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
cluster_id	int		[optional]

Return type

ListHardwareInstanceResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_inference_deployment_deployments_inference_deployment_id_get

GetInferenceDeploymentResponse get_inference_deployment_deployments_inference_deployment_id_get(deployment_id)

Get Inference Deployment

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.get_inference_deployment_response import GetInferenceDeploymentResponse
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)
    deployment_id = 56 # int | 

    try:
        # Get Inference Deployment
        api_response = api_instance.get_inference_deployment_deployments_inference_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_inference_deployment_deployments_inference_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_inference_deployment_deployments_inference_deployment_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
deployment_id	int

Return type

GetInferenceDeploymentResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_payments_payments_get

GetPaymentsResponse get_payments_payments_get(limit=limit, starting_after=starting_after)

Get Payments

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.get_payments_response import GetPaymentsResponse
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)
    limit = 10 # int |  (optional) (default to 10)
    starting_after = 'starting_after_example' # str |  (optional)

    try:
        # Get Payments
        api_response = api_instance.get_payments_payments_get(limit=limit, starting_after=starting_after)
        print("The response of EXTERNALApi->get_payments_payments_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_payments_payments_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int		[optional] [default to 10]
starting_after	str		[optional]

Return type

GetPaymentsResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_prebuilt_images_prebuilt_images_get

ListPrebuiltImageResponse get_prebuilt_images_prebuilt_images_get(type=type)

Get Prebuilt Images

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.deployment_type import DeploymentType
from platform_api_python_client.models.list_prebuilt_image_response import ListPrebuiltImageResponse
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)
    type = platform_api_python_client.DeploymentType() # DeploymentType |  (optional)

    try:
        # Get Prebuilt Images
        api_response = api_instance.get_prebuilt_images_prebuilt_images_get(type=type)
        print("The response of EXTERNALApi->get_prebuilt_images_prebuilt_images_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_prebuilt_images_prebuilt_images_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
type	DeploymentType		[optional]

Return type

ListPrebuiltImageResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_rag_deployment_deployments_rag_deployment_id_get

GetRagDeploymentResponse get_rag_deployment_deployments_rag_deployment_id_get(deployment_id)

Get Rag Deployment

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.get_rag_deployment_response import GetRagDeploymentResponse
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)
    deployment_id = 56 # int | 

    try:
        # Get Rag Deployment
        api_response = api_instance.get_rag_deployment_deployments_rag_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_rag_deployment_deployments_rag_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_rag_deployment_deployments_rag_deployment_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
deployment_id	int

Return type

GetRagDeploymentResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_usage_daily_bills_get

ListDailyBillResponse get_usage_daily_bills_get(start_date, end_date)

Get Usage

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.list_daily_bill_response import ListDailyBillResponse
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)
    start_date = '2013-10-20' # date | 
    end_date = '2013-10-20' # date | 

    try:
        # Get Usage
        api_response = api_instance.get_usage_daily_bills_get(start_date, end_date)
        print("The response of EXTERNALApi->get_usage_daily_bills_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_usage_daily_bills_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
start_date	date
end_date	date

Return type

ListDailyBillResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_usage_deployments_usage_deployment_id_get

GetDeploymentUsageResponse get_usage_deployments_usage_deployment_id_get(deployment_id, metric, duration, end_time=end_time)

Get Usage

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.get_deployment_usage_response import GetDeploymentUsageResponse
from platform_api_python_client.models.metric import Metric
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)
    deployment_id = 56 # int | 
    metric = platform_api_python_client.Metric() # Metric | 
    duration = 56 # int | 
    end_time = 56 # int |  (optional)

    try:
        # Get Usage
        api_response = api_instance.get_usage_deployments_usage_deployment_id_get(deployment_id, metric, duration, end_time=end_time)
        print("The response of EXTERNALApi->get_usage_deployments_usage_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_usage_deployments_usage_deployment_id_get: %s\n" % e)

Parameters

Name	Type	Notes
deployment_id	int
metric	Metric
duration	int
end_time	int	[optional]

Return type

GetDeploymentUsageResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setup_stripe_customer_payments_setup_post

object setup_stripe_customer_payments_setup_post()

Setup Stripe Customer

Example

Bearer Authentication (HTTPBearer):

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)

    try:
        # Setup Stripe Customer
        api_response = api_instance.setup_stripe_customer_payments_setup_post()
        print("The response of EXTERNALApi->setup_stripe_customer_payments_setup_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->setup_stripe_customer_payments_setup_post: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_deployment_status_deployments_status_deployment_id_put

DeploymentStatusResponse update_deployment_status_deployments_status_deployment_id_put(deployment_id, deployment_status_request)

Update Deployment Status

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.deployment_status_request import DeploymentStatusRequest
from platform_api_python_client.models.deployment_status_response import DeploymentStatusResponse
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)
    deployment_id = 56 # int | 
    deployment_status_request = platform_api_python_client.DeploymentStatusRequest() # DeploymentStatusRequest | 

    try:
        # Update Deployment Status
        api_response = api_instance.update_deployment_status_deployments_status_deployment_id_put(deployment_id, deployment_status_request)
        print("The response of EXTERNALApi->update_deployment_status_deployments_status_deployment_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_deployment_status_deployments_status_deployment_id_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
deployment_id	int
deployment_status_request	DeploymentStatusRequest

Return type

DeploymentStatusResponse

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_user_vault_item_endpoint_user_vault_put

object update_user_vault_item_endpoint_user_vault_put(user_vault_item_input)

Update User Vault Item Endpoint

Update or add multiple items of a specific type for the user.

Example

Bearer Authentication (HTTPBearer):

import platform_api_python_client
from platform_api_python_client.models.user_vault_item_input import UserVaultItemInput
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)
    user_vault_item_input = platform_api_python_client.UserVaultItemInput() # UserVaultItemInput | 

    try:
        # Update User Vault Item Endpoint
        api_response = api_instance.update_user_vault_item_endpoint_user_vault_put(user_vault_item_input)
        print("The response of EXTERNALApi->update_user_vault_item_endpoint_user_vault_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_user_vault_item_endpoint_user_vault_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_vault_item_input	UserVaultItemInput

Return type

object

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

EXTERNALApi.md

Latest commit

History

EXTERNALApi.md

File metadata and controls

platform_api_python_client.EXTERNALApi

add_user_request_support_user_requests_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_api_key_credentials_api_key_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_checkout_payments_checkout_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_compute_deployment_deployments_compute_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_cserve_deployment_deployments_cserve_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_cserve_v2_deployment_deployments_cserve_v2_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_inference_deployment_deployments_inference_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_rag_deployment_deployments_rag_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_setup_payments_setup_checkout_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_api_key_credentials_api_key_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_user_vault_item_endpoint_user_vault_delete

Example

Parameters