Component schema

QueryError

object1 direct reference

Definition

Structured error information for query errors. Present alongside the error string when the error is related to the user's query (syntax, semantic, or execution errors). Not present for system-level errors (unauthorized access, unexpected failures).

stringrequired

Short error title in plain text (no markdown), e.g. Syntax error - Invalid LIMIT clause

stringrequired

Human-readable explanation of what went wrong and how to fix it. May contain markdown (inline code, bold, lists).

string

Validated and formatted corrected SQL query. Only present when an AI-suggested correction is available and passes validation.

Used by 1

These schemas and endpoints reference this type directly.

SchemaExecuteSqlResponse

json

OpenAPI source123456789101112131415161718192021
{
  "description": "Structured error information for query errors. Present alongside the error string when the error is related to the user's query (syntax, semantic, or execution errors). Not present for system-level errors (unauthorized access, unexpected failures).\n",
  "properties": {
    "title": {
      "description": "Short error title in plain text (no markdown), e.g. Syntax error - Invalid LIMIT clause",
      "type": "string"
    },
    "description": {
      "description": "Human-readable explanation of what went wrong and how to fix it. May contain markdown (inline code, bold, lists).",
      "type": "string"
    },
    "correctedQuery": {
      "description": "Validated and formatted corrected SQL query. Only present when an AI-suggested correction is available and passes validation.",
      "type": "string"
    }
  },
  "required": [
    "title",
    "description"
  ]
}