Skip to main content
POST
Create alert rule

Authorizations

Authorization
string
header
required

Bearer token: an organization API key (ak_…) created under Settings → API Keys, or a dashboard user session token. Proxy keys (xe_…) are not accepted here. Endpoints marked as user-only in their description reject organization keys with 403.

Body

application/json
name
string
required
Required string length: 1 - 255
kind
enum<string>
default:event
Available options:
event,
metric
trigger_type
enum<string> | null
Available options:
policy_block,
policy_redact,
policy_escalate,
guardrail_escalate,
guardrail_block,
high_latency,
high_intent_score,
run_error,
turn_blocked,
turn_escalated,
turn_error
threshold
number | null
severity
enum<string>
default:warning
Available options:
info,
warning,
critical
cooldown_seconds
integer
default:300
Required range: 60 <= x <= 86400
metric
enum<string> | null
Available options:
turn_error_rate,
turn_blocked_rate,
escalation_count,
turn_count,
no_traffic,
token_usage,
llm_latency_p95_ms,
ttft_p95_ms,
llm_cost_usd,
guardrail_score_avg,
guardrail_block_count,
policy_block_rate
aggregation
string | null
operator
enum<string> | null
Available options:
gt,
gte,
lt,
lte
window_seconds
enum<integer> | null
Available options:
300,
900,
3600,
86400
group_by
enum<string> | null
Available options:
proxy_id,
policy_rule,
guardrail_name
min_samples
integer
default:0
Required range: 0 <= x <= 100000
filters
Filters · object
channels
enum<string>[]
Available options:
in_app,
email,
slack
proxy_id
string<uuid> | null
enabled
boolean
default:true

Response

Successful Response

id
string<uuid>
required
org_id
string<uuid>
required
proxy_id
string<uuid> | null
required
name
string
required
kind
string
required
trigger_type
string | null
required
threshold
number | null
required
severity
string
required
cooldown_seconds
integer
required
metric
string | null
required
aggregation
string | null
required
operator
string | null
required
window_seconds
integer | null
required
group_by
string | null
required
min_samples
integer
required
filters
Filters · object
required
channels
string[]
required
enabled
boolean
required
created_by
string<uuid> | null
required
created_at
string<date-time>
required
updated_at
string<date-time> | null
required