Vaquill AI · Schema

MatterSummary

One generation of a matter summary, and its content once it has one.

LegalStatutesRegulationsLegal ResearchLawComplianceLegal TechGovernment DataMCPIndiaContracts

Properties

Name Type Description
id string `sum_` identifier. The same id the operation's resource carries, and the only id this API publishes for a summary.
matterId string The `mat_` matter this summary covers.
status object The generation's status, in the same five values every operation uses.
altitude object How much detail was synthesized. `executive` or `detailed`; read it as an open string, because the column carries no constraint. Null on the one row shape where it is genuinely unknown: `matter_summar
title object The title the synthesizer gave the matter. Null until it runs.
matterType object What the classifier decided the matter is.
isStale boolean True when the matter's documents have changed since this summary was built. Computed per request, never stored. A summary can also refresh ITSELF: a document change schedules a debounced regeneration
docCount integer Documents in the matter right now.
docCountUsed object Documents this generation read.
docCountExcluded object Documents this generation skipped.
warnings array What the pipeline wants you to know about this result, if anything.
createdAt string When the generation was requested.
completedAt object When the summary finished, read from the summary itself rather than from the job, which records no completion time.
sections object The rendered narrative. Present only on the by-id read; the list omits it rather than sending an empty array, so `null` here means 'not included in this response' and `[]` means 'nothing was written'.
View JSON Schema on GitHub

JSON Schema

vaquill-ai-matter-summary-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/vaquill-ai/json-schema/vaquill-ai-matter-summary-schema.json",
  "title": "MatterSummary",
  "description": "One generation of a matter summary, and its content once it has one.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/vaquill-ai-matter-summary-api-openapi.yml#/components/schemas/MatterSummary",
  "properties": {
    "id": {
      "type": "string",
      "title": "Id",
      "description": "`sum_` identifier. The same id the operation's resource carries, and the only id this API publishes for a summary."
    },
    "matterId": {
      "type": "string",
      "title": "Matterid",
      "description": "The `mat_` matter this summary covers."
    },
    "status": {
      "$ref": "#/$defs/OperationStatus",
      "description": "The generation's status, in the same five values every operation uses."
    },
    "altitude": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Altitude",
      "description": "How much detail was synthesized. `executive` or `detailed`; read it as an open string, because the column carries no constraint. Null on the one row shape where it is genuinely unknown: `matter_summary_jobs` does not record the altitude, so a job whose summary row is gone has nothing to report and the commoner answer would be an invention."
    },
    "title": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Title",
      "description": "The title the synthesizer gave the matter. Null until it runs."
    },
    "matterType": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Mattertype",
      "description": "What the classifier decided the matter is."
    },
    "isStale": {
      "type": "boolean",
      "title": "Isstale",
      "description": "True when the matter's documents have changed since this summary was built. Computed per request, never stored. A summary can also refresh ITSELF: a document change schedules a debounced regeneration for an altitude that already has a completed summary, so `isStale` can flip between two polls with no call from you."
    },
    "docCount": {
      "type": "integer",
      "title": "Doccount",
      "description": "Documents in the matter right now."
    },
    "docCountUsed": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Doccountused",
      "description": "Documents this generation read."
    },
    "docCountExcluded": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Doccountexcluded",
      "description": "Documents this generation skipped."
    },
    "warnings": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Warnings",
      "description": "What the pipeline wants you to know about this result, if anything."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "title": "Createdat",
      "description": "When the generation was requested."
    },
    "completedAt": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Completedat",
      "description": "When the summary finished, read from the summary itself rather than from the job, which records no completion time."
    },
    "sections": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/MatterSummarySection"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sections",
      "description": "The rendered narrative. Present only on the by-id read; the list omits it rather than sending an empty array, so `null` here means 'not included in this response' and `[]` means 'nothing was written'."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "id",
    "matterId",
    "status",
    "isStale",
    "docCount",
    "createdAt"
  ],
  "$defs": {
    "MatterSummarySection": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "description": "Stable within this summary."
        },
        "title": {
          "type": "string",
          "title": "Title",
          "description": "The section heading."
        },
        "position": {
          "type": "integer",
          "title": "Position",
          "description": "Reading order within the summary."
        },
        "claims": {
          "items": {
            "$ref": "#/$defs/SummaryClaim"
          },
          "type": "array",
          "title": "Claims",
          "description": "The section's claims."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "id",
        "title",
        "position"
      ],
      "title": "MatterSummarySection",
      "description": "One heading of the narrative."
    },
    "OperationStatus": {
      "type": "string",
      "enum": [
        "queued",
        "running",
        "succeeded",
        "failed",
        "cancelled"
      ],
      "title": "OperationStatus",
      "description": "The public five. There is no sixth, and there are no synonyms.\n\nInternal vocabularies spell terminal success `completed`, `ready`,\n`extracted`, `succeeded` and `fresh`; terminal failure `failed` and `error`;\nqueued `pending`, `queued` and `draft`. All of that is collapsed here by\n`app.workspace_api.adapters.status_map`, which refuses to guess."
    },
    "SummaryCitation": {
      "properties": {
        "label": {
          "type": "integer",
          "title": "Label",
          "description": "The bracketed marker this citation carries within its section, numbered from 1 per section. Two sections both start at [1]."
        },
        "documentId": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Documentid",
          "description": "The `doc_` document this passage came from."
        },
        "documentName": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Documentname",
          "description": "The document's filename when the summary was generated."
        },
        "quote": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Quote",
          "description": "The verbatim passage. Locate this string in the document's text to resolve the citation; there is no offset to trust."
        },
        "pageStart": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "title": "Pagestart",
          "description": "First page the quote appears on."
        },
        "pageEnd": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "title": "Pageend",
          "description": "Last page the quote appears on."
        },
        "sourceAvailable": {
          "type": "boolean",
          "title": "Sourceavailable",
          "description": "False when the cited document has since been removed from the workspace. The quote is a snapshot and stays accurate; there is simply nothing left to open."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "label",
        "sourceAvailable"
      ],
      "title": "SummaryCitation",
      "description": "One passage behind a claim, snapshotted when the summary was generated."
    },
    "SummaryClaim": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "description": "Stable within this summary."
        },
        "text": {
          "type": "string",
          "title": "Text",
          "description": "The claim, as one sentence."
        },
        "position": {
          "type": "integer",
          "title": "Position",
          "description": "Reading order within the section."
        },
        "claimType": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Claimtype",
          "description": "What kind of assertion this is, for example `general` or `event`. Publisher-controlled and open: read it, do not switch on a closed list."
        },
        "eventDate": {
          "anyOf": [
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "null"
            }
          ],
          "title": "Eventdate",
          "description": "The date the claim is about, when it names one."
        },
        "confidence": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Confidence",
          "description": "0 to 1."
        },
        "citations": {
          "items": {
            "$ref": "#/$defs/SummaryCitation"
          },
          "type": "array",
          "title": "Citations",
          "description": "Every passage behind this claim."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "id",
        "text",
        "position"
      ],
      "title": "SummaryClaim",
      "description": "One assertion inside a section, with the passages that support it."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vaquill-ai-matter-summary"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.