---
seo:
  description: >-
    The Streamkap REST API allows you to programmatically manage your CDC
    pipelines, sources, destinations, transforms, and more.
sidebar:
  label: Overview
title: Streamkap REST API
---
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/authentication/get-access-token) endpoint with your API client credentials.

Version 2.0.0

Base URL: `https://api.streamkap.com`

## Agents

Create, deploy, and manage Flink-based AI agents.

- [`POST /agents/jar`](/api-reference/agents/deploy-agent-jar-job) — Deploy Jar Job.
- [`POST /agents/pyflink`](/api-reference/agents/deploy-agent-py-flink-job) — Deploy Pyflink Job.
- [`POST /agents/config`](/api-reference/agents/create-agent-from-config) — Create Agent From Config.
- [`POST /agents/{job_id}/cancel`](/api-reference/agents/cancel-agent) — Cancel Agent.
- [`POST /agents/{job_id}/stop`](/api-reference/agents/stop-agent) — Stop Agent.
- [`POST /agents/{job_id}/redeploy`](/api-reference/agents/redeploy-agent) — Redeploy Agent.
- [`GET /agents/{job_id}/code`](/api-reference/agents/get-agent-code) — Get Agent Code.
- [`PUT /agents/{job_id}/code`](/api-reference/agents/update-agent-code) — Update Agent Code.
- [`GET /agents/{job_id}`](/api-reference/agents/get-agent) — Get Agent.
- [`DELETE /agents/{job_id}`](/api-reference/agents/delete-agent) — Delete Agent.
- [`GET /agents/prompt-templates`](/api-reference/agents/get-agent-prompt-templates) — Get Agent Prompt Templates.
- [`GET /agents/models`](/api-reference/agents/get-agent-models) — Get Agent Models.
- [`GET /agents/cluster`](/api-reference/agents/get-agent-cluster) — Get Agent Cluster.
- [`POST /agents/models/live`](/api-reference/agents/list-agent-models-live) — List Agent Models Live.
- [`POST /agents/validate-llm`](/api-reference/agents/validate-llm-connection) — Validate Llm Connection.
- [`POST /agents/system-prompt-suggestion`](/api-reference/agents/suggest-agent-system-prompt) — Suggest Agent System Prompt.
- [`POST /agents/test-run`](/api-reference/agents/test-run-agent-on-sample-record) — Test Run Agent.
- [`POST /agents/sample-record`](/api-reference/agents/get-agent-sample-record) — Get Agent Sample Record.
- [`POST /agents/mcp/tools`](/api-reference/agents/discover-mcp-tools) — Discover Mcp Tools.
- [`GET /agents/connections`](/api-reference/agents/get-agent-connections) — Get Agent Connections.
- [`PUT /agents/connections`](/api-reference/agents/update-agent-connections) — Update Agent Connections.
- [`POST /agents/connections/llm`](/api-reference/agents/create-agent-llm-connection) — Create Agent Llm Connection.
- [`DELETE /agents/connections/llm/{connection_id}`](/api-reference/agents/delete-agent-llm-connection) — Delete Agent Llm Connection.
- [`PATCH /agents/connections/llm/{connection_id}`](/api-reference/agents/patch-agent-llm-connection) — Patch Agent Llm Connection.
- [`POST /agents/connections/mcp`](/api-reference/agents/create-agent-mcp-connection) — Create Agent Mcp Connection.
- [`DELETE /agents/connections/mcp/{name}`](/api-reference/agents/delete-agent-mcp-connection) — Delete Agent Mcp Connection.
- [`PATCH /agents/connections/mcp/{name}`](/api-reference/agents/patch-agent-mcp-connection) — Patch Agent Mcp Connection.
- [`POST /agents/connections/http`](/api-reference/agents/create-agent-http-connection) — Create Agent Http Connection.
- [`DELETE /agents/connections/http/{connection_id}`](/api-reference/agents/delete-agent-http-connection) — Delete Agent Http Connection.
- [`PATCH /agents/connections/http/{connection_id}`](/api-reference/agents/patch-agent-http-connection) — Patch Agent Http Connection.
- [`POST /agents/connections/vectorStore`](/api-reference/agents/create-agent-vector-store-connection) — Create Agent Vector Store Connection.
- [`DELETE /agents/connections/vectorStore/{connection_id}`](/api-reference/agents/delete-agent-vector-store-connection) — Delete Agent Vector Store Connection.
- [`PATCH /agents/connections/vectorStore/{connection_id}`](/api-reference/agents/patch-agent-vector-store-connection) — Patch Agent Vector Store Connection.
- [`GET /agents`](/api-reference/agents/list-agents) — List Agents.
- [`GET /agents/{job_id}/status`](/api-reference/agents/get-agent-status) — Get Agent Status.
- [`GET /agents/{job_id}/logs`](/api-reference/agents/get-agent-logs) — Get Agent Logs.
- [`GET /agents/{job_id}/config`](/api-reference/agents/get-agent-config) — Get Agent Config.
- [`PUT /agents/{job_id}/config`](/api-reference/agents/update-agent-config) — Update Agent Config.
- [`GET /agents/{job_id}/config/history`](/api-reference/agents/list-agent-config-history) — List Agent Config History.
- [`GET /agents/{job_id}/config/history/{version}`](/api-reference/agents/get-agent-config-history-entry) — Get Agent Config History Entry.
- [`POST /agents/{job_id}/config/rollback`](/api-reference/agents/rollback-agent-config) — Rollback Agent Config.

