Cloudera · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Cloudera AI Ml API
60 actions
60 updates
phrasing
extends
openapi/cloudera-ml-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Cloudera's API. It is a proposal applied on top of the contract, not a document Cloudera publishes.
What the actions change
x-apievangelist-phrasing
Targets 60 · first 16 shown; the file carries all of them
$.info
$.paths['/api/v1/ml/addInstanceGroups'].post
$.paths['/api/v1/ml/addInstanceGroupsMlServingApp'].post
$.paths['/api/v1/ml/backupWorkspace'].post
$.paths['/api/v1/ml/createFileReplica'].post
$.paths['/api/v1/ml/createMlServingApp'].post
$.paths['/api/v1/ml/createModelRegistry'].post
$.paths['/api/v1/ml/createWorkspace'].post
$.paths['/api/v1/ml/deleteBackup'].post
$.paths['/api/v1/ml/deleteFileReplica'].post
$.paths['/api/v1/ml/deleteInstanceGroup'].post
$.paths['/api/v1/ml/deleteInstanceGroupMlServingApp'].post
$.paths['/api/v1/ml/deleteMlServingApp'].post
$.paths['/api/v1/ml/deleteModelRegistry'].post
$.paths['/api/v1/ml/deleteWorkspace'].post
$.paths['/api/v1/ml/describeMlServingApp'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Cloudera AI Ml API
version: 1.0.0
extends: openapi/cloudera-ml-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 59
- target: $.paths['/api/v1/ml/addInstanceGroups'].post
update:
x-apievangelist-phrasing:
intent: Add instance groups to an AI workbench
effect: write
questions:
- How do I add more instance groups to a Cloudera AI workbench cluster?
- Can I add new instance groups to a workbench that's already running?
instructions:
- text: Add instance groups {instanceGroups} to workbench {workspaceCrn}.
slots:
instanceGroups: requestBody.instanceGroups
workspaceCrn: requestBody.workspaceCrn
- text: Extend workbench {workspaceCrn} with the instance groups {instanceGroups}.
slots:
workspaceCrn: requestBody.workspaceCrn
instanceGroups: requestBody.instanceGroups
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/addInstanceGroupsMlServingApp'].post
update:
x-apievangelist-phrasing:
intent: Add instance groups to an inference service
effect: write
questions:
- Can I add an instance group to an existing AI Inference Service instance?
- What's needed to give an inference service more node groups?
instructions:
- text: Add instance groups {instanceGroups} to inference service {appCrn}.
slots:
instanceGroups: requestBody.instanceGroups
appCrn: requestBody.appCrn
- text: Extend AI Inference Service {appCrn} with {instanceGroups}.
slots:
appCrn: requestBody.appCrn
instanceGroups: requestBody.instanceGroups
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/backupWorkspace'].post
update:
x-apievangelist-phrasing:
intent: Back up an AI workbench
effect: write
questions:
- How do I back up a Cloudera AI workbench?
- Can I set a timeout on a workbench backup job?
instructions:
- text: Back up workbench {workspaceCrn} as {backupName}.
slots:
workspaceCrn: requestBody.workspaceCrn
backupName: requestBody.backupName
- text: Create backup {backupName} of {workspaceCrn} with a {backupJobTimeoutMinutes}-minute timeout.
slots:
backupName: requestBody.backupName
workspaceCrn: requestBody.workspaceCrn
backupJobTimeoutMinutes: requestBody.backupJobTimeoutMinutes
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/createFileReplica'].post
update:
x-apievangelist-phrasing:
intent: Create a file system replica for a workbench
effect: write
questions:
- Can I replicate a workbench's project files to a replica file system?
- What sets up file system replication for a workbench ahead of a disaster?
instructions:
- text: Create a file system replica for workbench {workspaceCrn}.
slots:
workspaceCrn: requestBody.workspaceCrn
- text: Set up project file replication on {workspaceCrn}.
slots:
workspaceCrn: requestBody.workspaceCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/createMlServingApp'].post
update:
x-apievangelist-phrasing:
intent: Deploy an AI Inference Service
effect: write
questions:
- How do I deploy Cloudera AI Inference Service into an environment?
- Can I use a public load balancer for a new inference service?
instructions:
- text: Deploy AI Inference Service {appName} in environment {environmentCrn}.
slots:
appName: requestBody.appName
environmentCrn: requestBody.environmentCrn
- text: Create inference service {appName} on {environmentCrn} with public load balancer set to {usePublicLoadBalancer}.
slots:
appName: requestBody.appName
environmentCrn: requestBody.environmentCrn
usePublicLoadBalancer: requestBody.usePublicLoadBalancer
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/createModelRegistry'].post
update:
x-apievangelist-phrasing:
intent: Create a model registry
effect: write
questions:
- What does it take to create a new model registry?
- Can I back a model registry with my own S3 bucket?
instructions:
- text: Create a model registry in environment {environmentName}.
slots:
environmentName: requestBody.environmentName
- text: Create a model registry in {environmentName} using S3 bucket {s3Bucket}.
slots:
environmentName: requestBody.environmentName
s3Bucket: requestBody.s3Bucket
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/createWorkspace'].post
update:
x-apievangelist-phrasing:
intent: Create an AI workbench
effect: write
questions:
- How do I provision a new Cloudera AI workbench?
- Can I enable model metrics and monitoring when creating a workbench?
instructions:
- text: Create workbench {workspaceName} in environment {environmentName}.
slots:
workspaceName: requestBody.workspaceName
environmentName: requestBody.environmentName
- text: Create workbench {workspaceName} in {environmentName} with private cluster set to {privateCluster}.
slots:
workspaceName: requestBody.workspaceName
environmentName: requestBody.environmentName
privateCluster: requestBody.privateCluster
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/deleteBackup'].post
update:
x-apievangelist-phrasing:
intent: Delete a workbench backup
effect: destructive
questions:
- Can I delete an old workbench backup snapshot?
- Is there a way to remove a workbench backup I no longer need?
instructions:
- text: Delete backup {backupCrn}.
slots:
backupCrn: requestBody.backupCrn
- text: Remove workbench backup snapshot {backupCrn}.
slots:
backupCrn: requestBody.backupCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/deleteFileReplica'].post
update:
x-apievangelist-phrasing:
intent: Remove project file replication
effect: destructive
questions:
- Can I stop replicating a workbench's project files?
- What do I call to delete the replica configuration for a workbench?
instructions:
- text: Delete file replication for workbench {workspaceCrn}.
slots:
workspaceCrn: requestBody.workspaceCrn
- text: Turn off project file replication on {workspaceCrn}.
slots:
workspaceCrn: requestBody.workspaceCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/deleteInstanceGroup'].post
update:
x-apievangelist-phrasing:
intent: Delete an instance group from a workbench
effect: destructive
questions:
- Can I remove an instance group from a Cloudera AI workbench?
- Which details do I need to delete a node group from a workbench cluster?
instructions:
- text: Delete instance group {instanceGroupName} from workbench {workspaceCrn}.
slots:
instanceGroupName: requestBody.instanceGroupName
workspaceCrn: requestBody.workspaceCrn
- text: Remove the {instanceGroupName} group from {workspaceCrn}.
slots:
instanceGroupName: requestBody.instanceGroupName
workspaceCrn: requestBody.workspaceCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/deleteInstanceGroupMlServingApp'].post
update:
x-apievangelist-phrasing:
intent: Delete an instance group from an inference service
effect: destructive
questions:
- Can I remove an instance group from an AI Inference Service instance?
- Is it possible to shrink an inference service by dropping a node group?
instructions:
- text: Delete instance group {instanceGroupName} from inference service {appCrn}.
slots:
instanceGroupName: requestBody.instanceGroupName
appCrn: requestBody.appCrn
- text: Remove the {instanceGroupName} group from AI Inference Service {appCrn}.
slots:
instanceGroupName: requestBody.instanceGroupName
appCrn: requestBody.appCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/deleteMlServingApp'].post
update:
x-apievangelist-phrasing:
intent: Delete an AI Inference Service instance
effect: destructive
questions:
- Does deleting an AI Inference Service instance also delete its Kubernetes cluster?
- Can I force-delete an inference service?
instructions:
- text: Delete inference service {appCrn}.
slots:
appCrn: requestBody.appCrn
- text: Delete AI Inference Service {appCrn} with force set to {force}.
slots:
appCrn: requestBody.appCrn
force: requestBody.force
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/deleteModelRegistry'].post
update:
x-apievangelist-phrasing:
intent: Delete a model registry
effect: destructive
questions:
- How do I delete a model registry?
- Can I force the deletion of a model registry?
instructions:
- text: Delete model registry {modelRegistryCrn}.
slots:
modelRegistryCrn: requestBody.modelRegistryCrn
- text: Delete model registry {modelRegistryCrn} with force set to {force}.
slots:
modelRegistryCrn: requestBody.modelRegistryCrn
force: requestBody.force
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/deleteWorkspace'].post
update:
x-apievangelist-phrasing:
intent: Delete an AI workbench
effect: destructive
questions:
- How do I delete a Cloudera AI workbench?
- Can I also remove the workbench's storage when deleting it?
instructions:
- text: Delete workbench {workspaceCrn} with force {force}.
slots:
workspaceCrn: requestBody.workspaceCrn
force: requestBody.force
- text: Delete workbench {workspaceName} in {environmentName}, force {force}, removing storage {removeStorage}.
slots:
workspaceName: requestBody.workspaceName
environmentName: requestBody.environmentName
force: requestBody.force
removeStorage: requestBody.removeStorage
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/describeMlServingApp'].post
update:
x-apievangelist-phrasing:
intent: Get an AI Inference Service's details
effect: read
questions:
- What's the status of my AI Inference Service instance?
- Can I see how an inference service is configured?
instructions:
- text: Describe inference service {appCrn}.
slots:
appCrn: requestBody.appCrn
- text: Show details for AI Inference Service {appCrn}.
slots:
appCrn: requestBody.appCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/describeModelRegistry'].post
update:
x-apievangelist-phrasing:
intent: Describe a model registry (deprecated)
effect: read
questions:
- Is the single model registry describe call still supported?
- Can I still look up one model registry with the deprecated describe operation?
instructions:
- text: Describe model registry {modelRegistryCrn} using the deprecated call.
slots:
modelRegistryCrn: requestBody.modelRegistryCrn
- text: Show details of model registry {modelRegistryCrn}.
slots:
modelRegistryCrn: requestBody.modelRegistryCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/describeWorkspace'].post
update:
x-apievangelist-phrasing:
intent: Get an AI workbench's details
effect: read
questions:
- What's the current state of my Cloudera AI workbench?
- Can I look up a workbench by environment and name instead of CRN?
instructions:
- text: Describe workbench {workspaceCrn}.
slots:
workspaceCrn: requestBody.workspaceCrn
- text: Show workbench {workspaceName} in environment {environmentName}.
slots:
workspaceName: requestBody.workspaceName
environmentName: requestBody.environmentName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/describeWorkspaceBackup'].post
update:
x-apievangelist-phrasing:
intent: Get a workbench backup's details
effect: read
questions:
- What's in a specific workbench backup snapshot?
- Can I check the status of one workbench backup?
instructions:
- text: Describe backup {backupCrn}.
slots:
backupCrn: requestBody.backupCrn
- text: Show details of workbench backup {backupCrn}.
slots:
backupCrn: requestBody.backupCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/failOverFileSystem'].post
update:
x-apievangelist-phrasing:
intent: Fail over a workbench to its replica file system
effect: write
questions:
- How do I fail over to the replica file system after a disaster?
- Can I switch a workbench to its replicated file system?
instructions:
- text: Fail over workbench {workspaceCrn} to its replica file system.
slots:
workspaceCrn: requestBody.workspaceCrn
- text: Switch {workspaceCrn} to the replica file system.
slots:
workspaceCrn: requestBody.workspaceCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/fetchAiRegistriesStorageConfig'].post
update:
x-apievangelist-phrasing:
intent: Get AI Registry storage config for inference
effect: read
questions:
- Which AI Registries are linked to my inference service and what S3 settings do they use?
- Can I check the link status of AI Registries for an inference service?
instructions:
- text: Fetch AI Registry storage config for inference service {appCrn}.
slots:
appCrn: requestBody.appCrn
- text: Show registry S3 settings and link status for {appCrn}.
slots:
appCrn: requestBody.appCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/getAuditEvents'].post
update:
x-apievangelist-phrasing:
intent: Get audit events for a workbench
effect: read
questions:
- What events have been recorded for my workbench?
- Can I get audit events for a specific resource?
instructions:
- text: Get audit events for workbench {workspaceCrn}.
slots:
workspaceCrn: requestBody.workspaceCrn
- text: List audit events for resource {resourceCrn}.
slots:
resourceCrn: requestBody.resourceCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/getKubeconfig'].post
update:
x-apievangelist-phrasing:
intent: Get the kubeconfig for an AI workbench
effect: read
questions:
- Can I download the kubeconfig for a Cloudera AI workbench cluster?
- Where do I get Kubernetes credentials to run kubectl against a workbench?
instructions:
- text: Get the kubeconfig for workbench {workspaceCrn}.
slots:
workspaceCrn: requestBody.workspaceCrn
- text: Download kubeconfig for workbench {workspaceName} in {environmentName}.
slots:
workspaceName: requestBody.workspaceName
environmentName: requestBody.environmentName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/getLatestModelRegistryVersion'].post
update:
x-apievangelist-phrasing:
intent: Get the latest model registry version
effect: read
questions:
- What's the latest version Cloudera AI deploys for model registries?
- Is my model registry behind the newest release?
instructions:
- text: Get the latest model registry version.
- text: Show the newest version available for model registries.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/getLatestWorkspaceVersion'].post
update:
x-apievangelist-phrasing:
intent: Get the latest workbench version
effect: read
questions:
- What's the latest version Cloudera AI deploys to workbenches?
- Is there a newer workbench version I can upgrade to?
instructions:
- text: Get the latest workbench version.
- text: Show the newest Cloudera AI workbench release.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/getLogs'].post
update:
x-apievangelist-phrasing:
intent: Get logs for a request
effect: read
questions:
- Can I fetch the logs for a specific request ID?
- Is it possible to page through request logs instead of fetching them all?
instructions:
- text: Get logs for request {requestID}.
slots:
requestID: requestBody.requestID
- text: Fetch all logs for request {requestID} on workbench {workspaceCrn}.
slots:
requestID: requestBody.requestID
workspaceCrn: requestBody.workspaceCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/getMlServingAppKubeconfig'].post
update:
x-apievangelist-phrasing:
intent: Get kubeconfig for an inference service cluster
effect: read
questions:
- Can I get the kubeconfig for an AI Inference Service cluster?
- Where do I find kubectl credentials for my inference service?
instructions:
- text: Get the kubeconfig for inference service {appCrn}.
slots:
appCrn: requestBody.appCrn
- text: Download kubeconfig of AI Inference Service {appCrn}.
slots:
appCrn: requestBody.appCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/getModelRegistryKubeconfig'].post
update:
x-apievangelist-phrasing:
intent: Get kubeconfig for a model registry cluster
effect: read
questions:
- Can I get the kubeconfig for a model registry cluster?
- Where are the kubectl credentials for my model registry?
instructions:
- text: Get the kubeconfig for model registry {modelRegistryCrn}.
slots:
modelRegistryCrn: requestBody.modelRegistryCrn
- text: Download kubeconfig of model registry {modelRegistryCrn}.
slots:
modelRegistryCrn: requestBody.modelRegistryCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/grantMlServingAppAccess'].post
update:
x-apievangelist-phrasing:
intent: Grant a user admin access to an inference cluster
effect: write
questions:
- How do I give an AWS user Kubernetes admin access to an inference service cluster?
- Can I grant cluster access on an AI Inference Service to another user?
instructions:
- text: Grant {identifier} access to inference service {resourceCrn}.
slots:
identifier: requestBody.identifier
resourceCrn: requestBody.resourceCrn
- text: Give AWS user {identifier} Kubernetes admin rights on AI Inference Service {resourceCrn}.
slots:
identifier: requestBody.identifier
resourceCrn: requestBody.resourceCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/grantModelRegistryAccess'].post
update:
x-apievangelist-phrasing:
intent: Grant a user access to a model registry cluster
effect: write
questions:
- Can I let an AWS user run Kubernetes operations on a model registry?
- What do I need to grant EKS access to a model registry?
instructions:
- text: Grant {identifier} access to model registry {resourceCrn}.
slots:
identifier: requestBody.identifier
resourceCrn: requestBody.resourceCrn
- text: Give AWS user {identifier} Kubernetes access on model registry {resourceCrn}.
slots:
identifier: requestBody.identifier
resourceCrn: requestBody.resourceCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/grantWorkspaceAccess'].post
update:
x-apievangelist-phrasing:
intent: Grant a user access to a workbench cluster
effect: write
questions:
- How do I give an AWS user kubectl access to a Cloudera AI workbench?
- Can I grant EKS access to a workbench by user ARN?
instructions:
- text: Grant user {arn} access to workbench {workspaceCrn}.
slots:
arn: requestBody.arn
workspaceCrn: requestBody.workspaceCrn
- text: Give {identifier} Kubernetes access on workbench {workspaceName} in {environmentName}.
slots:
identifier: requestBody.identifier
workspaceName: requestBody.workspaceName
environmentName: requestBody.environmentName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/listInstanceTypeConfiguration'].post
update:
x-apievangelist-phrasing:
intent: Get configuration for an instance type
effect: read
questions:
- What are the specs of a given instance type for Cloudera AI?
- Can I check an instance type's configuration in a particular environment?
instructions:
- text: Show configuration for instance type {instanceType} in category {instanceCategory}, environment {environmentName}, product {productType}.
slots:
instanceType: requestBody.instanceType
instanceCategory: requestBody.instanceCategory
environmentName: requestBody.environmentName
productType: requestBody.productType
- text: Get {instanceType} config for {productType} in {environmentName} ({instanceCategory}).
slots:
instanceType: requestBody.instanceType
productType: requestBody.productType
environmentName: requestBody.environmentName
instanceCategory: requestBody.instanceCategory
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/listMlServingAppAccess'].post
update:
x-apievangelist-phrasing:
intent: List users with access to an inference cluster
effect: read
questions:
- Who has Kubernetes access to my AI Inference Service cluster?
- Can I audit admin access on an inference service?
instructions:
- text: List users with access to inference service {resourceCrn}.
slots:
resourceCrn: requestBody.resourceCrn
- text: Show who can run Kubernetes operations on AI Inference Service {resourceCrn}.
slots:
resourceCrn: requestBody.resourceCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/listMlServingApps'].post
update:
x-apievangelist-phrasing:
intent: List AI Inference Service instances
effect: read
questions:
- What AI Inference Service instances do I have?
- Can I see all inference services across environments?
instructions:
- text: List my AI Inference Service instances.
- text: Show all inference services.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/listModelRegistries'].post
update:
x-apievangelist-phrasing:
intent: List model registries
effect: read
questions:
- Which model registries exist in my account?
- Can I see all Cloudera AI model registries at once?
instructions:
- text: List model registries.
- text: Show all my model registries.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/listModelRegistryAccess'].post
update:
x-apievangelist-phrasing:
intent: List users with access to a model registry
effect: read
questions:
- Who can run Kubernetes operations on my model registry?
- Can I review EKS access on a model registry?
instructions:
- text: List users with access to model registry {resourceCrn}.
slots:
resourceCrn: requestBody.resourceCrn
- text: Show who has Kubernetes access to model registry {resourceCrn}.
slots:
resourceCrn: requestBody.resourceCrn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/listRelevantInstances'].post
update:
x-apievangelist-phrasing:
intent: Find instance types with requested resources
effect: read
questions:
- Which instance types can I use to create a workbench with the resources I need?
- Can I find instance types that match a resource request?
instructions:
- text: Find {instanceCategory} instance types for {requestInfo} in {environmentName} for {productType}.
slots:
instanceCategory: requestBody.instanceCategory
requestInfo: requestBody.requestInfo
environmentName: requestBody.environmentName
productType: requestBody.productType
- text: List relevant instance types in {environmentName} matching {requestInfo} ({instanceCategory}, {productType}).
slots:
environmentName: requestBody.environmentName
requestInfo: requestBody.requestInfo
instanceCategory: requestBody.instanceCategory
productType: requestBody.productType
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/listWorkspaceAccess'].post
update:
x-apievangelist-phrasing:
intent: List users with access to a workbench cluster
effect: read
questions:
- Who has kubectl access to my Cloudera AI workbench?
- Can I review which AWS users can operate on a workbench via EKS?
instructions:
- text: List users with access to workbench {workspaceCrn}.
slots:
workspaceCrn: requestBody.workspaceCrn
- text: Show who can run Kubernetes operations on workbench {workspaceName} in {environmentName}.
slots:
workspaceName: requestBody.workspaceName
environmentName: requestBody.environmentName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/listWorkspaceBackups'].post
update:
x-apievangelist-phrasing:
intent: List a workbench's backups
effect: read
questions:
- What backups exist for my workbench?
- Can I see backup snapshots for a workbench by name?
instructions:
- text: List backups of workbench {workspaceCrn}.
slots:
workspaceCrn: requestBody.workspaceCrn
- text: Show backup snapshots for {workspaceName} in {environmentName}.
slots:
workspaceName: requestBody.workspaceName
environmentName: requestBody.environmentName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/listWorkspaces'].post
update:
x-apievangelist-phrasing:
intent: List AI workbenches
effect: read
questions:
- Which Cloudera AI workbenches do I have?
- Can I see every workbench across environments?
instructions:
- text: List my workbenches.
- text: Show all Cloudera AI workbenches.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/modifyClusterInstanceGroup'].post
update:
x-apievangelist-phrasing:
intent: Resize a workbench instance group
effect: write
questions:
- Can I change the min and max size of a workbench instance group?
- Is it possible to switch the instance type of a workbench node group?
instructions:
- text: Set instance group {instanceGroupName} on workbench {workspaceCrn} to {min}-{max} nodes of {instanceType}.
slots:
instanceGroupName: requestBody.instanceGroupName
workspaceCrn: requestBody.workspaceCrn
min: requestBody.min
max: requestBody.max
instanceType: requestBody.instanceType
- text: Change {instanceGroupName} in {workspaceCrn} to {instanceType} with min {min} and max {max}.
slots:
instanceGroupName: requestBody.instanceGroupName
workspaceCrn: requestBody.workspaceCrn
instanceType: requestBody.instanceType
min: requestBody.min
max: requestBody.max
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/modifyClusterSecurity'].post
update:
x-apievangelist-phrasing:
intent: Change a workbench's authorized IP ranges
effect: write
questions:
- Can I restrict which IP ranges can reach a workbench's cluster?
- How do I update the authorized IP allowlist for a workbench?
instructions:
- text: Set authorized IP ranges on workbench {workspaceCrn} to {authorizedIPRanges} with allowlisting {allowlistAuthorizedIPRanges}.
slots:
workspaceCrn: requestBody.workspaceCrn
authorizedIPRanges: requestBody.authorizedIPRanges
allowlistAuthorizedIPRanges: requestBody.allowlistAuthorizedIPRanges
- text: Enable IP allowlisting {allowlistAuthorizedIPRanges} for {workspaceCrn} using ranges {authorizedIPRanges}.
slots:
allowlistAuthorizedIPRanges: requestBody.allowlistAuthorizedIPRanges
workspaceCrn: requestBody.workspaceCrn
authorizedIPRanges: requestBody.authorizedIPRanges
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/modifyMlServingApp'].post
update:
x-apievangelist-phrasing:
intent: Resize an inference service instance group
effect: write
questions:
- Can I change the node counts of an AI Inference Service instance group?
- What's needed to change the instance type for an inference service node group?
instructions:
- text: Set group {instanceGroupName} on inference service {appCrn} to {min}-{max} nodes of {instanceType}.
slots:
instanceGroupName: requestBody.instanceGroupName
appCrn: requestBody.appCrn
min: requestBody.min
max: requestBody.max
instanceType: requestBody.instanceType
- text: Change {instanceGroupName} in AI Inference Service {appCrn} to {instanceType}, min {min}, max {max}.
slots:
instanceGroupName: requestBody.instanceGroupName
appCrn: requestBody.appCrn
instanceType: requestBody.instanceType
min: requestBody.min
max: requestBody.max
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/ml/modifyWorkspaceLoadBalancer'].post
update:
x-apievangelist-phrasing:
intent: Change a workbench's load balancer allowlist
effect: write
questions:
- Can I limit which IPs can reach a workbench's load balancer?
- Where do I update the load balancer IP allowlist on a workbench?
instructions:
- text: Set load balancer allowlist on workbench {workspaceCrn} to {loadBalancerIPAllowLists}.
slots:
workspaceCrn: requestBody.workspaceCrn
loadBalancerIPAllowLists: requestBody.loadBalancerIPAllowLists
- text: Restrict the {workspaceCrn} load balancer to {loadBalancerIPAllowLists}.
slots:
workspaceCrn: requestBody.workspaceCrn
loadBalancerIPAllowLists: requestBody.loadBalancerIPAllowLists
method: generated
generated: '2026-10-01'
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/overlays/cloudera-ml-api-phrasing-overlay.yaml