Error response model

All models · Download OpenAPI

Nullable fields represent unknown values; they do not imply zero cost or a completed action.

Field	Type	Required	Details
error	object	Yes
error.code	string	If parent supplied
error.message	string	If parent supplied
error.details	any	No
requestId	string	Yes

Full JSON schema

{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "details": {}
      },
      "required": [
        "code",
        "message"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "requestId"
  ]
}