ErrorEnvelope

Every non-2xx response on this API uses this shape. Some codes add well-known extra keys alongside code/message/request_id — payment_required carries required, available and shortfall; insufficient_scope carries required_scope; unsupported-upload 422 carries supported_formats.

  • error
    Type: object · ErrorDetail
    required
    • code
      Type: string · Code
      required

      Stable error code. Match on this, not on the message. Codes are never renamed without a major version bump.

    • message
      Type: string · Message
      required

      Human-readable description of the error.

    • request_id
      Type: string · Request Id
      required

      Identifier for this request; quote it in support requests. Also returned as the X-Request-ID header.

    • available
      nullable

      Credits currently available. Present on payment_required.

      • Type: integer · Available

        Credits currently available. Present on payment_required.

    • field_errors
      Type: array object[] | null · Field Errorsnullable

      Present on validation failures (validation_failed); one entry per rejected field.

      One rejected request field.

    • required
      nullable

      Credits required to proceed. Present on payment_required.

      • Type: integer · Required

        Credits required to proceed. Present on payment_required.

    • required_scope
      Type: string · Required Scopenullable

      Scope the key is missing. Present on insufficient_scope.

    • shortfall
      nullable

      Credits still needed. Present on payment_required.

      • Type: integer · Shortfall

        Credits still needed. Present on payment_required.

    • supported_formats
      Type: array string[] | null · Supported Formatsnullable

      Present on unsupported upload-type 422 responses: the full list of accepted file extensions (e.g. ".docx", ".xliff").