# Cast AI Workload Optimization API **Canonical:** https://apis.io/apis/kimchi/kimchi-workloadoptimizationapi-api/ **Provider:** Cast AI — https://apis.io/providers/kimchi/ **Base URL:** https://api.cast.ai/ Cast AI Workload Optimization API is one of 137 APIs that [Cast AI](https://apis.io/providers/kimchi/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include WorkloadOptimizationAPI. The published artifact set on APIs.io includes an OpenAPI specification. The WorkloadOptimizationAPI API from Cast AI — 30 operation(s) for workloadoptimizationapi. ## Operations (37) | Method | Path | Summary | |---|---|---| | GET | `/v1/workload-autoscaling/clusters/{clusterId}/components/workload-autoscaler` | Returns status of workload-autoscaler agent | | POST | `/v1/workload-autoscaling/clusters/{clusterId}/custom-metrics/configs/data-sources` | Creates a custom metrics data source for given cluster | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/custom-metrics/configs/data-sources` | Returns a list of custom metrics data sources for given cluster | | DELETE | `/v1/workload-autoscaling/clusters/{clusterId}/custom-metrics/configs/data-sources/{id}` | Deletes a custom metrics data source | | PATCH | `/v1/workload-autoscaling/clusters/{clusterId}/custom-metrics/configs/data-sources/{id}` | Updates a custom metrics data source | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/limit-ranges` | Returns a list of limit ranges for given cluster | | POST | `/v1/workload-autoscaling/clusters/{clusterId}/policies` | Creates a scaling policy that can be assigned to workloads at a later time | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/policies` | Returns a list of workload scaling policies for given cluster | | PUT | `/v1/workload-autoscaling/clusters/{clusterId}/policies/order` | Updates the order of scaling policies for a given cluster | | DELETE | `/v1/workload-autoscaling/clusters/{clusterId}/policies/{policyId}` | Deletes a scaling policy | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/policies/{policyId}` | Returns scaling policy | | PUT | `/v1/workload-autoscaling/clusters/{clusterId}/policies/{policyId}` | Updates a scaling policy | | PUT | `/v1/workload-autoscaling/clusters/{clusterId}/policies/{policyId}/workloads` | Assigns the provided list of workload IDs to the specified policy | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/resource-quotas` | Returns a list of resource quotas for given cluster | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workload-events` | Returns a list of workload events for given cluster | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workload-events-summary` | Returns a workload events summary for given cluster | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workload-events/{eventId}` | Returns a specific workload event by the given id | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workloads` | Returns a list of workloads for the given cluster | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workloads-access-context` | Returns a workloads access context for a given cluster | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workloads-summary` | Returns workloads optimization summary | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workloads-summary-metrics` | Returns workloads summary time series | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workloads/filters` | Returns workload filter values | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workloads/migrate-to-hpa-v2` | Returns HPA v2 migration eligibility for a cluster | | POST | `/v1/workload-autoscaling/clusters/{clusterId}/workloads/migrate-to-hpa-v2` | Migrates all eligible cluster workloads to HPA v2 | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workloads/{workloadId}` | Returns a workload by a given id | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workloads/{workloadId}/gpu-metrics` | Returns step-bucketed GPU utilization time-series and recommendations for a… | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workloads/{workloadId}/native-vpa-spec` | Returns native VPA spec of the workload by a given id | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workloads/{workloadId}/recommendation-manifest` | Returns the deployed Recommendation CR manifest for the workload, sourced from… | | GET | `/v1/workload-autoscaling/clusters/{clusterId}/workloads/{workloadId}/spec` | Returns a spec of the workload by a given id | | POST | `/v1/workload-autoscaling/clusters/{clusterId}/workloads/{workloadId}/system-overrides:reset` | Resets the system overrides for a workload | | GET | `/v1/workload-autoscaling/organizations/{organizationId}/components/workload-autoscaler` | Returns status of workload-autoscaler agents for all clusters in an organization | | POST | `/v1alpha/workload-autoscaling/clusters/{clusterId}/workloads/metrics:query` | Query workload metrics time series | | GET | `/v1beta/workload-autoscaling/clusters/{clusterId}/hpas:analyze` | Returns all HPAs configured on workloads in the given cluster, including… | | GET | `/v1beta/workload-autoscaling/clusters/{clusterId}/workloads/{workloadId}/custom-metrics` | Returns raw custom metrics time-series data for a workload | | GET | `/v1beta/workload-autoscaling/clusters/{clusterId}/workloads/{workloadId}/custom-metrics:aggregate` | GetAggregatedWorkloadCustomMetrics returns aggregated custom metrics… | | PATCH | `/v2/workload-autoscaling/clusters/{clusterId}/workloads/{workloadId}` | Updates a CAST AI managed workload V2 partially using field mask | | PUT | `/v2/workload-autoscaling/clusters/{clusterId}/workloads/{workloadId}` | Updates a CAST AI managed workload V2 | ## Machine-readable artifacts (1) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/kimchi/refs/heads/main/openapi/kimchi-workloadoptimizationapi-api-openapi.yml ## Other Cast AI APIs (12) - [Cast AI Addons API](https://apis.io/apis/kimchi/kimchi-addonsapi-api/) - [Cast AI Advisor API](https://apis.io/apis/kimchi/kimchi-advisorapi-api/) - [Cast AI AI Enabler API](https://apis.io/apis/kimchi/kimchi-aienablerapi-api/) - [Cast AI AI Enabler Playground API](https://apis.io/apis/kimchi/kimchi-aienablerplaygroundapi-api/) - [Cast AI AI Enabler Providers API](https://apis.io/apis/kimchi/kimchi-aienablerprovidersapi-api/) - [Cast AI AI Enabler Settings API](https://apis.io/apis/kimchi/kimchi-aienablersettingsapi-api/) - [Cast AI Allocation Group API](https://apis.io/apis/kimchi/kimchi-allocationgroupapi-api/) - [Cast AI Analytics API](https://apis.io/apis/kimchi/kimchi-analyticsapi-api/) - [Cast AI API Keys API](https://apis.io/apis/kimchi/kimchi-apikeysapi-api/) - [Cast AI Audit API](https://apis.io/apis/kimchi/kimchi-auditapi-api/) - [Cast AI Audit V2API API](https://apis.io/apis/kimchi/kimchi-auditv2api-api/) - [Cast AI Auth API](https://apis.io/apis/kimchi/kimchi-authapi-api/) ## Tags WorkloadOptimizationAPI --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/kimchi/kimchi-workloadoptimizationapi-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/kimchi/.