Generated by API Evangelist
Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Confluent Cloud Clusters (ksqldbcm/v2) API
version: 1.0.0
extends: openapi/confluent-clusters-ksqldbcm-v2-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/ksqldbcm/v2/clusters'].get
update:
x-apievangelist-phrasing:
intent: List ksqlDB clusters
effect: read
questions:
- Which ksqlDB clusters are running in my environment?
- Can I page through ksqlDB clusters for one environment?
instructions:
- text: List ksqlDB clusters in environment {environment}.
slots:
environment: query.environment
- text: Show all ksqlDB clusters in {environment}.
slots:
environment: query.environment
method: generated
generated: '2026-09-26'
- target: $.paths['/ksqldbcm/v2/clusters'].post
update:
x-apievangelist-phrasing:
intent: Create a ksqlDB cluster
effect: write
questions:
- How do I spin up a new ksqlDB cluster attached to a Kafka cluster?
- Can I describe the desired state of a new ksqlDB cluster in one request?
instructions:
- text: Create a ksqlDB cluster with spec {spec}.
slots:
spec: requestBody.spec
- text: Provision a new ksqlDB cluster configured as {spec}.
slots:
spec: requestBody.spec
method: generated
generated: '2026-09-26'
- target: $.paths['/ksqldbcm/v2/clusters/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one ksqlDB cluster
effect: read
questions:
- Is a specific ksqlDB cluster provisioned, and what is its endpoint?
- How do I read a ksqlDB cluster's details by ID?
instructions:
- text: Get ksqlDB cluster {id} in environment {environment}.
slots:
id: path.id
environment: query.environment
- text: Show the endpoint and status of ksqlDB cluster {id} in {environment}.
slots:
id: path.id
environment: query.environment
method: generated
generated: '2026-09-26'
- target: $.paths['/ksqldbcm/v2/clusters/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a ksqlDB cluster
effect: destructive
questions:
- What is the way to decommission a ksqlDB cluster I no longer need?
- Can I remove a ksqlDB cluster from an environment by its ID?
instructions:
- text: Delete ksqlDB cluster {id} in environment {environment}.
slots:
id: path.id
environment: query.environment
- text: Tear down ksqlDB cluster {id} in {environment}.
slots:
id: path.id
environment: query.environment
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.