Confluent | the Data Streaming Platform

Confluent | the Data Streaming Platform Agents (sql/v1) API

[![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy) `Agent` models an AI agent that uses a specified model, prompt, and set of tools to autonomously perform tasks. The API allows you to create your agents. ## The Agents Model

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /sql/v1/organizations/{organization_id}/environments/{environment_id}/agents List Flink SQL agents in an environment · List all agents #
Ask an LLM
“Which AI agents are defined in my Flink SQL environment?”
“Can I page through all agents across an environment's databases?”
Tell an agent
List all agents in environment {environment_id} of org {organization_id}.
Show the next {page_size} agents in environment {environment_id} for org {organization_id}.
POST /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents Create a Flink SQL agent · Create an Agent #
Ask an LLM
“How do I create an agent in a Flink SQL database backed by a Kafka cluster?”
“What spec does a new Flink SQL agent need, like its model and prompt?”
Tell an agent
Create agent {name} in database {kafka_cluster_id}, environment {environment_id}, org {organization_id} with spec {spec}.
Set up a new agent {name} on Kafka cluster {kafka_cluster_id}.
GET /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name} Get a Flink SQL agent · Read an Agent #
Ask an LLM
“What model and prompt is a specific Flink SQL agent using?”
“Can I read one agent's definition by name?”
Tell an agent
Show agent {agent_name} in database {kafka_cluster_id}, environment {environment_id}, org {organization_id}.
Read the definition of agent {agent_name}.
PUT /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name} Alter a Flink SQL agent · Alter an Agent #
Ask an LLM
“Can I change an existing agent's model or prompt?”
“Which agent fields can be altered after creation?”
Tell an agent
Alter agent {agent_name} in database {kafka_cluster_id}, environment {environment_id}, org {organization_id} with spec {spec}.
Update the prompt and model of agent {agent_name} using spec {spec}.
DELETE /sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name} Delete a Flink SQL agent · Delete an Agent #
Ask an LLM
“How do I remove an agent from a Flink SQL database?”
“Can I delete a specific agent by its name?”
Tell an agent destructive · confirm first
Delete agent {agent_name} from database {kafka_cluster_id}, environment {environment_id}, org {organization_id}.
Remove agent {agent_name}.

Documentation

📖
Documentation
https://docs.confluent.io/cloud/current/api.html
📖
APIReference
https://docs.confluent.io/cloud/current/api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/openapi/confluent-the-data-streaming-platform-agents-sql-v1-api-openapi.yml

Other Resources

🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/mcp/confluent-the-data-streaming-platform-tool-crosswalk.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/data-model/confluent-the-data-streaming-platform-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/confluent-the-data-streaming-platform:confluent-the-data-streaming-platform-agents-sql-v1-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

confluent-the-data-streaming-platform-agents-sql-v1-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluent Cloud Agents (sql/v1) API
  version: ''
  x-api-id: 46234552-5833-42eb-ba0f-883ad3f70d2b
  x-audience: external-public
  x-logo:
    url: https://assets.confluent.io/m/1661ef5e4ff82d3d/
  description: '# Introduction


    Note


    This documents the collection of Confluent Cloud APIs.'
servers:
- url: https://api.confluent.cloud
  description: Confluent Cloud API
tags:


# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/openapi/confluent-the-data-streaming-platform-agents-sql-v1-api-openapi.yml