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 Matrices API

Spreadsheet-style extraction across many documents: rows are documents, columns are questions, cells are answers with verified citations. Building a grid is free; running it is what costs.

Vaquill AI Matrices 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 Matrices. 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 16 operations across 12 paths, and defines 28 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.

16 operations 12 paths 28 schemas 3 DELETE3 GET3 PATCH6 POST1 PUT

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 Matrices 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 16

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

Matrices 16

Spreadsheet-style extraction across many documents: rows are documents, columns are questions, cells are answers with verified citations. Building a grid is free; running it is wh…

POST
/v1/matters/{matterId}/matrices
Create a matrix
matrices.create 1 param body → 201422401403404429500503
GET
/v1/matters/{matterId}/matrices
List a matter's matrices
matrices.list 3 params → 200422401403404429500503
GET
/v1/matters/{matterId}/matrices/{matrixId}
Get a matrix
matrices.get 2 params → 200422401403404429500503
DELETE
/v1/matters/{matterId}/matrices/{matrixId}
Delete a matrix
matrices.delete 2 params → 204422401403404429500503
PATCH
/v1/matters/{matterId}/matrices/{matrixId}
Update a matrix
matrices.update 2 params body → 200422401403404429500503
POST
/v1/matters/{matterId}/matrices/{matrixId}/runs
Run a matrix
matrices.run 3 params body → 202422401403404429500503
GET
/v1/matters/{matterId}/matrices/{matrixId}/cells
List matrix cells
matrices.cells 4 params → 200422401403404429500503
POST
/v1/matters/{matterId}/matrices/{matrixId}/exports
Export a matrix as CSV or XLSX
matrices.export 2 params body → 200422401403404429500503
POST
/v1/matters/{matterId}/matrices/{matrixId}/rows
Add documents as matrix rows
matrices.addRows 2 params body → 201422401403404429500503
DELETE
/v1/matters/{matterId}/matrices/{matrixId}/rows/{rowId}
Delete a matrix row
matrices.deleteRow 3 params → 204422401403404429500503
POST
/v1/matters/{matterId}/matrices/{matrixId}/columns
Add questions as matrix columns
matrices.addColumns 2 params body → 201422401403404429500503
PUT
/v1/matters/{matterId}/matrices/{matrixId}/columns/order
Reorder matrix columns
matrices.reorderColumns 2 params body → 200422401403404429500503
PATCH
/v1/matters/{matterId}/matrices/{matrixId}/columns/{columnId}
Update a matrix column
matrices.updateColumn 3 params body → 200422401403404429500503
DELETE
/v1/matters/{matterId}/matrices/{matrixId}/columns/{columnId}
Delete a matrix column
matrices.deleteColumn 3 params → 204422401403404429500503
PATCH
/v1/matters/{matterId}/matrices/{matrixId}/cells/{cellId}
Write or review a matrix cell answer
matrices.updateCell 3 params body → 200422401403404429500503
POST
/v1/matters/{matterId}/matrices/{matrixId}/cells/{cellId}/verifications
Verify that a cell's citations support its answer
matrices.verifyCell 3 params → 200422401403404429500503

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Matrix (12 properties), MatrixColumn (10 properties), Operation (10 properties), MatrixColumnPatch (8 properties). Each schema is shown below with its type and property counts.

MatrixColumnSpec
object
One question asked of every document in the matrix. Conditional columns (dependsOnColumnId, gateExpression, injectUpstream) are not published HERE, and the rea…
5 properties 2 required
MatrixExport
object
A rendered grid, returned as bytes rather than as a signed URL. The second artifact on this API that does, after a draft export, and for the same reason. Every…
4 properties 4 required
MatrixRunRequest
object
Start extraction. An empty body runs every cell that has not answered yet. force re-runs cells that already have an answer, which is the only way to pick up an…
1 property
MatrixColumnPatch
object
Change one column, including whether it is conditional on another. Changing question, columnType or options BLANKS every cell in this column. MatrixService.upd…
8 properties
MatrixRowSpec
object
Documents to add to the grid, one row each. Each id must be in the matter named in the path and must have finished ingesting, exactly as on the create: retriev…
1 property 1 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
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
MatrixCreateRequest
object
Build a grid. Nothing is extracted until matrices.run.
4 properties 1 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
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…
ColumnOrderRequest
object
The complete left-to-right order of the grid's columns. Every column in the matrix, exactly once. A subset is refused with a 422 rather than applied, because M…
1 property 1 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 properties 2 required
MatrixColumnsRequest
object
Questions to add to the grid, one column each. Every added column backfills a pending cell against every existing row, so adding one column to a forty-row grid…
1 property 1 required
MatrixSummary
object
One row of matrices.list. The header only, with no axes and no counts. cellCount, pendingCellCount and errorCellCount are deliberately absent, and so are rows…
7 properties 6 required
MatrixCellPatch
object
Write a human answer into a cell, or record a review decision on it. Writing answer promotes the cell to an edited state, and an edited, approved or rejected c…
2 properties
MatrixColumn
object
One column of the grid, as stored.
10 properties 5 required
MatrixCell
object
One answer. answer is None on a succeeded cell means "not in this document", which is a finding rather than a failure.
8 properties 4 required
MatrixCitation
object
Where in the document the answer came from. quote is verified to be a literal substring of the cited passage before the cell is persisted, and citations that f…
3 properties 1 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 properties 2 required
Page_MatrixCell_
object
2 properties 2 required
MatrixExportRequest
object
Ask for the finished grid rendered to a file.
2 properties 1 required
MatrixUpdateRequest
object
Rename a matrix, or change what it says it is for. title and description, and nothing else. The internal MatrixUpdateRequest also carries status, metadata, fol…
2 properties
Page_MatrixSummary_
object
2 properties 2 required
MatrixRow
object
One document in the grid.
4 properties 3 required
CellVerification
object
A second opinion on one answer, from a fresh model call. The cell's own citations were already checked to be literal substrings of the passages they cite befor…
4 properties 4 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 properties 3 required
Matrix
object
The grid header plus its axes. Cells are a separate, paged read. Rows and columns are inlined because they are bounded and because a cell is unreadable without…
12 properties 6 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-matrices-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 Comparisons 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
Where this information came from

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