How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vaquill AI Comparisons API

Diffing two documents in a matter into structural changes, with a substantive-versus-cosmetic judgment and a downloadable redline.

Vaquill AI Comparisons 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 Comparisons. 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 6 operations across 4 paths, and defines 17 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.

6 operations 4 paths 17 schemas 1 DELETE3 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 Comparisons 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 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Comparisons 6

Diffing two documents in a matter into structural changes, with a substantive-versus-cosmetic judgment and a downloadable redline.

POST
/v1/matters/{matterId}/comparisons
Compare two documents
comparisons.create 2 params body → 202422401403404429500503
GET
/v1/matters/{matterId}/comparisons
List comparisons in a matter
comparisons.list 3 params → 200422401403404429500503
GET
/v1/matters/{matterId}/comparisons/{comparisonId}
Get a comparison
comparisons.get 2 params → 200422401403404429500503
DELETE
/v1/matters/{matterId}/comparisons/{comparisonId}
Delete a comparison
comparisons.delete 2 params → 204422401403404429500503
GET
/v1/matters/{matterId}/comparisons/{comparisonId}/hunks
List the changes in a comparison
comparisons.hunks 4 params → 200422401403404429500503
POST
/v1/matters/{matterId}/comparisons/{comparisonId}/exports
Export a comparison
comparisons.export 2 params body → 201422401403404429500503

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are ComparisonHunk (15 properties), Comparison (13 properties), Operation (10 properties), ComparisonSettings (9 properties). Each schema is shown below with its type and property counts.

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 properties 2 required
ComparisonSettings
object
How the diff engine treats the two inputs. A WorkspaceRequest even though it is also read back, so extra="forbid" refuses an unknown knob on the way in rather…
9 properties
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 properties 2 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 properties 4 required
ComparisonExportRequest
object
Ask for a pointer to a rendered redline the worker already produced.
1 property 1 required
Page_ComparisonHunk_
object
2 properties 2 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 properties 6 required
Page_Comparison_
object
2 properties 2 required
ComparisonSource
object
One side of a comparison, as it was resolved at launch. Denormalized on purpose and read back from the stored row rather than from the document: it records wha…
5 properties 5 required
ComparisonCreateRequest
object
Start a comparison between two documents already in the matter. Both sides are matter documents. The internal API also accepts drafts, draft versions and loose…
4 properties 3 required
Operation
object
One long-running operation, whatever kind of work it is. Readable for OPERATIONRETENTIONDAYS after creation, per AIP-151.
10 properties 4 required
Comparison
object
One comparison. status is the public five, never the stored spelling.
13 properties 11 required
ComparisonExport
object
A short-lived pointer to the rendered comparison. A URL rather than the bytes: the file is already in object storage, and proxying it would put a customer's la…
3 properties 3 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…
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 properties 3 required
ComparisonHunk
object
One structural change, in terms that survive outside the viewer.
15 properties 4 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 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vaquill-ai-comparisons-api-openapi.yml Raw ↑

Other APIs Vaquill AI publishes across the network.

Vaquill AI Board Watches API
Vaquill AI Chronology API
Vaquill AI Clients API
Vaquill AI Compliance API
Vaquill AI Credits API
Vaquill AI Documents API
Vaquill AI Drafting API
Vaquill AI Facts API
Vaquill AI Folders API
Vaquill AI India Credits API
Vaquill AI India Pricing API
Vaquill AI Indian Acts and Legislation API
Where this information came from

This is an independent, third-party profile of Vaquill AI Comparisons 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.