## Agents Observability

Read-only views over the MCP audit log: agent rollup, sessions, spans, histograms, external-agent verify.

- [`GET /agentic/observability/agents`](/api-reference/agents-observability/get-agentic-observability-agents) — Get Observability Agents.
- [`GET /agentic/observability/sessions`](/api-reference/agents-observability/get-agentic-observability-sessions) — Get Observability Sessions.
- [`GET /agentic/observability/sessions/{session_id}`](/api-reference/agents-observability/get-agentic-observability-session-spans) — Get Observability Session Spans.
- [`GET /agentic/observability/sessions/{session_id}/transcript`](/api-reference/agents-observability/get-agentic-observability-session-transcript) — Get Observability Session Transcript.
- [`GET /agentic/observability/tools`](/api-reference/agents-observability/get-agentic-observability-tools) — Get Observability Tools.
- [`GET /agentic/observability/external/verify`](/api-reference/agents-observability/get-agentic-observability-external-verify) — Get Observability External Verify.
- [`GET /agentic/observability/iterations`](/api-reference/agents-observability/get-agentic-observability-iterations) — Get Observability Iterations.
- [`GET /agentic/observability/iterations/histogram`](/api-reference/agents-observability/get-agentic-observability-iterations-histogram) — Get Observability Iterations Histogram.
- [`GET /agentic/observability/iterations/{iteration_id}`](/api-reference/agents-observability/get-agentic-observability-iteration-detail) — Get Observability Iteration Detail.
- [`GET /agentic/observability/histogram`](/api-reference/agents-observability/get-agentic-observability-histogram) — Get Observability Histogram.
- [`GET /agentic/observability/logs`](/api-reference/agents-observability/get-agentic-observability-logs) — Get Observability Logs.
- [`GET /agentic/observability/logs/histogram`](/api-reference/agents-observability/get-agentic-observability-logs-histogram) — Get Observability Logs Histogram.
- [`GET /agentic/observability/logs/exceptions`](/api-reference/agents-observability/get-agentic-observability-logs-exceptions) — Get Observability Logs Exceptions.

## Alerts

Manage alert subscribers, preferences, and notification credentials.

- [`GET /alerts/subscribers/{subscriberId}`](/api-reference/alerts/get-alert-subscriber) — Get Subscribers.
- [`PUT /alerts/subscribers/{subscriberId}`](/api-reference/alerts/update-alert-subscriber) — Update Subscribers.
- [`GET /alerts/subscribers/{subscriberId}/preferences`](/api-reference/alerts/get-subscriber-preferences) — Get Subscriber Preferences.
- [`PUT /alerts/subscribers/{subscriberId}/credentials`](/api-reference/alerts/update-subscriber-credentials) — Update Subscriber Credentials.
- [`DELETE /alerts/subscribers/{subscriberId}/credentials`](/api-reference/alerts/delete-subscriber-credentials) — Delete Subscriber Credentials.
- [`POST /alerts/summary`](/api-reference/alerts/summarize-alert) — Summarise Alert.

## Authentication

Obtain and refresh access tokens, manage client credentials and roles.

