Jump to Content

Docs API Reference Release Notes

API Reference

Docs API Reference Release Notes

All

Pages

Start typing to search…

MCP Server

MCP

CAST.AI API documentation

AuthAPI
BillingAPI
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
AuditAPI
- ListAuditEntries returns audit entries for given cluster.get
AuthTokenAPI
AutoscalerAPI
ClusterActionsAPI
ComponentsAPI
AllocationGroupAPI
ClusterReportAPI
ReportConfigurationAPI
IdleResourcesAPI
- List idle disks in all connected clouds.get
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
ImageProviderAPI
- Get base images by name and tag prefixget
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
StorageOptimizationAPI
UsageAPI
- [Deprecated] Use /v1/billing/usage-report instead.get
- [Deprecated] Use /v1/billing/usage-report instead.get
UsersAPI
VulnerabilityFunnelAPI
WorkloadOptimizationAPI
AIEnablerAPI

AI Enabler

APIKeysAPI
- Verify API keypost
- Create API keypost
AnalyticsAPI
- Generate AI Enabler Analytics Dataget
ComponentsAPI
- List CASTware components.get
EmbeddingsAPI
- Create embeddingpost
HostedModelEventsAPI
- List hosted model events.get
HostedModelsAPI
ModelRegistriesAPI
ModelSpecsAPI
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

Inventory

CloudAssetAPI
- Lists clusters.get
- Reconcile discovered clusterspost
CloudAssetIntegrationsAPI

Cluster Autoscaler

AutoscalingHealthIndicatorsAPI
- Return the most recent information on cluster autoscaling health indicators.get
AutoscalingWatchdogAPI
- Report watchdog eventspost
HibernationJobsAPI
HibernationSchedulesAPI

Pricing

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

Omni provisioner

ClustersAPI
EdgeConfigurationsAPI
- List edge configurationsget
- Get edge configuration detailsget
EdgeLocationsAPI
EdgesV2BetaAPI
OperationsAPI
- Gets the latest state of a long-running operationget

Organization Management

EnterpriseAPI
IPFirewallAPI
ScimAPI
SettingsAPI
- Get organization settings.get
- Update organization settings.patch

Powered by

Returns scrapable workload metrics in Prometheus format.

get

https://api.cast.ai/v1/metrics/workloads

Language

Credentials

Log in to use your API keys

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