salad-cloud-sdk 0.9.0a7

The SaladCloud REST API. Please refer to the [SaladCloud API Documentation](https://docs.salad.com/api-reference) for more details.

SaladCloudSdk Python SDK 0.9.0-alpha.7

Welcome to the SaladCloudSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudSdk SDK in your project.

Versions

• API version: 0.9.0-alpha.7
• SDK version: 0.9.0-alpha.7

About the API

The SaladCloud REST API. Please refer to the SaladCloud API Documentation for more details.

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • API Key Authentication
• Setting a Custom Timeout
• Sample Usage
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install salad-cloud-sdk

Authentication

API Key Authentication

The SaladCloudSdk API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.

Setting the API key

When you initialize the SDK, you can set the API key as follows:

SaladCloudSdk(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)

If you need to set or update the API key after initializing the SDK, you can use:

sdk.set_api_key("YOUR_API_KEY", "YOUR_API_KEY_HEADER")

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

from salad_cloud_sdk import SaladCloudSdk

sdk = SaladCloudSdk(timeout=10000)

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

from salad_cloud_sdk import SaladCloudSdk

sdk = SaladCloudSdk(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)

result = sdk.quotas.get_quotas(organization_name="acme-corp")

print(result)

Async Usage

The SDK includes an Async Client for making asynchronous API requests. This is useful for applications that need non-blocking operations, like web servers or apps with a graphical user interface.

import asyncio
from salad_cloud_sdk import SaladCloudSdkAsync

sdk = SaladCloudSdkAsync(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)


async def main():
  result = await sdk.quotas.get_quotas(organization_name="acme-corp")
  print(result)

asyncio.run(main())

Services

The SDK provides various services to interact with the API.

Below is a list of all available services:

Name
container_groups
workload_errors
system_logs
queues
quotas
inference_endpoints
organization_data
webhook_secret_key

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models:

Name	Description
ContainerGroupList	Represents a list of container groups
CreateContainerGroup	Represents a request to create a container group
ContainerGroup	Represents a container group
UpdateContainerGroup	Represents a request to update a container group
ContainerGroupInstances	Represents a list of container group instances
ContainerGroupInstance	Represents the details of a single container group instance
WorkloadErrorList	Represents a list of workload errors
SystemLogList	Represents a list of system logs
QueueList	Represents a list of queues
CreateQueue	Represents a request to create a new queue.
Queue	Represents a queue.
UpdateQueue	Represents a request to update an existing queue.
QueueJobList	Represents a list of queue jobs
CreateQueueJob	Represents a request to create a queue job
QueueJob	Represents a queue job
Quotas	Represents the organization quotas
InferenceEndpointList	Represents a page from the collection of inference endpoints.
InferenceEndpoint	Represents an inference endpoint
InferenceEndpointJobList	Represents a list of inference endpoint jobs
CreateInferenceEndpointJob	Represents a request to create a inference endpoint job
InferenceEndpointJob	Represents a inference endpoint job
GpuClassesList	Represents a list of GPU classes
WebhookSecretKey	Represents a webhook secret key
Container	Represents a container
ContainerRestartPolicy
ContainerGroupState	Represents a container group state
CountryCode
ContainerGroupNetworking	Represents container group networking parameters
ContainerGroupLivenessProbe	Represents the container group liveness probe
ContainerGroupReadinessProbe	Represents the container group readiness probe
ContainerGroupStartupProbe	Represents the container group startup probe
ContainerGroupQueueConnection	Represents container group queue connection
QueueAutoscaler	Represents the autoscaling rules for a queue
ContainerResourceRequirements	Represents a container resource requirements
ContainerGroupPriority
ContainerGroupStatus
ContainerGroupInstanceStatusCount	Represents a container group instance status count
ContainerNetworkingProtocol
ContainerGroupProbeTcp
ContainerGroupProbeHttp
ContainerGroupProbeGrpc
ContainerGroupProbeExec
ContainerProbeHttpScheme
ContainerGroupProbeHttpHeaders2
CreateContainer	Represents a container
CreateContainerGroupNetworking	Represents container group networking parameters
UpdateContainer	Represents an update container object
UpdateContainerGroupNetworking	Represents update container group networking parameters
WorkloadError	Represents a workload error
SystemLog	Represents a system log
QueueJobEvent	Represents an event for queue job
ContainerGroupsQuotas
Status	The current status.
InferenceEndpointJobEvent	Represents an event for inference endpoint job
InferenceEndpointJobEventAction
GpuClass	Represents a GPU Class
GpuClassPrice	Represents the price of a GPU class for a given container group priority

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.