- [`POST /auth/access-token`](/api-reference/authentication/get-access-token) — Access Token.
- [`POST /auth/switch-tenant`](/api-reference/authentication/switch-tenant) — Switch Tenant.
- [`POST /auth/access-token/refresh`](/api-reference/authentication/refresh-access-token) — Refresh Access Token.
- [`GET /auth/whoami`](/api-reference/authentication/get-caller-identity) — Whoami.
- [`GET /auth/roles`](/api-reference/authentication/list-roles) — Get Roles.
- [`GET /auth/tools`](/api-reference/authentication/list-mcp-tools) — Get Mcp Tools.
- [`GET /auth/permissions`](/api-reference/authentication/list-permissions) — Get Permissions.
- [`GET /auth/client-credentials`](/api-reference/authentication/list-client-credentials) — List Client Credentials.
- [`POST /auth/client-credentials`](/api-reference/authentication/create-client-credential) — Create Client Credential.
- [`DELETE /auth/client-credentials/{client_id}`](/api-reference/authentication/delete-client-credential) — Delete Client Credential.
- [`PATCH /auth/client-credentials/{client_id}`](/api-reference/authentication/update-client-credential) — Update Client Credential.

## Consumer Groups

List, inspect, and reset Kafka consumer group offsets.

- [`GET /consumer-groups`](/api-reference/consumer-groups/list-consumer-groups) — List Consumer Groups.
- [`GET /consumer-groups/{group_id}`](/api-reference/consumer-groups/get-consumer-group) — Get Consumer Group Detail.
- [`POST /consumer-groups/{group_id}/reset-offsets`](/api-reference/consumer-groups/reset-consumer-group-offsets) — Reset Consumer Group Offsets.

## Dashboard

Retrieve organisation-level statistics and overview data.

- [`GET /dashboard/organisation/statistics`](/api-reference/dashboard/get-organisation-statistics) — Get Organisation Statistics.
- [`GET /dashboard/health`](/api-reference/dashboard/get-dashboard-health) — Get dashboard health summary.
- [`GET /dashboard/lineage`](/api-reference/dashboard/get-dashboard-lineage) — Get dashboard lineage groups.
- [`GET /dashboard/lineage/topics`](/api-reference/dashboard/get-dashboard-lineage-topics) — Get dashboard lineage topics.
- [`POST /dashboard/lineage/topics/batch`](/api-reference/dashboard/get-dashboard-lineage-topics-batch) — Batch fetch topics for multiple entities.
- [`POST /dashboard/qa-counts`](/api-reference/dashboard/get-qa-counts-dashboard-qa-counts-post) — Get latest QA row counts for topics.

## Destinations

Create, configure, and manage data destinations and their lifecycle.

- [`POST /destinations/search`](/api-reference/destinations/search-destinations) — Search destinations (POST).
- [`GET /destinations`](/api-reference/destinations/list-destinations) — Get Destinations.
- [`POST /destinations`](/api-reference/destinations/create-destination) — Create New Destination.
- [`GET /destinations/brief`](/api-reference/destinations/list-destinations-brief) — List All Destinations Brief.
- [`GET /destinations/connectors`](/api-reference/destinations/list-destination-connector-types) — Get Destinations Connectors.
- [`POST /destinations/{destination_id}/deploy`](/api-reference/destinations/deploy-destination) — Deploy Destination.
- [`POST /destinations/{destination_id}/explain-error`](/api-reference/destinations/explain-destination-error) — Explain Destination Error.
- [`GET /destinations/{destination_id}/metrics`](/api-reference/destinations/get-destination-metrics) — Get Metrics For Destination.
- [`GET /destinations/metrics`](/api-reference/destinations/list-destinations-metrics) — Get Metrics For Destinations.
- [`POST /destinations/metrics`](/api-reference/destinations/search-destinations-metrics) — Get destination metrics (POST).
- [`GET /destinations/configuration`](/api-reference/destinations/get-destination-configuration) — Get Destination Configuration.
- [`GET /destinations/common_configurations`](/api-reference/destinations/list-destination-common-configurations) — Destination Configs.
- [`GET /destinations/sample_scripts`](/api-reference/destinations/list-destination-sample-scripts) — Get Sample Scripts For Destinations.
- [`POST /destinations/invite`](/api-reference/destinations/invite-destination-collaborator) — Destination Invite.
- [`PUT /destinations/bulk_update`](/api-reference/destinations/bulk-update-destinations) — Update Bulk Destinations.
- [`DELETE /destinations/bulk/delete`](/api-reference/destinations/bulk-delete-destinations) — Bulk Delete Destinations.
- [`PUT /destinations/bulk/stop`](/api-reference/destinations/bulk-stop-destinations) — Bulk Stop Destinations.
- [`POST /destinations/bulk/reset`](/api-reference/destinations/bulk-reset-destinations) — Bulk Reset Destinations.
- [`PUT /destinations/bulk/resume`](/api-reference/destinations/bulk-resume-destinations) — Bulk Resume Destinations.
- [`PUT /destinations/{destination_id}/resume`](/api-reference/destinations/resume-destination) — Resume Existing Destination.
- [`PUT /destinations/{destination_id}/pause`](/api-reference/destinations/pause-destination) — Pause Existing Destination.
- [`PUT /destinations/{destination_id}/stop`](/api-reference/destinations/stop-destination) — Stop Existing Destination.
- [`POST /destinations/{destination_id}/restart`](/api-reference/destinations/restart-destination) — Restart Existing Destination.
- [`POST /destinations/{destination_id}/reset`](/api-reference/destinations/reset-destination) — Reset Existing Destination.
- [`POST /destinations/{destination_id}/restart_task`](/api-reference/destinations/restart-destination-task) — Restart Destination Task Api.
- [`GET /destinations/{destination_id}`](/api-reference/destinations/get-destination) — Get Destination.
- [`PUT /destinations/{destination_id}`](/api-reference/destinations/update-destination) — Update Existing Destination.
- [`DELETE /destinations/{destination_id}`](/api-reference/destinations/delete-destination) — Delete Existing Destination.
- [`GET /destinations/{destination_id}/config-history`](/api-reference/destinations/get-destination-config-history) — Get Destination Config History.
- [`GET /destinations/{destination_id}/config-history/compare-to-original`](/api-reference/destinations/get-destination-config-comparison) — Get Destination Config Comparison.

