API reference · Recorder
Create an alert rule
POST/api/alertsSigned in session
The threshold is an integer in the metric's own unit: micro USD for spend, basis points for error_rate, milliseconds for ttft_p95.
Request body
application/json, required
| Field | Type | What it is |
|---|---|---|
| namerequired | string | |
| metricrequired | string | One of "spend", "error_rate", "ttft_p95". |
| thresholdrequired | integer | |
| windowMinutes | integer | From 5 to 10080. |
| minSamples | integer | At least 1. |
| scopeModel | string or null | |
| scopeKeyId | integer or null | |
| enabled | boolean |
Example
{
"name": "string",
"metric": "spend",
"threshold": 0
}Answer 201
The new rule.
| Field | Type | What it is |
|---|---|---|
| rule | AlertRule | |
| rule. | integer | |
| rule. | string | |
| rule. | string | One of "spend", "error_rate", "ttft_p95". |
| rule. | integer | Micro USD, basis points, or milliseconds, by metric. |
| rule. | integer | |
| rule. | integer | How many requests the window needs before the number is believed. |
| rule. | string or null | |
| rule. | integer or null | |
| rule. | boolean | |
| rule. | string | One of "ok", "firing". |
| rule. | integer or null | Null when the last check found nothing to measure. |
| rule. | integer or null | |
| rule. | integer or null | |
| rule. | integer | |
| rule. | integer |
Errors
- 400OpenAI shaped error.
- 401OpenAI shaped error.
Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.