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.

POST/alerts/summary

Authorization

AuthorizationBearer token · headerrequired

Request body

requiredapplication/json

alert_idstringrequired

Courier message ID for tracking

min length 1

entity_idstringrequired

Entity UUID (source/destination/pipeline)

min length 1

entity_typestringrequired

Type of entity this alert is for

Allowed:sourcesdestinationspipelines

entity_namestringrequired

Human-readable entity name

min length 1

alert_statestringrequired

Current alert state (normalized from input)

Allowed:TRIGGEREDRECOVERED

alert_messagestringrequired

Alert message content from Courier inbox

min length 1 · max length 10000

trigger_typestring | null

Type of trigger that caused this alert (optional - history fetched for all types if omitted)

Show properties

Any of:

string

string

null

null

alert_datetimestringrequired

When alert was triggered (from Courier payload)

Responses

200

Successful Response

any

422

Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X POST 'https://api.streamkap.com/alerts/summary' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "alert_id": "string",
  "entity_id": "string",
  "entity_type": "sources",
  "entity_name": "string",
  "alert_state": "TRIGGERED",
  "alert_message": "string",
  "trigger_type": "connector_status",
  "alert_datetime": "string"
}'

const response = await fetch("https://api.streamkap.com/alerts/summary", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"alert_id\": \"string\",\n  \"entity_id\": \"string\",\n  \"entity_type\": \"sources\",\n  \"entity_name\": \"string\",\n  \"alert_state\": \"TRIGGERED\",\n  \"alert_message\": \"string\",\n  \"trigger_type\": \"connector_status\",\n  \"alert_datetime\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://api.streamkap.com/alerts/summary",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"alert_id\": \"string\",\n  \"entity_id\": \"string\",\n  \"entity_type\": \"sources\",\n  \"entity_name\": \"string\",\n  \"alert_state\": \"TRIGGERED\",\n  \"alert_message\": \"string\",\n  \"trigger_type\": \"connector_status\",\n  \"alert_datetime\": \"string\"\n}",
)

Response

Successful Response

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}