## Kafka Access

Manage Kafka users and their access permissions.

- [`GET /kafka-access/kafka-users`](/api-reference/kafka-access/list-kafka-users) — List Kafka Users.
- [`POST /kafka-access/kafka-users`](/api-reference/kafka-access/create-kafka-user) — Create New Kafka User.
- [`PUT /kafka-access/kafka-users/{username}`](/api-reference/kafka-access/update-kafka-user) — Update Kafka User.
- [`DELETE /kafka-access/kafka-users/{username}`](/api-reference/kafka-access/delete-kafka-user) — Delete Kafka User.

## Logs

Query and summarise system logs.

- [`POST /logs`](/api-reference/logs/query-logs) — Get Logs.
- [`POST /logs/summary`](/api-reference/logs/summarize-log) — Summarise Log.
- [`POST /logs/histogram`](/api-reference/logs/get-logs-histogram) — Get Logs Histogram.
- [`POST /logs/count`](/api-reference/logs/get-logs-count) — Get Logs Count.

## Pipelines

Create, configure, and manage CDC pipelines and their lifecycle.

- [`POST /pipelines/search`](/api-reference/pipelines/search-pipelines) — Search pipelines (POST).
- [`GET /pipelines`](/api-reference/pipelines/list-pipelines) — Get Pipelines.
- [`POST /pipelines`](/api-reference/pipelines/create-pipeline) — Create New Pipeline.
- [`GET /pipelines/brief`](/api-reference/pipelines/list-pipelines-brief) — List All Pipelines Brief.
- [`POST /pipelines/row-level-audit`](/api-reference/pipelines/trigger-row-level-audit) — Trigger Pipeline Row Level Audit.
- [`GET /pipelines/{pipeline_id}/metrics`](/api-reference/pipelines/get-pipeline-metrics) — Get Metrics For Pipeline.
- [`GET /pipelines/metrics`](/api-reference/pipelines/list-pipelines-metrics) — Get Metrics For Pipelines.
- [`POST /pipelines/metrics`](/api-reference/pipelines/search-pipelines-metrics) — Get pipeline metrics (POST).
- [`GET /pipelines/logs`](/api-reference/pipelines/list-pipeline-logs) — Get Logs For Pipelines.
- [`GET /pipelines/{pipeline_id}`](/api-reference/pipelines/get-pipeline) — Get Pipeline.
- [`PUT /pipelines/{pipeline_id}`](/api-reference/pipelines/update-pipeline) — Update Existing Pipeline.
- [`DELETE /pipelines/{pipeline_id}`](/api-reference/pipelines/delete-pipeline) — Delete Existing Pipeline.
- [`PUT /pipelines/bulk_update`](/api-reference/pipelines/bulk-update-pipelines) — Update Bulk Pipelines.
- [`DELETE /pipelines/bulk/delete`](/api-reference/pipelines/bulk-delete-pipelines) — Bulk Delete Pipelines.

