Skip to main content
GET
Get Alert

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

alert_identifier
string
required

Alert ID (alt_...) or name

Response

Successful Response

Response model for a single alert.

name
string
required

Human-readable name for the alert

Required string length: 1 - 200
Examples:

"Safety Incident Detector"

"Prohibited Content Alert"

notification_config
AlertNotificationConfig · object
required

How and where to send notifications when alert triggers

Example:
alert_id
string

Unique identifier for the alert

Example:

"alt_abc123xyz789"

namespace_id
string | null

Namespace this alert belongs to

Example:

"ns_production"

description
string | null

Optional description of what this alert monitors

Maximum string length: 1000
Example:

"Alerts when new videos match known safety incidents"

source
enum<string>
default:retriever

Trigger source: 'retriever' (runs a retriever) or 'system' (built-in metric)

Available options:
retriever,
system
retriever_id
string | null

ID of the retriever to execute (source=retriever only). The retriever defines filters, scoring, limits.

Example:

"ret_safety_search"

trigger_on
enum<string>
default:results

For source=retriever: fire on 'results' (matches found) or 'no_results' (retriever went dark).

Available options:
results,
no_results
system_condition
SystemCondition · object | null

Built-in data-plane condition to watch (source=system only)

namespace_selector
NamespaceSelector · object | null

Org-level namespace scoping (all vs selected). When omitted, the alert is scoped to its own namespace_id.

enabled
boolean
default:true

Whether the alert is active and will execute

created_at
string<date-time> | null

Timestamp when the alert was created

updated_at
string<date-time> | null

Timestamp when the alert was last updated

metadata
Metadata · object

Additional user-defined metadata for the alert