API reference

API reference · Webhooks

The models this account watches for outages

GET/api/account/model-watchSigned in session

Each watched model with what the deployment last concluded: degraded when the circuit breaker on its provider is open, or when over the last hour, with enough requests behind it, the error rate or the median time to first token is over the line; healthy once both are well under it. A change sends model.degraded or model.recovered once to the account's webhooks that subscribe to it, and a line to the Telegram chat linked to the bot.

Answer 200

The watch list and the lines.

Fields of the 200 answer
FieldTypeWhat it is
modelsarray of object
models[].idstringA model id from GET /v1/models.
models[].statestringWhat the deployment last concluded; unknown before there was evidence enough. One of "degraded", "healthy", "unknown".
models[].reasonstring or nullThe evidence behind the state, in a sentence.
models[].sinceinteger or nullWhen the state last changed, epoch ms.
models[].checkedAtinteger or nullWhen the evidence was last read, epoch ms.
models[].notifiedstring or nullThe last transition this account was sent. One of "degraded", "healthy", null.
limitintegerAt most 50 models per account.
windowMinutesintegerThe evidence window, 60 minutes.
thresholdsobject
thresholds.minSamplesintegerRequests in the window before the error rate or the median counts.
thresholds.errorRatePctnumberThe error rate that degrades a model.
thresholds.ttftMsintegerThe median time to first token that degrades a model.
eventsarray of string

Errors

  • 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.

Antimatter