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

Multi-step analyses from a fixed catalogue. Read a definition to learn what documents and inputs it takes, launch a run inside a matter, then download the artifacts it produces.

Vaquill AI Workflows 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 Workflows. 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 5 paths, and defines 19 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 5 paths 19 schemas 1 DELETE4 GET1 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 Workflows 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 5 paths, the API surfaces 6 operations — 1 DELETE, 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Workflows 6

Multi-step analyses from a fixed catalogue. Read a definition to learn what documents and inputs it takes, launch a run inside a matter, then download the artifacts it produces.

GET
/v1/workflows
List available workflows
workflows.list 2 params → 200422401403429500503
POST
/v1/matters/{matterId}/workflows/{workflowId}/runs
Run a workflow
workflows.run 3 params body → 202422401403404429500503
GET
/v1/matters/{matterId}/workflow-runs/{runId}
Get a workflow run
workflowRuns.get 2 params → 200422401403404429500503
DELETE
/v1/matters/{matterId}/workflow-runs/{runId}
Delete a workflow run
workflowRuns.delete 2 params → 204422401403404429500503
GET
/v1/matters/{matterId}/workflow-runs/{runId}/artifact
Download a workflow artifact
workflowRuns.artifact 3 params → 200422401403404429500503
GET
/v1/matters/{matterId}/workflow-runs
List workflow runs in a matter
workflowRuns.list 3 params → 200422401403404429500503

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are WorkflowRun (12 properties), WorkflowDefinition (12 properties), Operation (10 properties), WorkflowInputField (7 properties). Each schema is shown below with its type and property counts.

WorkflowArtifactDownload
object
A short-lived pointer to one artifact's bytes.
3 properties 3 required
WorkflowDocumentSlot
object
What a definition will accept in one role, so a caller can validate first. Published because the alternative is a customer discovering the shape of a workflow…
6 properties 5 required
WorkflowDefinition
object
One catalogue entry. Only active definitions are listed. A retired one still resolves in code so old runs stay readable, but offering it would be offering some…
12 properties 6 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
Page_WorkflowRun_
object
2 properties 2 required
WorkflowInputField
object
One question the definition asks, and how it is answered.
7 properties 3 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
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…
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
Page_WorkflowDefinition_
object
2 properties 2 required
WorkflowRunRequest
object
Launch a run of one definition inside one matter. inputs is dict[str, Any] because each definition declares its own field set, which workflows.list publishes a…
3 properties
WorkflowArtifact
object
An artifact a finished run produced. No URL: fetching one is its own call. Separating the listing from the signing is what lets the download route re-check the…
4 properties 3 required
WorkflowArtifactSpec
object
A deliverable this workflow produces, named before it exists. key is what workflowRuns.artifact takes, so a customer can wire up the download before running an…
4 properties 3 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
WorkflowRun
object
One run. status is the public five, never the stored spelling. The internal vocabulary has eight values, five of which (preparing, extracting, synthesizing, re…
12 properties 8 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
WorkflowRunDocument
object
One document attached to a run, in a role the definition declares.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vaquill-ai-workflows-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 Workflows 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.