{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/vaquill-ai/json-schema/vaquill-ai-chronology-export-request-schema.json",
  "title": "ChronologyExportRequest",
  "description": "A POST, because the filters live in the body.\n\nThe export honours exactly the filters the list accepts, and it refuses\nrather than truncating: over the ceiling you get a 413 carrying `limit` and\n`requested` so you can narrow the date range. The web app's export silently\nstops at 50,000 events with no flag on the response, which hands a customer a\nfile they believe is complete.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/vaquill-ai-chronology-api-openapi.yml#/components/schemas/ChronologyExportRequest",
  "properties": {
    "format": {
      "type": "string",
      "enum": [
        "csv",
        "pdf",
        "docx"
      ],
      "title": "Format",
      "description": "`csv` for a spreadsheet, `pdf` or `docx` for a filed document."
    },
    "filters": {
      "$ref": "#/$defs/ChronologyFilters",
      "description": "Same fields as the list. Omit for the whole timeline."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "format"
  ],
  "$defs": {
    "ChronologyFilters": {
      "properties": {
        "dateFrom": {
          "anyOf": [
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "null"
            }
          ],
          "title": "Datefrom",
          "description": "Only events on or after this date."
        },
        "dateTo": {
          "anyOf": [
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "null"
            }
          ],
          "title": "Dateto",
          "description": "Only events on or before this date."
        },
        "eventTypes": {
          "anyOf": [
            {
              "items": {
                "type": "string",
                "enum": [
                  "signed",
                  "executed",
                  "filed",
                  "served",
                  "effective",
                  "expired",
                  "terminated",
                  "notice_sent",
                  "notice_received",
                  "payment",
                  "hearing",
                  "meeting",
                  "judgment",
                  "order",
                  "correspondence",
                  "amended",
                  "enacted",
                  "published",
                  "decided",
                  "incident",
                  "referenced",
                  "founded",
                  "incorporated",
                  "appointed",
                  "resigned",
                  "acquired",
                  "launched",
                  "awarded",
                  "approved",
                  "registered",
                  "commenced",
                  "completed",
                  "transferred",
                  "invested",
                  "dissolved",
                  "announced",
                  "renewed",
                  "other"
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Eventtypes",
          "description": "Only these event types. Omit for all of them."
        },
        "categories": {
          "anyOf": [
            {
              "items": {
                "type": "string",
                "enum": [
                  "contract_event",
                  "court_filing",
                  "correspondence",
                  "payment_financial",
                  "deadline_notice",
                  "meeting_hearing",
                  "legislative",
                  "case_law",
                  "historical",
                  "corporate",
                  "regulatory",
                  "employment",
                  "milestone",
                  "other"
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Categories",
          "description": "Only these swim lanes."
        },
        "significance": {
          "anyOf": [
            {
              "items": {
                "type": "string",
                "enum": [
                  "high",
                  "medium",
                  "low"
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Significance",
          "description": "Only these significance levels."
        },
        "documentId": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Documentid",
          "description": "Only events extracted from this `doc_` document."
        },
        "isAiExtracted": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "title": "Isaiextracted",
          "description": "True for extracted events only, false for hand-entered ones only."
        },
        "minConfidence": {
          "anyOf": [
            {
              "type": "number",
              "maximum": 1.0,
              "minimum": 0.0
            },
            {
              "type": "null"
            }
          ],
          "title": "Minconfidence",
          "description": "Only extracted events at or above this confidence. Note that a manual event has no confidence at all and is excluded by any value here."
        },
        "searchQuery": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 200
            },
            {
              "type": "null"
            }
          ],
          "title": "Searchquery",
          "description": "Substring match on title or description."
        },
        "party": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 200
            },
            {
              "type": "null"
            }
          ],
          "title": "Party",
          "description": "Only events naming this party exactly."
        },
        "primaryOnly": {
          "type": "boolean",
          "title": "Primaryonly",
          "description": "Collapse duplicate events to one per group. Events that are in no duplicate group are always kept.",
          "default": false
        }
      },
      "additionalProperties": false,
      "type": "object",
      "title": "ChronologyFilters",
      "description": "Which events to include.\n\nONE model, two call sites: the list takes it as a query model and the export\ntakes it as a field on its body. That is deliberate, and it is why the export\nis a POST. The web app's export accepts eleven filter parameters and honours\nevery one of them; two separately-declared filter sets is how one of them\nquietly stops being honoured on the export, which nobody notices until a\ncustomer files a chronology that includes events they excluded."
    }
  }
}