ClassifyBatchRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/docupanda/json-schema/docupanda-classify-batch-request-schema.json",
  "title": "ClassifyBatchRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/docupanda-classification-api-openapi.yml#/components/schemas/ClassifyBatchRequest",
  "properties": {
    "documentIds": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Document IDs",
      "description": "List of document IDs to classify"
    },
    "classIds": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Class IDs",
      "description": "List of class IDs to use for classification"
    },
    "multiClass": {
      "type": "boolean",
      "title": "Multi-Class",
      "description": "Whether to allow multiple classifications per document",
      "default": false
    },
    "includeUnknown": {
      "type": "boolean",
      "title": "Include Unknown",
      "description": "Whether to include the 'unknown' class in the classification (only relevant if multiClass is false)",
      "default": true
    },
    "instructions": {
      "type": "string",
      "title": "Instructions",
      "description": "Instructions for the AI on how to classify the documents"
    },
    "useMetadata": {
      "type": "boolean",
      "title": "Use Metadata",
      "description": "Whether to show each document's own metadata to the AI as additional context for its classification.",
      "default": false
    },
    "displayMode": {
      "$ref": "#/$defs/DisplayMode",
      "title": "Display Mode",
      "description": "*Advanced Feature*\nMode of display to run. The options are:\n`auto`: AI decides how to display the document (default)\n`spatial`: Display text spatially, as it appears in the document\n`sections`: Display text from top to bottom as sections, with tables appearing as markdown\n`image`: Display as an image.",
      "default": "auto"
    },
    "classifyVersion": {
      "$ref": "#/$defs/ClassifyVersion",
      "title": "Classify Version",
      "description": "Version of the classify behavior. Supported values: 1.0, 1.1.",
      "default": 1.1
    }
  },
  "type": "object",
  "required": [
    "documentIds"
  ],
  "$defs": {
    "ClassifyVersion": {
      "type": "number",
      "enum": [
        1,
        1.1
      ],
      "title": "ClassifyVersion"
    },
    "DisplayMode": {
      "type": "string",
      "enum": [
        "auto",
        "spatial",
        "sections",
        "image"
      ],
      "title": "DisplayMode"
    }
  }
}