> ## 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.

# Browse topics for SQL Studio

> Get a browsable catalog of topics with schema metadata for the Query Playground.



## OpenAPI

````yaml /openapi/openapi.json get /topics/catalog
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:
  /topics/catalog:
    get:
      tags:
        - Topics
      summary: Browse topics for SQL Studio
      description: >-
        Get a browsable catalog of topics with schema metadata for the Query
        Playground.
      operationId: getTopicCatalog
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            default: 50
            title: Page Size
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Partial topic name search
            title: Search
          description: Partial topic name search
        - name: value_format
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by serialization format (avro, json, protobuf, etc.)
            title: Value Format
          description: Filter by serialization format (avro, json, protobuf, etc.)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaTopicCatalogRes'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - FronteggHTTPAuthentication: []
components:
  schemas:
    KafkaTopicCatalogRes:
      properties:
        page:
          type: integer
          title: Page
          description: Current page number
          default: 1
        page_size:
          type: integer
          title: Page Size
          description: Results per page
          default: 10
        total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total
          description: Total number of results
        has_next:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Next
          description: Whether more pages exist
        result:
          items:
            $ref: '#/components/schemas/KafkaTopicCatalogEntry'
          type: array
          title: Result
      additionalProperties: true
      type: object
      required:
        - result
      title: KafkaTopicCatalogRes
      description: Paginated topic catalog response.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    KafkaTopicCatalogEntry:
      properties:
        topic_id:
          type: string
          title: Topic Id
          description: Kafka topic name (e.g., source_abc.public.users)
        display_name:
          type: string
          title: Display Name
          description: Short display name for the sidebar
        partition_count:
          type: integer
          title: Partition Count
          description: Number of partitions
          default: 0
        value_format:
          $ref: '#/components/schemas/SerializationFormatEnum'
          description: Serialization format of the topic values
          default: unknown
        schema_fields:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Schema Fields
          description: >-
            Schema fields from Schema Registry (list of {name, type} dicts), or
            None if no schema
        entity_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Entity Type
          description: 'Producer type: sources, transforms, manual'
        entity_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Entity Id
          description: Producer entity ID
        entity_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Entity Name
          description: Producer entity display name
      additionalProperties: true
      type: object
      required:
        - topic_id
        - display_name
      title: KafkaTopicCatalogEntry
      description: A topic entry in the catalog sidebar of the SQL Studio.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    SerializationFormatEnum:
      type: string
      enum:
        - avro
        - json
        - json_schema
        - protobuf
        - string
        - bytearray
        - unknown
      title: SerializationFormatEnum
      description: Human-readable serialization format names for API responses.
  securitySchemes:
    FronteggHTTPAuthentication:
      type: http
      scheme: bearer

````