The organization's negotiating positions, per contract type, and the starter templates to build them from. A playbook is the input a contract review is measured against.
Vaquill AI Playbooks 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 Playbooks. 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
8 operations
across 6 paths,
and defines 20 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.
8 operations6 paths20 schemas4 GET3 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 Playbooks 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 8
Across 6 paths, the API surfaces 8 operations — 4 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Playbooks 8
The organization's negotiating positions, per contract type, and the starter templates to build them from. A playbook is the input a contract review is measured against.
The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are PlaybookPosition (11 properties), Operation (10 properties), PlaybookTemplate (10 properties), Playbook (9 properties). Each schema is shown below with its type and property counts.
PlaybookCreateRequest
object
Author a playbook from positions the caller supplies.
4 properties2 required
PlaybookFromTemplateRequest
object
Adopt one of our starter templates as an organization playbook. The result is an ordinary playbook, owned by the organization and editable. Nothing links it ba…
4 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
Operation
object
One long-running operation, whatever kind of work it is. Readable for OPERATIONRETENTIONDAYS after creation, per AIP-151.
10 properties4 required
Page_PlaybookTemplate_
object
2 properties2 required
Playbook
object
One organization playbook, with every position it holds. Positions are returned in full rather than summarized. A playbook is the input to a review, so a calle…
9 properties3 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…
PlaybookExtraction
object
What an extraction found, in the shape a playbook takes. A running extraction is a 200 with an EMPTY positions map and a truthful status, never a 404: a 404 wo…
8 properties3 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
EscalationCondition
object
A rule that RAISES a clause's required sign-off when it holds. This is what lets a playbook say "partner normally, but GC if the deal is over a million, or if…
5 properties2 required
PlaybookUpdateRequest
object
Replace a playbook's name, description and positions. A PUT, and it replaces at the MAP level: a clause type absent from positions is removed from the playbook…
3 properties1 required
PlaybookTemplate
object
A starter template. Ours, read-only, identical for every organization. positionCount rather than the positions themselves: the materialized positions of one te…
10 properties5 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
PlaybookExtractionCreateRequest
object
The contract to read positions out of. Exactly one source. documentId or contractText, never both and never neither. Text is accepted for the same reason revie…
4 properties
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…
Page_Playbook_
object
2 properties2 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
PlaybookPosition
object
The organization's negotiating position on one clause type. Both a request and a response shape, which is a deliberate exception to the "read models are looser…
11 properties2 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 Playbooks 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.
