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

# Summarise Alert

> Generate AI-powered summary for an alert.

Takes the alert message and context from Courier, enriches with
entity configuration, and returns a structured explanation with
troubleshooting guidance.



## OpenAPI

````yaml /openapi/openapi.json post /alerts/summary
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:
  /alerts/summary:
    post:
      tags:
        - Alerts
      summary: Summarise Alert
      description: |-
        Generate AI-powered summary for an alert.

        Takes the alert message and context from Courier, enriches with
        entity configuration, and returns a structured explanation with
        troubleshooting guidance.
      operationId: summarizeAlert
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SummariseAlertBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - FronteggHTTPAuthentication: []
components:
  schemas:
    SummariseAlertBody:
      properties:
        alert_id:
          type: string
          minLength: 1
          title: Alert Id
          description: Courier message ID for tracking
        entity_id:
          type: string
          minLength: 1
          title: Entity Id
          description: Entity UUID (source/destination/pipeline)
        entity_type:
          type: string
          enum:
            - sources
            - destinations
            - pipelines
          title: Entity Type
          description: Type of entity this alert is for
        entity_name:
          type: string
          minLength: 1
          title: Entity Name
          description: Human-readable entity name
        alert_state:
          type: string
          enum:
            - TRIGGERED
            - RECOVERED
          title: Alert State
          description: Current alert state (normalized from input)
        alert_message:
          type: string
          maxLength: 10000
          minLength: 1
          title: Alert Message
          description: Alert message content from Courier inbox
        trigger_type:
          anyOf:
            - type: string
              enum:
                - connector_status
                - latency
                - lag
                - no_records
                - dlq
                - json_column_detected
                - transform_status
            - type: 'null'
          title: Trigger Type
          description: >-
            Type of trigger that caused this alert (optional - history fetched
            for all types if omitted)
        alert_datetime:
          type: string
          title: Alert Datetime
          description: When alert was triggered (from Courier payload)
      additionalProperties: false
      type: object
      required:
        - alert_id
        - entity_id
        - entity_type
        - entity_name
        - alert_state
        - alert_message
        - alert_datetime
      title: SummariseAlertBody
      description: Request body for alert AI summary.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  securitySchemes:
    FronteggHTTPAuthentication:
      type: http
      scheme: bearer

````