Share feedback
Answers are generated based on the documentation.
Product manualDownload OpenAPI specificationMarkdown

Schema

error

Type: object

Error details vary by endpoint. The message describes the failure; errinfo can contain additional context.
detail

Type: string

All schema constraints and annotations
{
  "type": "string"
}
errinfo

Type: object | null

Additional error context, when available.
All schema constraints and annotations
{
  "additionalProperties": true,
  "description": "Additional error context, when available.",
  "type": [
    "object",
    "null"
  ]
}
message

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "Error details vary by endpoint. The message describes the failure; errinfo can contain additional context.",
  "properties": {
    "detail": {
      "type": "string"
    },
    "errinfo": {
      "additionalProperties": true,
      "description": "Additional error context, when available.",
      "type": [
        "object",
        "null"
      ]
    },
    "message": {
      "type": "string"
    }
  },
  "type": "object"
}