## Project Keys

Manage project keys that bundle API credentials and optional Kafka access.

- [`GET /project-keys`](/api-reference/project-keys/list-project-keys) — List Project Keys.
- [`POST /project-keys`](/api-reference/project-keys/create-project-key) — Create Project Key.
- [`GET /project-keys/{project_key_id}`](/api-reference/project-keys/get-project-key) — Get Project Key.
- [`DELETE /project-keys/{project_key_id}`](/api-reference/project-keys/delete-project-key) — Delete Project Key.
- [`PATCH /project-keys/{project_key_id}`](/api-reference/project-keys/update-project-key) — Update Project Key.
- [`GET /project-keys/{project_key_id}/mcp-config`](/api-reference/project-keys/get-project-key-mcp-config) — Get Project Key Mcp Config.
- [`POST /project-keys/{project_key_id}/enable-agentic`](/api-reference/project-keys/enable-project-key-agentic) — Enable Project Key Agentic.
- [`POST /project-keys/{project_key_id}/disable-agentic`](/api-reference/project-keys/disable-project-key-agentic) — Disable Project Key Agentic.

## Schema Registry

Browse schema subjects, versions, and retrieve schema definitions.

- [`GET /schema-registry/subjects`](/api-reference/schema-registry/list-schema-subjects) — List Schema Subjects.
- [`GET /schema-registry/subjects/{subject}/versions`](/api-reference/schema-registry/list-schema-versions) — List Subject Versions.
- [`GET /schema-registry/subjects/{subject}/versions/{version}`](/api-reference/schema-registry/get-schema-by-version) — Get Schema By Version.
- [`GET /schema-registry/schemas/{schema_id}`](/api-reference/schema-registry/get-schema-by-id) — Get Schema By Id.

## Services

View and switch service metadata.

- [`GET /services/all`](/api-reference/services/list-services) — Get All Service Metadata.
- [`PUT /services/switch`](/api-reference/services/switch-service) — Switch.

## Sources

Create, configure, and manage data sources, snapshots, and their lifecycle.

