Vaquill AI · Schema

PlaybookExtractionCreateRequest

The contract to read positions out of. Exactly one source. `documentId` or `contractText`, never both and never neither. Text is accepted for the same reason `reviews.create` accepts it: the caller usually has the contract in hand, and requiring an upload first would make the cheapest integration a four-call dance. A `documentId` is the better choice when the file is a DOCX whose structure matters, and it is REQUIRED for tracked-changes extraction.

LegalStatutesRegulationsLegal ResearchLawComplianceLegal TechGovernment DataMCPIndiaContracts

Properties

Name Type Description
documentId object `doc_` identifier of a document in this organization to read. Mutually exclusive with `contractText`.
contractText object The contract as plain text. Mutually exclusive with `documentId`. Use it when you already hold the text and do not need the file kept.
contractType object Pin the contract type instead of detecting it. Omit to have it detected from the opening of the document, which costs nothing extra: it runs concurrently with the extraction.
useTrackedChanges boolean Read the file's Word revision marks and extract what a reviewer pushed FROM and TO, rather than the final-state positions. Requires a `documentId` whose filename ends in `.docx`: revision marks exist
View JSON Schema on GitHub

JSON Schema

vaquill-ai-playbook-extraction-create-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/vaquill-ai/json-schema/vaquill-ai-playbook-extraction-create-request-schema.json",
  "title": "PlaybookExtractionCreateRequest",
  "description": "The contract to read positions out of. Exactly one source.\n\n`documentId` or `contractText`, never both and never neither. Text is\naccepted for the same reason `reviews.create` accepts it: the caller usually\nhas the contract in hand, and requiring an upload first would make the\ncheapest integration a four-call dance. A `documentId` is the better choice\nwhen the file is a DOCX whose structure matters, and it is REQUIRED for\ntracked-changes extraction.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/vaquill-ai-playbooks-api-openapi.yml#/components/schemas/PlaybookExtractionCreateRequest",
  "properties": {
    "documentId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Documentid",
      "description": "`doc_` identifier of a document in this organization to read. Mutually exclusive with `contractText`."
    },
    "contractText": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 400000
        },
        {
          "type": "null"
        }
      ],
      "title": "Contracttext",
      "description": "The contract as plain text. Mutually exclusive with `documentId`. Use it when you already hold the text and do not need the file kept."
    },
    "contractType": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 64
        },
        {
          "type": "null"
        }
      ],
      "title": "Contracttype",
      "description": "Pin the contract type instead of detecting it. Omit to have it detected from the opening of the document, which costs nothing extra: it runs concurrently with the extraction."
    },
    "useTrackedChanges": {
      "type": "boolean",
      "title": "Usetrackedchanges",
      "description": "Read the file's Word revision marks and extract what a reviewer pushed FROM and TO, rather than the final-state positions. Requires a `documentId` whose filename ends in `.docx`: revision marks exist only in a DOCX.",
      "default": false
    }
  },
  "additionalProperties": false,
  "type": "object"
}

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-playbook-extraction-create-request"
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.