Skip to main content
GET
/
v1
/
memory
/
runbooks
List runbooks
curl --request GET \
  --url https://api.example.com/v1/memory/runbooks \
  --header 'Authorization: <authorization>'

​
Overview

Returns runbooks automatically generated from your team’s resolved incidents. Each runbook captures the steps that successfully resolved a class of incident, validated against actual remediation outcomes. Required role: admin or member

​
Request headers

​
Authorization
string
required
JWT Bearer token. Format: Bearer <your-jwt>.

​
Query parameters

​
service
string
Filter runbooks by affected service name (e.g. checkout-service).
​
q
string
Full-text search across runbook titles and content.
​
limit
integer
Maximum results to return. Default: 20. Maximum: 100.
​
cursor
string
Pagination cursor from a previous response.

​
Response

Returns 200 OK. 
{
  "items": [
    {
      "runbookId": "rbk_01HX9VTPQR3KF8MZWBYD5N6JCE",
      "title": "Connection pool exhaustion — checkout service",
      "services": ["checkout-service", "payment-processor"],
      "steps": [
        "1. Confirm pool size: `kubectl exec -it checkout-<pod> -- env | grep DB_POOL_SIZE`",
        "2. Update ECS task definition: set `DB_POOL_SIZE=150`",
        "3. Trigger rolling deploy and monitor error rate",
        "4. Verify resolution: error rate should drop within 90 seconds"
      ],
      "successRate": 1.0,
      "usageCount": 3,
      "lastUsedAt": "2024-04-01T14:37:30Z",
      "generatedAt": "2024-03-15T06:00:00Z"
    }
  ],
  "total": 12,
  "nextCursor": null
}
FieldTypeDescription
runbookIdstringUnique runbook identifier
titlestringRunbook title describing the incident class
servicesstring[]Services this runbook applies to
stepsstring[]Ordered resolution steps
successRatenumberFraction of usages that led to resolved outcome (0.0–1.0)
usageCountintegerNumber of times this runbook was applied
lastUsedAtstringISO 8601 timestamp of most recent use
generatedAtstringISO 8601 timestamp when the runbook was first generated

​
Error responses

StatusError codeDescription
401unauthorizedMissing or invalid JWT
403forbiddenCaller lacks required role

​
Examples

curl "https://api.causeflow.ai/v1/memory/runbooks?service=checkout-service" \
  -H "Authorization: Bearer eyJhbGc..."

Memory insights

AI-generated insights from your incident history

Knowledge patterns

Browse raw failure patterns extracted by AI