Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 4.9.6
- Package version: 4.9.7
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

Expand Down Expand Up @@ -100,6 +100,7 @@ Class | Method | HTTP request | Description
*EXTERNALApi* | [**create_cserve_v3_deployment_deployments_cserve_v3_post**](docs/EXTERNALApi.md#create_cserve_v3_deployment_deployments_cserve_v3_post) | **POST** /deployments/cserve_v3 | Create Cserve V3 Deployment
*EXTERNALApi* | [**create_inference_deployment_deployments_inference_post**](docs/EXTERNALApi.md#create_inference_deployment_deployments_inference_post) | **POST** /deployments/inference | Create Inference Deployment
*EXTERNALApi* | [**create_inference_v3_deployment_deployments_inference_v3_post**](docs/EXTERNALApi.md#create_inference_v3_deployment_deployments_inference_v3_post) | **POST** /deployments/inference_v3 | Create Inference V3 Deployment
*EXTERNALApi* | [**create_job_deployment_deployments_job_post**](docs/EXTERNALApi.md#create_job_deployment_deployments_job_post) | **POST** /deployments/job | Create Job Deployment
*EXTERNALApi* | [**create_new_organization_organizations_post**](docs/EXTERNALApi.md#create_new_organization_organizations_post) | **POST** /organizations | Create New Organization
*EXTERNALApi* | [**delete_api_key_credentials_api_key_id_delete**](docs/EXTERNALApi.md#delete_api_key_credentials_api_key_id_delete) | **DELETE** /credentials/api-key/{id} | Delete Api Key
*EXTERNALApi* | [**delete_user_vault_item_endpoint_user_vault_delete**](docs/EXTERNALApi.md#delete_user_vault_item_endpoint_user_vault_delete) | **DELETE** /user_vault | Delete User Vault Item Endpoint
Expand All @@ -122,6 +123,7 @@ Class | Method | HTTP request | Description
*EXTERNALApi* | [**get_hardware_instances_hardware_instances_get**](docs/EXTERNALApi.md#get_hardware_instances_hardware_instances_get) | **GET** /hardware-instances | Get Hardware Instances
*EXTERNALApi* | [**get_inference_deployment_deployments_inference_deployment_id_get**](docs/EXTERNALApi.md#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**](docs/EXTERNALApi.md#get_inference_v3_deployment_deployments_inference_v3_deployment_id_get) | **GET** /deployments/inference_v3/{deployment_id} | Get Inference V3 Deployment
*EXTERNALApi* | [**get_job_deployment_deployments_job_deployment_id_get**](docs/EXTERNALApi.md#get_job_deployment_deployments_job_deployment_id_get) | **GET** /deployments/job/{deployment_id} | Get Job Deployment
*EXTERNALApi* | [**get_prebuilt_images_prebuilt_images_get**](docs/EXTERNALApi.md#get_prebuilt_images_prebuilt_images_get) | **GET** /prebuilt-images | Get Prebuilt Images
*EXTERNALApi* | [**get_usage_daily_bills_get**](docs/EXTERNALApi.md#get_usage_daily_bills_get) | **GET** /daily_bills | Get Usage
*EXTERNALApi* | [**get_usage_deployments_usage_deployment_id_get**](docs/EXTERNALApi.md#get_usage_deployments_usage_deployment_id_get) | **GET** /deployments/usage/{deployment_id} | Get Usage
Expand Down Expand Up @@ -149,6 +151,7 @@ Class | Method | HTTP request | Description
- [CServeRecipeResponse](docs/CServeRecipeResponse.md)
- [CServeV2Recipe](docs/CServeV2Recipe.md)
- [ClusterCapacityResponse](docs/ClusterCapacityResponse.md)
- [ConfigFileMount](docs/ConfigFileMount.md)
- [CreateCServeV2DeploymentRequest](docs/CreateCServeV2DeploymentRequest.md)
- [CreateCServeV2DeploymentResponse](docs/CreateCServeV2DeploymentResponse.md)
- [CreateCServeV3DeploymentRequest](docs/CreateCServeV3DeploymentRequest.md)
Expand All @@ -158,6 +161,8 @@ Class | Method | HTTP request | Description
- [CreateInferenceDeploymentRequest](docs/CreateInferenceDeploymentRequest.md)
- [CreateInferenceDeploymentResponse](docs/CreateInferenceDeploymentResponse.md)
- [CreateInferenceV3DeploymentRequest](docs/CreateInferenceV3DeploymentRequest.md)
- [CreateJobDeploymentRequest](docs/CreateJobDeploymentRequest.md)
- [CreateJobDeploymentResponse](docs/CreateJobDeploymentResponse.md)
- [CreateOrganizationRequest](docs/CreateOrganizationRequest.md)
- [CreateOrganizationResponse](docs/CreateOrganizationResponse.md)
- [CreateUrlRequest](docs/CreateUrlRequest.md)
Expand All @@ -182,6 +187,7 @@ Class | Method | HTTP request | Description
- [GetDeploymentUsageResponse](docs/GetDeploymentUsageResponse.md)
- [GetInferenceDeploymentResponse](docs/GetInferenceDeploymentResponse.md)
- [GetInferenceV3DeploymentResponse](docs/GetInferenceV3DeploymentResponse.md)
- [GetJobDeploymentResponse](docs/GetJobDeploymentResponse.md)
- [GpuTypeCapacity](docs/GpuTypeCapacity.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [HardwareInstanceResponse](docs/HardwareInstanceResponse.md)
Expand Down
31 changes: 31 additions & 0 deletions docs/ConfigFileMount.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# ConfigFileMount


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**filename** | **str** | |
**mount_path** | **str** | |
**content** | **str** | |

## Example

```python
from platform_api_python_client.models.config_file_mount import ConfigFileMount

# TODO update the JSON string below
json = "{}"
# create an instance of ConfigFileMount from a JSON string
config_file_mount_instance = ConfigFileMount.from_json(json)
# print the JSON string representation of the object
print(ConfigFileMount.to_json())

# convert the object into a dict
config_file_mount_dict = config_file_mount_instance.to_dict()
# create an instance of ConfigFileMount from a dict
config_file_mount_from_dict = ConfigFileMount.from_dict(config_file_mount_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/CreateInferenceV3DeploymentRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Name | Type | Description | Notes
**backend_protocol** | [**BackendProtocol**](BackendProtocol.md) | | [optional]
**enable_logging** | **bool** | | [optional] [default to False]
**session_affinity** | **bool** | Enable best-effort sticky routing via the `X-Session-Id` request header. Requests carrying the same header value land on the same pod, improving KV cache reuse for agentic workloads. Requests without the header are routed at random. Affinity is NOT durable: scaling, rollouts, restarts, or readiness-probe transitions will remap sessions to different pods. Do not use for irreplaceable in-pod state. | [optional] [default to False]
**config_file** | [**ConfigFileMount**](ConfigFileMount.md) | | [optional]

## Example

Expand Down
39 changes: 39 additions & 0 deletions docs/CreateJobDeploymentRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# CreateJobDeploymentRequest


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | |
**cluster_id** | **int** | |
**hardware_instance_id** | **int** | |
**user_annotations** | **Dict[str, str]** | | [optional]
**image_url** | **str** | |
**image_pull_secret_credentials** | [**ImagePullSecretCredentials**](ImagePullSecretCredentials.md) | | [optional]
**env_vars** | **Dict[str, str]** | | [optional]
**command** | **str** | | [optional]
**completions** | **int** | | [optional] [default to 1]
**parallelism** | **int** | | [optional] [default to 1]
**enable_logging** | **bool** | | [optional] [default to True]

## Example

```python
from platform_api_python_client.models.create_job_deployment_request import CreateJobDeploymentRequest

# TODO update the JSON string below
json = "{}"
# create an instance of CreateJobDeploymentRequest from a JSON string
create_job_deployment_request_instance = CreateJobDeploymentRequest.from_json(json)
# print the JSON string representation of the object
print(CreateJobDeploymentRequest.to_json())

# convert the object into a dict
create_job_deployment_request_dict = create_job_deployment_request_instance.to_dict()
# create an instance of CreateJobDeploymentRequest from a dict
create_job_deployment_request_from_dict = CreateJobDeploymentRequest.from_dict(create_job_deployment_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


31 changes: 31 additions & 0 deletions docs/CreateJobDeploymentResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# CreateJobDeploymentResponse


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | |
**created_at** | **datetime** | |
**endpoint_url** | **str** | |

## Example

```python
from platform_api_python_client.models.create_job_deployment_response import CreateJobDeploymentResponse

# TODO update the JSON string below
json = "{}"
# create an instance of CreateJobDeploymentResponse from a JSON string
create_job_deployment_response_instance = CreateJobDeploymentResponse.from_json(json)
# print the JSON string representation of the object
print(CreateJobDeploymentResponse.to_json())

# convert the object into a dict
create_job_deployment_response_dict = create_job_deployment_response_instance.to_dict()
# create an instance of CreateJobDeploymentResponse from a dict
create_job_deployment_response_from_dict = CreateJobDeploymentResponse.from_dict(create_job_deployment_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/DeploymentResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Name | Type | Description | Notes
**original_command** | **str** | | [optional]
**image_pull_secret_credentials** | [**ImagePullSecretCredentials**](ImagePullSecretCredentials.md) | | [optional]
**backend_protocol** | [**BackendProtocol**](BackendProtocol.md) | | [optional]
**config_file** | [**ConfigFileMount**](ConfigFileMount.md) | | [optional]

## Example

Expand Down
2 changes: 2 additions & 0 deletions docs/DeploymentType.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@

* `RAG` (value: `'rag'`)

* `JOB` (value: `'job'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


157 changes: 157 additions & 0 deletions docs/EXTERNALApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Method | HTTP request | Description
[**create_cserve_v3_deployment_deployments_cserve_v3_post**](EXTERNALApi.md#create_cserve_v3_deployment_deployments_cserve_v3_post) | **POST** /deployments/cserve_v3 | Create Cserve V3 Deployment
[**create_inference_deployment_deployments_inference_post**](EXTERNALApi.md#create_inference_deployment_deployments_inference_post) | **POST** /deployments/inference | Create Inference Deployment
[**create_inference_v3_deployment_deployments_inference_v3_post**](EXTERNALApi.md#create_inference_v3_deployment_deployments_inference_v3_post) | **POST** /deployments/inference_v3 | Create Inference V3 Deployment
[**create_job_deployment_deployments_job_post**](EXTERNALApi.md#create_job_deployment_deployments_job_post) | **POST** /deployments/job | Create Job Deployment
[**create_new_organization_organizations_post**](EXTERNALApi.md#create_new_organization_organizations_post) | **POST** /organizations | Create New Organization
[**delete_api_key_credentials_api_key_id_delete**](EXTERNALApi.md#delete_api_key_credentials_api_key_id_delete) | **DELETE** /credentials/api-key/{id} | Delete Api Key
[**delete_user_vault_item_endpoint_user_vault_delete**](EXTERNALApi.md#delete_user_vault_item_endpoint_user_vault_delete) | **DELETE** /user_vault | Delete User Vault Item Endpoint
Expand All @@ -32,6 +33,7 @@ Method | HTTP request | Description
[**get_hardware_instances_hardware_instances_get**](EXTERNALApi.md#get_hardware_instances_hardware_instances_get) | **GET** /hardware-instances | Get Hardware Instances
[**get_inference_deployment_deployments_inference_deployment_id_get**](EXTERNALApi.md#get_inference_deployment_deployments_inference_deployment_id_get) | **GET** /deployments/inference/{deployment_id} | Get Inference Deployment
[**get_inference_v3_deployment_deployments_inference_v3_deployment_id_get**](EXTERNALApi.md#get_inference_v3_deployment_deployments_inference_v3_deployment_id_get) | **GET** /deployments/inference_v3/{deployment_id} | Get Inference V3 Deployment
[**get_job_deployment_deployments_job_deployment_id_get**](EXTERNALApi.md#get_job_deployment_deployments_job_deployment_id_get) | **GET** /deployments/job/{deployment_id} | Get Job Deployment
[**get_prebuilt_images_prebuilt_images_get**](EXTERNALApi.md#get_prebuilt_images_prebuilt_images_get) | **GET** /prebuilt-images | Get Prebuilt Images
[**get_usage_daily_bills_get**](EXTERNALApi.md#get_usage_daily_bills_get) | **GET** /daily_bills | Get Usage
[**get_usage_deployments_usage_deployment_id_get**](EXTERNALApi.md#get_usage_deployments_usage_deployment_id_get) | **GET** /deployments/usage/{deployment_id} | Get Usage
Expand Down Expand Up @@ -518,6 +520,84 @@ Name | Type | Description | Notes

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_job_deployment_deployments_job_post**
> CreateJobDeploymentResponse create_job_deployment_deployments_job_post(create_job_deployment_request)

Create Job Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.create_job_deployment_request import CreateJobDeploymentRequest
from platform_api_python_client.models.create_job_deployment_response import CreateJobDeploymentResponse
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_job_deployment_request = platform_api_python_client.CreateJobDeploymentRequest() # CreateJobDeploymentRequest |

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



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**create_job_deployment_request** | [**CreateJobDeploymentRequest**](CreateJobDeploymentRequest.md)| |

### Return type

[**CreateJobDeploymentResponse**](CreateJobDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_new_organization_organizations_post**
> CreateOrganizationResponse create_new_organization_organizations_post(create_organization_request)

Expand Down Expand Up @@ -2242,6 +2322,83 @@ Name | Type | Description | Notes

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_job_deployment_deployments_job_deployment_id_get**
> GetJobDeploymentResponse get_job_deployment_deployments_job_deployment_id_get(deployment_id)

Get Job Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_job_deployment_response import GetJobDeploymentResponse
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 Job Deployment
api_response = api_instance.get_job_deployment_deployments_job_deployment_id_get(deployment_id)
print("The response of EXTERNALApi->get_job_deployment_deployments_job_deployment_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling EXTERNALApi->get_job_deployment_deployments_job_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**deployment_id** | **int**| |

### Return type

[**GetJobDeploymentResponse**](GetJobDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_prebuilt_images_prebuilt_images_get**
> ListPrebuiltImageResponse get_prebuilt_images_prebuilt_images_get(type=type)

Expand Down
1 change: 1 addition & 0 deletions docs/GetInferenceV3DeploymentResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Name | Type | Description | Notes
**backend_protocol** | [**BackendProtocol**](BackendProtocol.md) | | [optional]
**enable_logging** | **bool** | | [optional] [default to True]
**session_affinity** | **bool** | Enable best-effort sticky routing via the `X-Session-Id` request header. Requests carrying the same header value land on the same pod, improving KV cache reuse for agentic workloads. Requests without the header are routed at random. Affinity is NOT durable: scaling, rollouts, restarts, or readiness-probe transitions will remap sessions to different pods. Do not use for irreplaceable in-pod state. | [optional] [default to False]
**config_file** | [**ConfigFileMount**](ConfigFileMount.md) | | [optional]

## Example

Expand Down
Loading
Loading