Jump to Content

Docs API Reference Release Notes

API Reference

Docs API Reference Release Notes

CAST.AI API documentation

AuthAPI
BillingAPI
AIEnablerAPI
AIEnablerPlaygroundAPI
- [Deprecated] Use /ai-optimizer/v1beta/organizations/{organization_id}/playground-chat-completions instead.post
AIEnablerProvidersAPI
AIEnablerSettingsAPI
- Returns the settings of the LLM Optimizer. If the apiKey query parameter is specified, fetches the settings for that apiKey. Otherwise, fetches the settings for the current organization. If there are no apiKey-specific settings, returns organization settings.get
- Updates the settings of the LLM Optimizer.put
APAAPI
- Get install command for APA agent.get
AuditAPI
- ListAuditEntries returns audit entries for given cluster.get
AuthTokenAPI
AutoscalerAPI
ClusterActionsAPI
ComponentsAPI
- IngestLogs accepts logs from CAST AI components running outside of the mother-ship.post
AllocationGroupAPI
ClusterReportAPI
ReportConfigurationAPI
PlatformImpactReportAPI
- Gets cost comparison report for two different periods. All clusters or selected.get
NamespaceReportAPI
NodeReportAPI
ReportMetricsAPI
WorkloadReportAPI
DedicatedInstanceAPI
- ListDedicatedInstances returns list of dedicated instances.get
EvictorAPI
- Gets evictor advanced configuration for the target cluster.get
- Upsert cluster's evictor advanced configuration.post
ExternalClusterAPI
FeaturesAPI
- List all available feature flagsget
- Resolve resolves a flags for the provided contextpost
InsightsAPI
InventoryBlacklistAPI
CommitmentsAPI
DiscountsAPI
InventoryAPI
PricingAPI
NodeConfigurationAPI
NodeTemplatesAPI
NotificationAPI
OperationsAPI
- GetOperation returns the operation object by ID.get
PartnersAPI
PodMutationsAPI
PoliciesAPI
DboAPI
RbacServiceAPI
RuntimeSecurityAPI
ScheduledRebalancingAPI
ServiceAccountsAPI
SSOAPI
UsageAPI
- [Deprecated] Use /v1/billing/usage-report instead.get
- [Deprecated] Use /v1/billing/usage-report instead.get
UsersAPI
WorkloadOptimizationAPI

AI Enabler

ComponentsAPI
- List CASTware components.get
HostedModelSpecsAPI
- List hosted model specs.get
HostedModelsAPI
OnboardingAPI
- Get the onboarding command.get
- Get the onboarding script.get
PlaygroundChatCompletionsAPI
- Create playground chat completion.post
SettingsAPI
SurveysAPI
- Get survey status.get
- Update survey status.patch

Patching Engine

PodMutationsAPI

Cluster Autoscaler

HibernationJobsAPI
HibernationSchedulesAPI

Inventory

CloudAssetIntegrationsAPI

Pricing

CommitmentsAPI
PricingAPI
- Get default pricing for Cast Anywhere clusters.get

CAST.AI API documentation

AuthAPI
BillingAPI
AIEnablerAPI
AIEnablerPlaygroundAPI
- [Deprecated] Use /ai-optimizer/v1beta/organizations/{organization_id}/playground-chat-completions instead.post
AIEnablerProvidersAPI
AIEnablerSettingsAPI
- Returns the settings of the LLM Optimizer. If the apiKey query parameter is specified, fetches the settings for that apiKey. Otherwise, fetches the settings for the current organization. If there are no apiKey-specific settings, returns organization settings.get
- Updates the settings of the LLM Optimizer.put
APAAPI
- Get install command for APA agent.get
AuditAPI
- ListAuditEntries returns audit entries for given cluster.get
AuthTokenAPI
AutoscalerAPI
ClusterActionsAPI
ComponentsAPI
- IngestLogs accepts logs from CAST AI components running outside of the mother-ship.post
AllocationGroupAPI
ClusterReportAPI
ReportConfigurationAPI
PlatformImpactReportAPI
- Gets cost comparison report for two different periods. All clusters or selected.get
NamespaceReportAPI
NodeReportAPI
ReportMetricsAPI
WorkloadReportAPI
DedicatedInstanceAPI
- ListDedicatedInstances returns list of dedicated instances.get
EvictorAPI
- Gets evictor advanced configuration for the target cluster.get
- Upsert cluster's evictor advanced configuration.post
ExternalClusterAPI
FeaturesAPI
- List all available feature flagsget
- Resolve resolves a flags for the provided contextpost
InsightsAPI
InventoryBlacklistAPI
CommitmentsAPI
DiscountsAPI
InventoryAPI
PricingAPI
NodeConfigurationAPI
NodeTemplatesAPI
NotificationAPI
OperationsAPI
- GetOperation returns the operation object by ID.get
PartnersAPI
PodMutationsAPI
PoliciesAPI
DboAPI
RbacServiceAPI
RuntimeSecurityAPI
ScheduledRebalancingAPI
ServiceAccountsAPI
SSOAPI
UsageAPI
- [Deprecated] Use /v1/billing/usage-report instead.get
- [Deprecated] Use /v1/billing/usage-report instead.get
UsersAPI
WorkloadOptimizationAPI

AI Enabler

ComponentsAPI
- List CASTware components.get
HostedModelSpecsAPI
- List hosted model specs.get
HostedModelsAPI
OnboardingAPI
- Get the onboarding command.get
- Get the onboarding script.get
PlaygroundChatCompletionsAPI
- Create playground chat completion.post
SettingsAPI
SurveysAPI
- Get survey status.get
- Update survey status.patch

Patching Engine

PodMutationsAPI

Cluster Autoscaler

HibernationJobsAPI
HibernationSchedulesAPI

Inventory

CloudAssetIntegrationsAPI

Pricing

CommitmentsAPI
PricingAPI
- Get default pricing for Cast Anywhere clusters.get

Update database instance

put https://api.cast.ai/v1/dbo/db-instances/{id}

Updates database instance.

Language

Credentials

Click Try It! to start a request and see the response here!