Welcome to the SaladCloudSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudSdk SDK in your project.
- API version:
0.9.0-alpha.6
- SDK version:
0.9.0-alpha.6
The SaladCloud REST API. Please refer to the SaladCloud API Documentation for more details.
This SDK is compatible with the following versions: C# >= .NET 6
To get started with the SDK, we recommend installing using nuget
:
dotnet add package Salad.Cloud.SDK
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.
When you initialize the SDK, you can set the API key as follows:
using Salad.Cloud.SDK;
using Salad.Cloud.SDK.Config;
var config = new Salad.Cloud.SDKConfig()
{
ApiKeyAuth = new ApiKeyAuthConfig("YOUR_API_KEY")
};
var client = new SaladCloudSdkClient(config);
If you need to set or update the API key after initializing the SDK, you can use:
client.SetApiKey("YOUR_API_KEY")
Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
using Salad.Cloud.SDK;
using Salad.Cloud.SDK.Config;
using Environment = Salad.Cloud.SDK.Http.Environment;
var apiKeyConfig = new ApiKeyAuthConfig("YOUR_API_KEY");
var config = new SaladCloudSdkConfig
{
Environment = Environment.Default,
ApiKeyAuth = apiKeyConfig
};
var client = new SaladCloudSdkClient(config);
var response = await client.Quotas.GetQuotasAsync("j5rb91fzs3spaw4grzs1ulr8elj96ymws");
Console.WriteLine(response);
The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
Name |
---|
ContainerGroupsService |
WorkloadErrorsService |
SystemLogsService |
QueuesService |
QuotasService |
InferenceEndpointsService |
OrganizationDataService |
WebhookSecretKeyService |
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 with links to their detailed documentation:
This SDK is licensed under the MIT License.
See the LICENSE file for more details.