Reviewing one contract against a playbook: clause analysis, redlines, flags, liability exposure and a reported sign-off gate. Export applies the redlines as native Word tracked changes.
Vaquill AI Reviews API is one of 26 APIs that Vaquill AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 18 JSON Schema definitions.
Tagged areas include Reviews. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a changelog, and 18 JSON Schemas.
This API exposes
5 operations
across 3 paths,
and defines 26 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.vaquill.ai/workspace, /workspace.
5 operations3 paths26 schemas1 DELETE2 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.vaquill.ai/api/v1
Authentication
HTTP Bearer
Resource Areas
1
Authentication & Security 1
Vaquill AI Reviews API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (vq_ws_*) (WorkspaceAuth).
By default, every request must be authenticated.
WorkspaceAuth — Workspace credential issued from the automation console at /automation. Send it as Authorization: Bearer vqws.... This is NOT a Data API key: a vqkey credentia…
Paths & Operations 5
Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Reviews 5
Reviewing one contract against a playbook: clause analysis, redlines, flags, liability exposure and a reported sign-off gate. Export applies the redlines as native Word tracked ch…
The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Review (23 properties), ReviewLiabilityExposure (15 properties), ReviewCreateRequest (14 properties), ReviewRedline (11 properties). Each schema is shown below with its type and property counts.
ReviewCounterpartyMatch
object
A known counterparty paper was recognised in the contract text. Published so a caller knows the findings include counterparty-specific redlines layered on top…
5 properties4 required
ReviewApprovalGate
object
Whether a human has to sign this off before it goes to the counterparty. Reported, never enforced. The gate is computed deterministically from the playbook's o…
5 properties
ReviewLiabilityExposure
object
How much the reviewer is on the hook for, in one panel. Every field is nullable and stays nullable. This is assembled defensively from LLM output about contrac…
15 properties1 required
ValidationProblem
object
A problem document for a schema rejection. errors lists the fields that were refused. The value you submitted is deliberately not echoed, so a validation failu…
7 properties6 required
Pagination
object
Where the caller is, and whether there is more. total is the count of rows matching the filter, not the count returned, so a caller can size a job before runni…
4 properties4 required
ReviewDeepMeta
object
What the deep verification pass did, present only when one ran. Absent on a standard review, which is the honest signal that no verification happened rather th…
5 properties3 required
ReviewNegotiationPriority
object
One tier of the negotiation plan: what to raise first, and what to trade.
3 properties3 required
Operation
object
One long-running operation, whatever kind of work it is. Readable for OPERATIONRETENTIONDAYS after creation, per AIP-151.
10 properties4 required
ReviewRedline
object
One proposed edit, ready to send to counterparty counsel.
11 properties4 required
OperationStatus
string
The public five. There is no sixth, and there are no synonyms. Internal vocabularies spell terminal success completed, ready, extracted, succeeded and fresh; t…
ReviewFlag
object
Something the reviewer noticed and deliberately did NOT redline. A wrong entity name, an odd schedule entry, a real ambiguity. These are not edits; they are th…
3 properties2 required
ReviewClause
object
One clause, as analyzed against the playbook position for its type.
10 properties4 required
OperationResource
object
What the operation produced, or is producing. url is a path on this API rather than an absolute URL, because the service is mounted today and gets its own host…
3 properties2 required
ReviewExport
object
A short-lived URL to the marked-up contract. The same shape as a comparison export, and for the same reason: the route declares a response model, and a DOCX is…
8 properties6 required
Review
object
One contract review: its findings, or its progress toward them.
23 properties4 required
ReviewDealContext
object
Deal attributes the playbook's conditional escalation rules evaluate. Everything is optional and stays optional. A rule referencing an attribute the caller did…
2 properties
ReviewCreateRequest
object
Start a review of one contract against one playbook. contractType and userSide are the internal enums by REFERENCE rather than by copy. They are the taxonomy t…
14 properties3 required
UserSide
string
Which side the reviewer represents. Kept in sync with the FE UserSide union + USERSIDELABELS (frontend/src/types/legal-tools.ts) by the drift-guard in app/test…
Page_Review_
object
2 properties2 required
ReviewExportRequest
object
Which of a review's redlines to apply, and how to mark them up. Omitting redlines applies EVERY redline the review produced, which is the common case for an in…
2 properties
AcceptedRedline
object
One edit to apply to the contract text in an export.
5 properties3 required
OperationError
object
Why a failed operation failed, in terms a customer can act on. code is stable and machine-readable. message is sanitized: the internal job tables store stack t…
2 properties2 required
ContractType
string
Contract types a playbook can encode negotiation positions for. A playbook is a set of clause-level negotiation positions, so this list covers contracts you ne…
ReviewApprovalReason
object
One clause driving the review-level sign-off gate.
4 properties1 required
OperationProgress
object
How far along, and in what units. The unit is not decoration. A workflow run stores only a percentage while a matrix run stores cell counts, so {done: 43, tota…
3 properties3 required
Problem
object
An RFC 9457 problem document. Branch on type, which is stable; title and detail are written for people and may be reworded. Some problems carry extra members (…
6 properties5 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Vaquill AI Reviews API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
