> ## 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 comprehensive topic information ## OpenAPI ````yaml /openapi/openapi.json get /topics/{topic_id} 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: 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/{topic_id}: get: tags: - Topics summary: Get comprehensive topic information operationId: getTopic parameters: - name: topic_id in: path required: true schema: type: string title: Topic Id - name: detailed in: query required: false schema: type: boolean default: false title: Detailed responses: '200': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/TopicDetailsWithKafka' - additionalProperties: true type: object title: Response Gettopic '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - FronteggHTTPAuthentication: [] components: schemas: TopicDetailsWithKafka: properties: id: type: string title: Id name: type: string title: Name entity: $ref: '#/components/schemas/TopicDetailsEntity' prefix: anyOf: - type: string - type: 'null' title: Prefix serialization: anyOf: - $ref: '#/components/schemas/TopicSerialization' - type: 'null' description: >- Serialization format information for this topic (inherited from producer) tags: anyOf: - items: type: string type: array - type: 'null' title: Tags description: List of tag IDs assigned to this topic kafka: $ref: '#/components/schemas/TopicKafkaMetadata' additionalProperties: true type: object required: - id - name - entity - kafka title: TopicDetailsWithKafka description: Topic details with live Kafka information. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError TopicDetailsEntity: properties: entity_type: $ref: '#/components/schemas/TopicDetailsEntityTypeEnum' entity_id: type: string title: Entity Id name: type: string title: Name connector: anyOf: - $ref: '#/components/schemas/SourceConnectorEnum' - $ref: '#/components/schemas/DestinationConnectorEnum' - $ref: '#/components/schemas/TransformsLibraryEnum' - type: string title: Connector topic_ids: items: type: string type: array title: Topic Ids topic_db_ids: items: type: string type: array title: Topic Db Ids display_name: type: string title: Display Name additionalProperties: true type: object required: - entity_type - entity_id - name - connector - topic_ids - topic_db_ids - display_name title: TopicDetailsEntity TopicSerialization: properties: key_format: $ref: '#/components/schemas/SerializationFormatEnum' description: Serialization format for message keys (e.g., avro, json, string) default: unknown value_format: $ref: '#/components/schemas/SerializationFormatEnum' description: Serialization format for message values (e.g., avro, json, protobuf) default: unknown key_converter: anyOf: - type: string - type: 'null' title: Key Converter description: Converter class for message keys value_converter: anyOf: - type: string - type: 'null' title: Value Converter description: Converter class for message values schema_registry_enabled: type: boolean title: Schema Registry Enabled description: Whether Schema Registry is used for this topic's serialization default: false additionalProperties: true type: object title: TopicSerialization description: >- Serialization format information for a topic. Topics inherit their serialization format from their producer (source/transform). Most Streamkap sources use Avro by default with Schema Registry. TopicKafkaMetadata: properties: partitions: $ref: '#/components/schemas/TopicKafkaPartitions' configs: $ref: '#/components/schemas/TopicKafkaConfigs' health: $ref: '#/components/schemas/TopicKafkaHealth' serialization: anyOf: - $ref: '#/components/schemas/TopicSerialization' - type: 'null' description: Serialization format information for this topic additionalProperties: true type: object required: - partitions - configs - health title: TopicKafkaMetadata description: Live Kafka metadata for a topic. 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 TopicDetailsEntityTypeEnum: type: string enum: - sources - destinations - transforms - pipelines - manual title: TopicDetailsEntityTypeEnum description: Enum for topic entity types (producer types). SourceConnectorEnum: type: string enum: - alloydb - elasticsearch - mongodbhosted - mongodb - sqlserveraws - mariadb - mysql - postgresql - oracle - documentdb - oracleaws - kafkadirect - redis - s3 - webhook - zendesk_webhook - salesforce_webhook - db2 - dynamodb - vitess - planetscale - supabase title: SourceConnectorEnum description: |- Available source connector types for CDC data ingestion. Includes relational databases (PostgreSQL, MySQL, SQL Server, Oracle), NoSQL databases (MongoDB, DynamoDB), and direct Kafka connections. DestinationConnectorEnum: type: string enum: - azblob - clickhouse - databricks - mysql - postgresql - redshift - s3 - r2 - gcs - motherduck - weaviate - pinecone - httpsink - sqlserver - bigquery - cockroachdb - db2 - oracle - redis - snowflake - starburst - kafka - kafkadirect - iceberg title: DestinationConnectorEnum description: |- Available destination connector types for data delivery. Supports data warehouses (Snowflake, BigQuery, Databricks), databases (ClickHouse, PostgreSQL), and object storage (S3, Iceberg). TransformsLibraryEnum: type: string enum: - fan_out - sql_join - enrich - enrich_async - map_filter - toast_handling - un_nesting - rollup - topic_router title: TransformsLibraryEnum SerializationFormatEnum: type: string enum: - avro - json - json_schema - protobuf - string - bytearray - unknown title: SerializationFormatEnum description: Human-readable serialization format names for API responses. TopicKafkaPartitions: properties: count: type: integer title: Count replication_factor: type: integer title: Replication Factor under_replicated_count: type: integer title: Under Replicated Count offline_count: type: integer title: Offline Count details: items: $ref: '#/components/schemas/PartitionDetail' type: array title: Details additionalProperties: true type: object required: - count - replication_factor - under_replicated_count - offline_count - details title: TopicKafkaPartitions description: Kafka partition information for a topic. TopicKafkaConfigs: properties: retention_ms: anyOf: - type: string - type: 'null' title: Retention Ms retention_bytes: anyOf: - type: string - type: 'null' title: Retention Bytes cleanup_policy: anyOf: - type: string - type: 'null' title: Cleanup Policy delete_retention_ms: anyOf: - type: string - type: 'null' title: Delete Retention Ms max_message_bytes: anyOf: - type: string - type: 'null' title: Max Message Bytes compression_type: anyOf: - type: string - type: 'null' title: Compression Type min_insync_replicas: anyOf: - type: string - type: 'null' title: Min Insync Replicas segment_ms: anyOf: - type: string - type: 'null' title: Segment Ms segment_bytes: anyOf: - type: string - type: 'null' title: Segment Bytes unclean_leader_election: anyOf: - type: string - type: 'null' title: Unclean Leader Election message_timestamp_type: anyOf: - type: string - type: 'null' title: Message Timestamp Type additionalProperties: true type: object title: TopicKafkaConfigs description: Customer-relevant Kafka configuration properties. TopicKafkaHealth: properties: is_healthy: type: boolean title: Is Healthy under_replicated_partitions: type: integer title: Under Replicated Partitions offline_partitions: type: integer title: Offline Partitions total_replicas: type: integer title: Total Replicas in_sync_replicas: type: integer title: In Sync Replicas additionalProperties: true type: object required: - is_healthy - under_replicated_partitions - offline_partitions - total_replicas - in_sync_replicas title: TopicKafkaHealth description: Topic health indicators. PartitionDetail: properties: partition_id: type: integer title: Partition Id replicas: items: type: integer type: array title: Replicas in_sync_replicas: items: type: integer type: array title: In Sync Replicas is_under_replicated: type: boolean title: Is Under Replicated is_offline: type: boolean title: Is Offline additionalProperties: true type: object required: - partition_id - replicas - in_sync_replicas - is_under_replicated - is_offline title: PartitionDetail description: Customer-focused partition information. securitySchemes: FronteggHTTPAuthentication: type: http scheme: bearer ````