Away 10:38 PM

1 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

ErrorResponse — openapi

This is the base class for all custom Exceptions that are thrown in this API.

Properties

NameTypeRequiredDescription
errorCodefalseThe ErrorCode for the exception.
errorMessagestringfalseThe human readable error message.
fieldstringfalseThe relevant field that caused the error.
hintstringfalseA hint as to what caused the error, if applicable.

Complete Schema

{
  "type": "object",
  "properties": {
    "errorCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ErrorCode"
        }
      ],
      "description": "The ErrorCode for the exception."
    },
    "errorMessage": {
      "type": "string",
      "description": "The human readable error message.",
      "nullable": true
    },
    "field": {
      "type": "string",
      "description": "The relevant field that caused the error.",
      "nullable": true
    },
    "hint": {
      "type": "string",
      "description": "A hint as to what caused the error, if applicable.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "This is the base class for all custom Exceptions that are thrown in this API."
}