PostInstancesInstanceidReadRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/xmemory/main/json-schema/xmemory-post-instances-instanceid-read-request-schema.json",
  "title": "PostInstancesInstanceidReadRequest",
  "x-generated": "2026-10-19",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/xmemory-openapi-generated.yml#/components/schemas/PostInstancesInstanceidReadRequest",
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Natural‑language question."
    },
    "mode": {
      "type": "string",
      "description": "\"single-answer\" (default), \"xresponse\", or \"raw-tables\"."
    },
    "scope": {
      "type": "object",
      "description": "Restrict the read to specific objects."
    },
    "return_sql": {
      "type": "boolean",
      "description": "Include the executed SQL in the response."
    },
    "include_related_types": {
      "type": "string",
      "description": "\"types\" adds related_types to the response."
    },
    "related_types_depth": {
      "type": "integer",
      "description": "Depth for related types when include_related_types is \"types\"."
    },
    "skip_suggestion_capture": {
      "type": "boolean",
      "description": "Skip recording read‑gap signals."
    },
    "trace_id": {
      "type": "string",
      "description": "Caller‑supplied ID echoed back."
    },
    "session_id": {
      "type": "string",
      "description": "Session ID for tracing."
    }
  },
  "required": [
    "query"
  ]
}