Vaquill AI · Schema

Page[WorkflowRun]

LegalStatutesRegulationsLegal ResearchLawComplianceLegal TechGovernment DataMCPIndiaContracts

Properties

Name Type Description
data array The rows in this window, in the collection's default order.
pagination object Where this window sits in the full result set.
View JSON Schema on GitHub

JSON Schema

vaquill-ai-page-workflow-run-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/vaquill-ai/json-schema/vaquill-ai-page-workflow-run-schema.json",
  "title": "Page[WorkflowRun]",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/vaquill-ai-workflows-api-openapi.yml#/components/schemas/Page_WorkflowRun_",
  "properties": {
    "data": {
      "items": {
        "$ref": "#/$defs/WorkflowRun"
      },
      "type": "array",
      "title": "Data",
      "description": "The rows in this window, in the collection's default order."
    },
    "pagination": {
      "$ref": "#/$defs/Pagination",
      "description": "Where this window sits in the full result set."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "data",
    "pagination"
  ],
  "$defs": {
    "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."
    },
    "Pagination": {
      "properties": {
        "limit": {
          "type": "integer",
          "title": "Limit",
          "description": "The `limit` that was applied to this request."
        },
        "offset": {
          "type": "integer",
          "title": "Offset",
          "description": "The `offset` that was applied to this request."
        },
        "total": {
          "type": "integer",
          "title": "Total",
          "description": "Total rows matching the filter, not the number returned in `data`. Use it to size a job before running it."
        },
        "hasMore": {
          "type": "boolean",
          "title": "Hasmore",
          "description": "True when rows remain beyond this window. Derived from `offset + len(data) < total`, so a full final page correctly reports `false` rather than sending you after an empty page."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "limit",
        "offset",
        "total",
        "hasMore"
      ],
      "title": "Pagination",
      "description": "Where the caller is, and whether there is more.\n\n`total` is the count of rows matching the filter, not the count returned,\nso a caller can size a job before running it."
    },
    "WorkflowArtifact": {
      "properties": {
        "key": {
          "type": "string",
          "title": "Key",
          "description": "Slug identifying this artifact. Pass it to the artifact download route to get bytes."
        },
        "label": {
          "type": "string",
          "title": "Label",
          "description": "Human-readable name for the deliverable."
        },
        "contentType": {
          "type": "string",
          "title": "Contenttype",
          "description": "IANA media type of the produced file."
        },
        "sizeBytes": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "title": "Sizebytes",
          "description": "Size of the artifact in bytes, when known."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "key",
        "label",
        "contentType"
      ],
      "title": "WorkflowArtifact",
      "description": "An artifact a finished run produced. No URL: fetching one is its own call.\n\nSeparating the listing from the signing is what lets the download route\nre-check the installation at signing time, so a URL cannot be minted for an\ninstallation that was revoked between the two."
    },
    "WorkflowRun": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "description": "Public identifier, `wfr_` followed by 32 hex characters."
        },
        "matterId": {
          "type": "string",
          "title": "Matterid",
          "description": "`mat_` identifier of the matter this run belongs to."
        },
        "workflowId": {
          "type": "string",
          "title": "Workflowid",
          "description": "Identifier of the workflow definition that was run."
        },
        "title": {
          "type": "string",
          "title": "Title",
          "description": "Display title for the run."
        },
        "status": {
          "$ref": "#/$defs/OperationStatus",
          "description": "Run status, using the same five public values as an operation. The internal stage vocabulary (`preparing`, `extracting`, `synthesizing`, `rendering`) all reads as `running`."
        },
        "progressPercent": {
          "type": "integer",
          "title": "Progresspercent",
          "description": "How far along the run is, 0 to 100. This is what carries progress, since the stages all collapse to `running`."
        },
        "progressMessage": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Progressmessage",
          "description": "Short human-readable stage label, for example 'synthesizing findings'. Free text for a progress line only. Never branch on it; branch on `status`."
        },
        "artifacts": {
          "items": {
            "$ref": "#/$defs/WorkflowArtifact"
          },
          "type": "array",
          "title": "Artifacts",
          "description": "Deliverables produced so far. Listing is separate from downloading, so that a URL cannot be minted for an installation revoked between the two calls."
        },
        "startedAt": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ],
          "title": "Startedat",
          "description": "When the run began executing (RFC 3339)."
        },
        "completedAt": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ],
          "title": "Completedat",
          "description": "When the run reached a terminal status (RFC 3339)."
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "title": "Createdat",
          "description": "When the run was created (RFC 3339)."
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time",
          "title": "Updatedat",
          "description": "When the run was last updated (RFC 3339)."
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "id",
        "matterId",
        "workflowId",
        "title",
        "status",
        "progressPercent",
        "createdAt",
        "updatedAt"
      ],
      "title": "WorkflowRun",
      "description": "One run. `status` is the public five, never the stored spelling.\n\nThe internal vocabulary has eight values, five of which (`preparing`,\n`extracting`, `synthesizing`, `rendering`, plus `pending`) describe a stage\nrather than an outcome. Those read as `running`, and `progressPercent` is\nwhat carries how far along it is."
    }
  }
}

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-page-workflow-run"
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.