- [`POST /sources/search`](/api-reference/sources/search-sources) — Search sources (POST).
- [`GET /sources`](/api-reference/sources/list-sources) — Get Sources.
- [`POST /sources`](/api-reference/sources/create-source) — Create New Source.
- [`GET /sources/brief`](/api-reference/sources/list-sources-brief) — List All Sources Brief.
- [`GET /sources/connectors`](/api-reference/sources/list-source-connector-types) — Get Sources Connectors.
- [`POST /sources/{source_id}/deploy`](/api-reference/sources/deploy-source) — Deploy Source.
- [`POST /sources/{source_id}/explain-error`](/api-reference/sources/explain-source-error) — Explain Source Error.
- [`GET /sources/{source_id}/metrics`](/api-reference/sources/get-source-metrics) — Get Metrics For Source.
- [`GET /sources/metrics`](/api-reference/sources/list-sources-metrics) — Get Metrics For Sources.
- [`POST /sources/metrics`](/api-reference/sources/search-sources-metrics) — Get source metrics (POST).
- [`GET /sources/configuration`](/api-reference/sources/get-source-configuration) — Get Source Configuration.
- [`GET /sources/common_configurations`](/api-reference/sources/list-source-common-configurations) — Source Configs.
- [`POST /sources/invite`](/api-reference/sources/invite-source-collaborator) — Source Invite.
- [`POST /sources/execute_incremental_snapshot`](/api-reference/sources/execute-incremental-snapshot) — Execute Incremental Snapshot.
- [`POST /sources/execute_blocking_snapshot`](/api-reference/sources/execute-blocking-snapshot) — Execute Blocking Snapshot.
- [`POST /sources/execute_parallel_snapshot`](/api-reference/sources/execute-parallel-snapshot) — Execute Parallel Snapshot.
- [`POST /sources/stop_incremental_snapshot`](/api-reference/sources/stop-incremental-snapshot) — Stop Incremental Snapshot.
- [`POST /sources/stop_blocking_snapshot`](/api-reference/sources/stop-blocking-snapshot) — Stop Blocking Snapshot.
- [`POST /sources/snapshot`](/api-reference/sources/execute-snapshot) — Execute Snapshot.
- [`POST /sources/cancel_snapshot`](/api-reference/sources/cancel-snapshot) — Cancel Snapshot.
- [`PUT /sources/bulk_update`](/api-reference/sources/bulk-update-sources) — Update Bulk Sources.
- [`DELETE /sources/bulk/delete`](/api-reference/sources/bulk-delete-sources) — Bulk Delete Sources.
- [`POST /sources/bulk/snapshot`](/api-reference/sources/bulk-snapshot-sources) — Bulk Execute Snapshot Sources.
- [`POST /sources/bulk/parallel-snapshot`](/api-reference/sources/bulk-parallel-snapshot-sources) — Bulk Parallel Snapshot Sources.
- [`POST /sources/bulk/stop-snapshot`](/api-reference/sources/bulk-stop-snapshot-sources) — Bulk Stop Snapshot Sources.
- [`PUT /sources/bulk/stop`](/api-reference/sources/bulk-stop-sources) — Bulk Stop Sources.
- [`POST /sources/bulk/reset`](/api-reference/sources/bulk-reset-sources) — Bulk Reset Sources.
- [`PUT /sources/bulk/resume`](/api-reference/sources/bulk-resume-sources) — Bulk Resume Sources.
- [`PUT /sources/{source_id}/pause`](/api-reference/sources/pause-source) — Pause Existing Source.
- [`PUT /sources/{source_id}/resume`](/api-reference/sources/resume-source) — Resume Existing Source.
- [`PUT /sources/{source_id}/stop`](/api-reference/sources/stop-source) — Stop Existing Source.
- [`POST /sources/{source_id}/restart`](/api-reference/sources/restart-source) — Restart Existing Source.
- [`POST /sources/{source_id}/reset`](/api-reference/sources/reset-source) — Reset Existing Source.
- [`POST /sources/{source_id}/restart_task`](/api-reference/sources/restart-source-task) — Restart Source Task Api.
- [`GET /sources/{source_id}`](/api-reference/sources/get-source) — Get Source.
- [`PUT /sources/{source_id}`](/api-reference/sources/update-source) — Update Existing Source.
- [`DELETE /sources/{source_id}`](/api-reference/sources/delete-source) — Delete Existing Source.
- [`GET /sources/{source_id}/config-history`](/api-reference/sources/get-source-config-history) — Get Source Config History.
- [`GET /sources/{source_id}/config-history/compare-to-original`](/api-reference/sources/get-source-config-comparison) — Get Source Config Comparison.

## Tags

Create, update, and manage resource tags for organisation.

- [`POST /tags/search`](/api-reference/tags/search-tags) — Search tags (POST).
- [`GET /tags`](/api-reference/tags/list-tags) — Get Tags For Specific Tenant.
- [`POST /tags`](/api-reference/tags/create-tag) — Create Tag.
- [`GET /tags/{tag_type}`](/api-reference/tags/list-tags-by-type) — Get Tags By Type.
- [`PUT /tags/{tag_id}`](/api-reference/tags/update-tag) — Update Tag.
- [`DELETE /tags/{tag_id}`](/api-reference/tags/delete-tag) — Delete Tag.

## Topics

Browse topic details, statistics, configurations, metrics, and messages.

