Update a New AI Anomaly

put

https://api.revenium.ai/profitstream/v2/api/sources/ai/anomaly/{id}

Updates a new AI Anomaly.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Unique identifier of the AI anomaly to update. This is the Revenium-generated hashid returned when the anomaly was created. Format: URL-safe encoded string.

Body Params

name

string

required

The name of the anomaly alert

teamId

string

required

The unique identifier of the team that owns this anomaly alert. The teamId can be found in the developer section of the Revenium web application.

alertType

string

enum

required

The type of alert monitoring strategy. THRESHOLD monitors for absolute values exceeding a threshold, RELATIVE_CHANGE monitors for percentage changes between periods, CUMULATIVE_USAGE monitors for total usage over a period

Allowed:

metricType

string

enum

required

The AI metric to monitor. Cost metrics track spending, token metrics track usage, performance metrics track latency and duration, error metrics track failures

operatorType

string

enum

required

The comparison operator used to evaluate the threshold. Comparison operators (GREATER_THAN, LESS_THAN, EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, LESS_THAN_OR_EQUAL_TO) compare absolute values. Change operators (PERCENT_INCREASE, PERCENT_DECREASE, INCREASES_BY, DECREASES_BY) compare relative changes between periods

threshold

number

required

The numeric threshold value that triggers the alert. For percentage-based alerts (when isPercentage is true), this represents the percentage value (e.g., 50 for 50%). For absolute value alerts, this is the metric value to compare against

isPercentage

boolean

Whether the threshold value represents a percentage. When true, the threshold is interpreted as a percentage value. When false or null, the threshold is an absolute value

notificationAddresses

array of strings

required

Email addresses to notify when the alert is triggered. Multiple addresses can be specified. Each address will receive an email notification when the anomaly condition is met

notificationAddresses*

slackConfigurations

array of strings

required

Slack configuration IDs to notify when the alert is triggered. Each configuration represents a Slack workspace and channel where notifications will be posted

slackConfigurations*

description

string

Optional description providing additional context about the alert's purpose and configuration

periodDuration

string

enum

required

The time period over which the metric is evaluated. For THRESHOLD and RELATIVE_CHANGE alerts, this determines the evaluation window. For CUMULATIVE_USAGE alerts, this determines the accumulation period

enabled

boolean

required

Whether the anomaly alert is active. When false, the alert is disabled without being deleted from the database. Disabled alerts do not evaluate conditions or send notifications

filters

array of objects

Filter criteria to limit the scope of anomaly monitoring. Each filter specifies a dimension (e.g., ORGANIZATION, PRODUCT, MODEL), an operator (e.g., IS, CONTAINS), and a value to match. Only metrics matching all filters are evaluated

filters

webhookConfigurations

array of strings

required

Webhook configuration IDs to notify when the alert is triggered. Each configuration represents a webhook endpoint that will receive a POST request with alert details

webhookConfigurations*

groupBy

string

enum

The dimension by which to group anomaly monitoring. When specified, separate alerts are evaluated for each unique value of this dimension (e.g., per ORGANIZATION, per MODEL, per PRODUCT)

triggerAfterPersistsDuration

string

enum

The duration the anomaly condition must persist before triggering the alert. This prevents false positives from transient spikes. If null, the alert triggers immediately when the condition is met

percentage

boolean

_links

object

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200AI Anomaly updated successfully

400Invalid input data

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found

409Conflict - Resource conflict

422Unprocessable entity - Validation failed