ApiError1

Structured API error envelope. May include docsUrl and nextAction to guide recovery.

  • error
    Type: string
    required

    Stable error code (matches ApiError.name on the server).

  • message
    Type: string
    required

    Human-readable error message.

  • docsUrl
    Type: stringFormat: uri

    Documentation URL for the failing surface.

  • fields
    Type: array object[]
    • field
      Type: string
      required
    • message
      Type: string
      required
  • nextAction
    Type: string

    One-sentence instruction describing how to recover from this error.

  • offendingField
    Type: string

    When the error is field-scoped, the request field that caused the failure.