- [`POST /topics/details/search`](/api-reference/topics/search-topics) — Search topics (POST).
- [`GET /topics/details`](/api-reference/topics/list-topics) — List all topics.
- [`GET /topics/details/grouped`](/api-reference/topics/list-topics-grouped) — List topics grouped by connector/entity.
- [`GET /topics/statistics`](/api-reference/topics/get-topic-statistics) — Get topic statistics.
- [`GET /topics/configs`](/api-reference/topics/get-topic-configs) — Get topic configurations.
- [`GET /topics/metrics`](/api-reference/topics/get-topic-metrics) — Get topic metrics.
- [`POST /topics/table_metrics`](/api-reference/topics/get-topic-table-metrics) — Per-topic Kafka metadata for the topics list.
- [`GET /topics/messages`](/api-reference/topics/get-topic-messages) — Get topic messages.
- [`GET /topics/messages/value`](/api-reference/topics/get-topic-message-value) — Get a single topic message value.
- [`GET /topics/{topic_id}/raw-metrics`](/api-reference/topics/get-topic-raw-metrics) — Get latest raw metrics for a topic.
- [`POST /topics/bulk/snapshot`](/api-reference/topics/bulk-snapshot-topics) — Bulk Snapshot Topics.
- [`POST /topics/bulk/stop-snapshot`](/api-reference/topics/bulk-stop-snapshot-topics) — Bulk Stop Snapshot Topics.
- [`GET /topics/catalog`](/api-reference/topics/get-topic-catalog) — Browse topics for SQL Studio.
- [`GET /topics/catalog/grouped`](/api-reference/topics/get-topic-catalog-grouped) — Browse topics grouped by source.
- [`GET /topics/catalog/schema`](/api-reference/topics/get-topic-schema) — Get schema for a single topic.
- [`POST /topics/query`](/api-reference/topics/execute-sql-query) — Execute SQL query against Kafka topics.
- [`POST /topics`](/api-reference/topics/create-topic) — Create a new Kafka topic.
- [`POST /topics/internal/publish`](/api-reference/topics/publish-internal-topic-message) — Publish a record to a Streamkap/KC internal topic (local + admin app only).
- [`GET /topics/{topic_id}`](/api-reference/topics/get-topic) — Get comprehensive topic information.
- [`PUT /topics/{topic_id}`](/api-reference/topics/update-topic) — Update Topic Api.
- [`DELETE /topics/{topic_id}`](/api-reference/topics/delete-topic) — Delete Topic Api.
- [`PUT /topics/bulk_update`](/api-reference/topics/bulk-update-topics) — Update Bulk Topics.

## Transforms

Create, deploy, and manage data transforms, unit tests, and implementation details.

- [`POST /transforms/search`](/api-reference/transforms/search-transforms) — Search transforms (POST).
- [`GET /transforms`](/api-reference/transforms/list-transforms) — Get Full Transforms.
- [`PUT /transforms`](/api-reference/transforms/update-transform) — Update Transform.
- [`POST /transforms`](/api-reference/transforms/create-transform) — Create New Transform.
- [`DELETE /transforms`](/api-reference/transforms/delete-transform) — Delete Existing Transform.
- [`GET /transforms/brief`](/api-reference/transforms/list-transforms-brief) — List All Transforms Brief.
- [`GET /transforms/topics-for-pattern/{topic_pattern}/{java_replacement_pattern}`](/api-reference/transforms/get-topics-for-pattern) — Get Topics For Pattern.
- [`PUT /transforms/bulk_update`](/api-reference/transforms/bulk-update-transforms) — Update Bulk Transforms.
- [`POST /transforms/bulk/clone`](/api-reference/transforms/bulk-clone-transforms) — Bulk Clone Transforms.
- [`DELETE /transforms/bulk/delete`](/api-reference/transforms/bulk-delete-transforms) — Bulk Delete Transforms.
- [`PUT /transforms/{transforms_id}/set-input-output-topics/{topic_pattern}/{java_replacement_pattern}`](/api-reference/transforms/set-transform-input-output-topics) — Set Input Output Topics.
- [`PUT /transforms/{transforms_id}/clear-output-topics/{output_topic_pattern}`](/api-reference/transforms/clear-transform-output-topics) — Clear Output Topics.
- [`GET /transforms/{transforms_id}/output-topics`](/api-reference/transforms/get-transform-output-topics) — Get Output Topics For Transform.
- [`GET /transforms/{transforms_id}/errors`](/api-reference/transforms/get-transform-errors) — Get Errors Transform.
- [`GET /transforms/{transforms_id}/job_status`](/api-reference/transforms/get-transform-job-status) — Get Jobs Status.
- [`GET /transforms/{transforms_id}/implementation_details`](/api-reference/transforms/get-transform-implementation) — Get Transforms Implementation Details.
- [`PUT /transforms/{transforms_id}/implementation_details`](/api-reference/transforms/update-transform-implementation) — Put Transforms Implementation Details.
- [`PUT /transforms/{transforms_id}/run-unit-tests/{version_id}`](/api-reference/transforms/run-transform-unit-tests) — Run Unit Tests.
- [`PUT /transforms/{transforms_id}/deploy-job-preview/{version_id}`](/api-reference/transforms/deploy-transform-preview) — Deploy Job Preview.
- [`PUT /transforms/{transforms_id}/deploy-job-live/{version_id}`](/api-reference/transforms/deploy-transform-live) — Deploy Job Live.
- [`GET /transforms/details`](/api-reference/transforms/list-transform-details) — Get Transform Details.
- [`GET /transforms/configs`](/api-reference/transforms/list-transform-configs) — Get Transform Configs.
- [`POST /transforms/{transform_id}/clone`](/api-reference/transforms/clone-transform) — Clone Transform.
- [`POST /transforms/full-process`](/api-reference/transforms/create-transform-full-process) — Create New Transform With Full Process.
- [`GET /transforms/metrics`](/api-reference/transforms/list-transform-metrics) — Get Transform Metrics.
- [`GET /transforms/{transform_id}`](/api-reference/transforms/get-transform) — Get Full Transforms With Id.
- [`GET /transforms/{transform_id}/dlq`](/api-reference/transforms/get-transform-dlq-errors) — Get Transform Dlq Errors.
- [`GET /transforms/{transform_id}/checkpoints`](/api-reference/transforms/get-transform-checkpoints) — Get Transform Checkpoints.

