TurnError

The settled turn-failure object: {kind, message, retryable}.

Fields and variants

• kind
• message
• quota
• requestDenied
• retryable

Source

schema/msp/experimental/msp.schema.json#/types/TurnError

{
  "description": "The settled turn-failure object: `{kind, message,\nretryable}`.",
  "properties": {
    "kind": {
      "$ref": "#/$defs/TurnErrorKind",
      "description": "The failure class (open camelCase enum grounded in the runtime's\nterminal failure classification)."
    },
    "message": {
      "description": "Human-readable failure text.",
      "type": "string"
    },
    "quota": {
      "$ref": "#/$defs/QuotaDetail",
      "description": "Typed quota-exhaustion detail (ADR 50047 D2/D3): present iff the\nstopping failure was the quota class. Clients branch on presence,\nnever by parsing `message`."
    },
    "requestDenied": {
      "description": "`true` when the provider refused this request. Present only on the\nlive `turn/completed`: replayed, snapshot-served and `workflow/resume`\nterminals omit it, so absence does not mean the request was not\ndenied. Never `false`. (ADR 39289 D2/D3)",
      "type": "boolean"
    },
    "retryable": {
      "description": "The server's judgment that resubmitting the same input may succeed.",
      "type": "boolean"
    }
  },
  "required": [
    "kind",
    "message",
    "retryable"
  ],
  "type": "object"
}