API reference

API reference · Webhooks

Replace the watch list

PUT/api/account/model-watchSigned in session

Model ids from the catalog; autopilot ids and presets are routes, not models, and are refused. An empty list clears it. A model kept on the list keeps what it was last told. Same origin only; ten changes a minute.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
modelsrequiredarray of string

Example

{
  "models": [
    "string"
  ]
}

Answer 200

The watch list as it now stands.

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

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 403OpenAI shaped error.
  • 429OpenAI 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