## Usage

- [`GET /billing/usage/metrics`](/api-reference/usage/get-usage-metrics) — Get Usage Metrics.
- [`POST /billing/usage/metrics`](/api-reference/usage/search-usage-metrics) — Get usage metrics (POST).
- [`GET /billing/usage/summary`](/api-reference/usage/get-usage-summary) — Get Usage Summary.
- [`GET /billing/usage/export`](/api-reference/usage/export-usage-metrics) — Get Usage Export.

## other

- [`GET /other/tenant/trees`](/api-reference/other/get-tenant-trees) — Get Tenant Trees.

## Cluster Scaling

- [`GET /cluster/enabled`](/api-reference/cluster-scaling/is-cluster-scaling-enabled) — Is Cluster Scaling Enabled.
- [`GET /cluster/status`](/api-reference/cluster-scaling/get-cluster-status) — Get Cluster Status.
- [`POST /cluster/scale`](/api-reference/cluster-scaling/scale-cluster) — Scale Cluster.
- [`GET /cluster/scale/{operation_id}`](/api-reference/cluster-scaling/get-scale-operation-status) — Get Scale Operation Status.
- [`POST /cluster/scale/{operation_id}/cancel`](/api-reference/cluster-scaling/cancel-scale-operation) — Cancel Scale Operation.

## Knowledge Bases

- [`POST /knowledge-bases/config`](/api-reference/knowledge-bases/create-knowledge-base) — Create Knowledge Base.
- [`GET /knowledge-bases`](/api-reference/knowledge-bases/list-knowledge-bases) — List Knowledge Bases.
- [`GET /knowledge-bases/{kb_id}`](/api-reference/knowledge-bases/get-knowledge-base) — Get Knowledge Base.
- [`DELETE /knowledge-bases/{kb_id}`](/api-reference/knowledge-bases/delete-knowledge-base) — Delete Knowledge Base.
- [`POST /knowledge-bases/{kb_id}/cancel`](/api-reference/knowledge-bases/cancel-knowledge-base) — Cancel Knowledge Base.
- [`POST /knowledge-bases/{kb_id}/stop`](/api-reference/knowledge-bases/stop-knowledge-base) — Stop Knowledge Base.
- [`POST /knowledge-bases/{kb_id}/retrieve`](/api-reference/knowledge-bases/retrieve-knowledge-base) — Retrieve Knowledge Base.

## Flink Jobs

- [`POST /flink_jobs/jar`](/api-reference/flink-jobs/deploy-flink-jar-job) — Deploy Jar Job.
- [`POST /flink_jobs/pyflink`](/api-reference/flink-jobs/deploy-flink-py-flink-job) — Deploy Pyflink Job.
- [`GET /flink_jobs/`](/api-reference/flink-jobs/list-flink-jobs) — List Flink Jobs.
- [`GET /flink_jobs/{job_id}`](/api-reference/flink-jobs/get-flink-job) — Get Flink Job.
- [`DELETE /flink_jobs/{job_id}`](/api-reference/flink-jobs/delete-flink-job) — Delete Flink Job.
- [`GET /flink_jobs/{job_id}/status`](/api-reference/flink-jobs/get-flink-job-status) — Get Flink Job Status.
- [`POST /flink_jobs/{job_id}/cancel`](/api-reference/flink-jobs/cancel-flink-job) — Cancel Flink Job.
- [`POST /flink_jobs/{job_id}/restart`](/api-reference/flink-jobs/restart-flink-job) — Restart Flink Job.