Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.utnor.com/llms.txt

Use this file to discover all available pages before exploring further.

Mistakes happen, and what matters is understanding what went wrong and what to do next. UTNOR returns client-side errors in a single, consistent JSON format across all tools, so failures are clear, predictable, and easy to handle.

Quick View (Canonical Template)

Use this template to understand the exact shape of the response. Values shown are placeholders only.
[
  {
    "tool": "TOOL_NAME",
    "errors": [
      {
        "name": "ERROR_NAME",
        "message": "Short reason for the error",
        "reference": "https://docs.utnor.com/tools/TOOL_NAME/errors/ERROR_NAME",
        "retriable": true,
        "recoverable": false
      }
    ],
    "timestamp": "YYYY-MM-DDTHH:mm:ssZ",
    "docs": "https://docs.utnor.com/",
    "signature": "utnor"
  }
]

Fields

All responses contain the fields below. Names and meanings are the same across all tools.

Top-Level Fields

FieldTypeNullableMeaning
toolstringNoTool that produced the error.
errorsarrayNoList of client-side errors.
timestampstringNoISO 8601 UTC timestamp when the request was received.
docsstringNoLink to UTNOR documentation.
signaturestringNoStatic identifier confirming UTNOR origin.

Error Object Fields

FieldTypeNullableMeaning
namestringNoStable error name.
messagestringNoShort explanation of the error.
referencestringYesDocumentation link for the error.
retriablebooleanNoRetry without changes is allowed.
recoverablebooleanNoInput or state can be fixed and retried.

Retry Behavior

Client behavior is determined by the combination of the following flags.
retriablerecoverableWhat to do
falsetrueFix input, then retry
truefalseRetry later
truetrueRetry or fix input
falsefalseDo not retry

  • The response is always an array with a single object.
  • Field names and meanings are stable across all tools.
  • This format is used only for client-side errors.