AutoGenerateSchemaRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/docupanda/json-schema/docupanda-auto-generate-schema-request-schema.json",
  "title": "AutoGenerateSchemaRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/docupanda-schema-api-openapi.yml#/components/schemas/AutoGenerateSchemaRequest",
  "properties": {
    "schemaName": {
      "type": "string",
      "title": "Schema Name",
      "description": "Name of the schema to be defined. For example rental contracts"
    },
    "documentIds": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Document IDs",
      "description": "List of document IDs to use for schema generation."
    },
    "dataset": {
      "type": "string",
      "title": "Dataset",
      "description": "The dataset to which the documents belong."
    },
    "instructions": {
      "type": "string",
      "title": "Create Instructions",
      "description": "Instructions on how to create the schema."
    },
    "guidelines": {
      "type": "string",
      "title": "Apply Guidelines",
      "description": "Guidelines to apply to the schema to documents when standardizing."
    },
    "standardizeUsingSchema": {
      "type": "boolean",
      "title": "Standardize Using Schema",
      "description": "Whether to standardize the input documents using the newly created schema after generation.Note that standardizing documents costs credits just as if you had called the `/standardize` endpoint directly",
      "default": true
    },
    "standardizationMode": {
      "$ref": "#/$defs/StdMode",
      "title": "Standardization Mode",
      "description": "*Advanced Feature*\nMode of standardization to run, if standardizing using the schema.",
      "default": "default"
    },
    "schemaVersion": {
      "$ref": "#/$defs/AutogenSchemaVersion",
      "title": "Schema Version",
      "description": "*Advanced Feature*\nVersion of the schema generation behavior. Supported values: 1.0, 1.1, 1.2.",
      "default": 1.1
    }
  },
  "type": "object",
  "$defs": {
    "AutogenSchemaVersion": {
      "type": "number",
      "enum": [
        1,
        1.1,
        1.2
      ],
      "title": "AutogenSchemaVersion"
    },
    "StdMode": {
      "type": "string",
      "enum": [
        "default",
        "sectionBased",
        "spatial"
      ],
      "title": "StdMode"
    }
  }
}