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

Files in a matter: their metadata, their ingested text, and the original bytes. A document is only usable by retrieval, drafting and review once its status is `succeeded`.

Vaquill AI Documents 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 Documents. 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 7 operations across 5 paths, and defines 10 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.

7 operations 5 paths 10 schemas 1 DELETE5 GET1 PATCH

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 Documents 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 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 5 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Documents 7

Files in a matter: their metadata, their ingested text, and the original bytes. A document is only usable by retrieval, drafting and review once its status is succeeded.

GET
/v1/matters/{matterId}/documents
List documents in a matter
documents.list 4 params → 200422401403404429500503
GET
/v1/matters/{matterId}/documents/{documentId}
Get a document
documents.get 2 params → 200422401403404429500503
DELETE
/v1/matters/{matterId}/documents/{documentId}
Delete a document
documents.delete 2 params → 204422401403404429500503
PATCH
/v1/matters/{matterId}/documents/{documentId}
Move a document between folders
documents.update 2 params body → 200422401403404429500503
GET
/v1/matters/{matterId}/documents/{documentId}/text
Get a document's extracted text
documents.text 2 params → 200422401403404429500503
GET
/v1/matters/{matterId}/documents/{documentId}/download
Download a document's original file
documents.download 2 params → 200422401403404429500503
GET
/v1/matters/{matterId}/documents/{documentId}/summary
Get a document's summary
documents.summary 2 params → 200422401403404429500503

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Document (14 properties), DocumentSummary (8 properties), ValidationProblem (7 properties), Problem (6 properties). Each schema is shown below with its type and property counts.

SummarySection
object
One heading of the summary. content is loose on purpose. documentsummaries.sections is JSONB written by a service this API does not own, and the shape has chan…
2 properties
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
DocumentSummary
object
What was persisted the last time this document was summarized.
8 properties 5 required
Page_Document_
object
2 properties 2 required
DocumentText
object
The reassembled text of a document. Reassembled from the ingested chunks rather than re-extracted from the original, so what a customer reads here is exactly w…
4 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…
Document
object
One file in a matter, and how far its ingestion got. status is the FIVE-value public vocabulary, not the four-label documentstatus Postgres enum. A document's…
14 properties 5 required
DocumentUpdateRequest
object
Move a document between folders. That is the whole of it. The web app's PATCH /documents/{id} also accepts filename, matterId and metadata, and none of the thr…
1 property
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-documents-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 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 Documents 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.