> ## Documentation Index
> Fetch the complete documentation index at: https://docs.streamkap.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Agent Cluster

> Return cluster-level Flink info for the agent runtime - slots + version.

Powers the agentic dashboard header (total/available task slots, Flink
version). Sourced from Flink REST ``/overview``; kebab-case keys are
translated to the camelCase response contract.

Agents and transforms share the same tenant Flink cluster, so this probe
accepts either ``read:agents`` or ``read:transforms`` (OR semantics) and
backs the cluster-availability note on both deploy surfaces.

When the tenant's cluster is not provisioned the upstream REST call 404s;
that is reported as ``available=False`` with zeroed fields (HTTP 200) so
the dashboard can render a "cluster not available" note instead of erroring.



## OpenAPI

````yaml /openapi/openapi.json get /agents/cluster
openapi: 3.1.0
info:
  title: Streamkap REST API
  description: >-
    The Streamkap REST API allows you to programmatically manage your CDC
    pipelines, sources, destinations, transforms, and more.


    Authenticate using a bearer token obtained from the [Access
    Token](/api-reference/auth/access-token) endpoint with your API client
    credentials.
  contact:
    name: Streamkap Support
    url: https://streamkap.com/
    email: support@streamkap.com
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api.streamkap.com
    description: Production
security: []
tags:
  - name: Agents
    description: Create, deploy, and manage Flink-based AI agents.
  - name: Agents Observability
    description: >-
      Read-only views over the MCP audit log: agent rollup, sessions, spans,
      histograms, external-agent verify.
  - name: Alerts
    description: Manage alert subscribers, preferences, and notification credentials.
  - name: Authentication
    description: Obtain and refresh access tokens, manage client credentials and roles.
  - name: Billing
    description: Retrieve usage metrics, summaries, and export billing data.
  - name: Consumer Groups
    description: List, inspect, and reset Kafka consumer group offsets.
  - name: Dashboard
    description: Retrieve organisation-level statistics and overview data.
  - name: Destinations
    description: Create, configure, and manage data destinations and their lifecycle.
  - name: Kafka Access
    description: Manage Kafka users and their access permissions.
  - name: Logs
    description: Query and summarise system logs.
  - name: Pipelines
    description: Create, configure, and manage CDC pipelines and their lifecycle.
  - name: Project Keys
    description: Manage project keys that bundle API credentials and optional Kafka access.
  - name: Schema Registry
    description: Browse schema subjects, versions, and retrieve schema definitions.
  - name: Services
    description: View and switch service metadata.
  - name: Sources
    description: >-
      Create, configure, and manage data sources, snapshots, and their
      lifecycle.
  - name: Tags
    description: Create, update, and manage resource tags for organisation.
  - name: Topics
    description: Browse topic details, statistics, configurations, metrics, and messages.
  - name: Transforms
    description: >-
      Create, deploy, and manage data transforms, unit tests, and implementation
      details.
paths:
  /agents/cluster:
    get:
      tags:
        - Agents
      summary: Get Agent Cluster
      description: >-
        Return cluster-level Flink info for the agent runtime - slots + version.


        Powers the agentic dashboard header (total/available task slots, Flink

        version). Sourced from Flink REST ``/overview``; kebab-case keys are

        translated to the camelCase response contract.


        Agents and transforms share the same tenant Flink cluster, so this probe

        accepts either ``read:agents`` or ``read:transforms`` (OR semantics) and

        backs the cluster-availability note on both deploy surfaces.


        When the tenant's cluster is not provisioned the upstream REST call
        404s;

        that is reported as ``available=False`` with zeroed fields (HTTP 200) so

        the dashboard can render a "cluster not available" note instead of
        erroring.
      operationId: getAgentCluster
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentClusterOverviewResponse'
      security:
        - FronteggHTTPAuthentication: []
components:
  schemas:
    AgentClusterOverviewResponse:
      properties:
        available:
          type: boolean
          title: Available
          description: >-
            False when the tenant's Flink cluster is not provisioned or
            unreachable; other fields are zeroed.
          default: true
        taskmanagers:
          type: integer
          title: Taskmanagers
          description: Registered TaskManagers
          default: 0
        slotsTotal:
          type: integer
          title: Slotstotal
          description: Total task slots across all TaskManagers
          default: 0
        slotsAvailable:
          type: integer
          title: Slotsavailable
          description: Idle task slots available for new deployments
          default: 0
        flinkVersion:
          type: string
          title: Flinkversion
          description: Flink runtime version
          default: unknown
      additionalProperties: true
      type: object
      title: AgentClusterOverviewResponse
      description: Cluster-level Flink info powering the agentic dashboard header.
  securitySchemes:
    FronteggHTTPAuthentication:
      type: http
      scheme: bearer

````