InspectRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/aard-ai/json-schema/aard-ai-inspect-request-schema.json",
  "title": "InspectRequest",
  "description": "Request body for POST /v1/inspect: one flat JSON object of tool arguments. Unknown names are rejected with 400 invalid_request, and the `detail` then lists every accepted name.",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aard-ai-openapi.json#/components/schemas/InspectRequest",
  "type": "object",
  "properties": {
    "agency_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "\\S",
      "description": "SDMX agency code, e.g. \"ABS\", \"ESTAT\", \"OECD\". Dataflow identifiers are agency-scoped, so both are required."
    },
    "dataflow_id": {
      "type": "string",
      "minLength": 1,
      "pattern": "\\S",
      "description": "SDMX dataflow identifier, e.g. \"ERP_Q\" or \"DS-018995\" (not a dataset_id)."
    },
    "sample": {
      "type": "integer",
      "description": "Maximum codes to show per dimension. Clamped to the origin's output budget, not refused.",
      "default": 10
    }
  },
  "additionalProperties": false,
  "required": [
    "agency_id",
    "dataflow_id"
  ]
}