Skip to content
GET/api/v1/playbooks

List incident-response playbooks

Returns { playbooks, builtIn }. `playbooks` is up to 500 of the caller's rows, newest first, scoped by ?orgId or ?projectId — one is required, though an org-pinned `eg_` key supplies the org itself (400 MISSING_SCOPE when nothing resolves). Each row carries name, description, enabled, trigger_type, match_filter, actions (the auto-remediation shape: slack / email / pagerduty / jira / linear / tines / revoke_api_key / log_only), steps and escalation_paths (the legacy runbook shape), sla_minutes (default 60), and the run_count / last_run_at / last_run_status stats. There is no owner or runbook-reference field. `builtIn` is six read-only starter templates (prompt-injection block, PII leak, critical red-team finding, budget exhausted, shadow AI, DSR intake) that are not stored rows.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Response

200 example

{
  "success": true
}

All status codes

200Playbooks.
400(no description)
401(no description)
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X GET \
  https://evalguard.ai/api/v1/playbooks \
  -H "Authorization: Bearer $EVALGUARD_API_KEY"

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/playbooks", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}` },
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}

response = requests.request("GET", "https://evalguard.ai/api/v1/playbooks", headers=headers)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequestWithContext(context.Background(), "GET", "https://evalguard.ai/api/v1/playbooks", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429500

Other Compliance endpoints