> ## Documentation Index > Fetch the complete documentation index at: https://vaquill.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Replace a template's body > Replace a template's body, re-detecting its variables. A PUT, not a PATCH: `contentMarkdown` is the whole body, so sending one clause replaces the template with that clause. Title and description are left alone when omitted. **This is lossy against a template imported from a `.docx`.** Word formatting the importer preserved cannot be expressed in markdown and is discarded. Duplicate the template first if you want to keep the original. ## OpenAPI ````yaml https://api.vaquill.ai/workspace/openapi/v1.json put /v1/templates/{templateId} openapi: 3.1.0 info: title: Vaquill Legal Workspace API description: >- Organization-scoped API for driving your legal workspace from your own backend: matters, documents, drafting, review, compare and matrices. **Authentication**: `Authorization: Bearer vq_ws_...`. Credentials are issued by an organization owner from the automation console at `/automation` and are shown once. The organization is resolved from the credential and can never be named in a request, so there is no `organizationId` field anywhere in this API and sending one is refused. This is NOT the Vaquill Data API. That one holds a `vq_key_` credential and serves the public legal corpus; the two share no credential, host or endpoint, and sending a `vq_key_` here is refused with an error naming the other product. ## Long-running work Anything that costs real work answers `202` with an **operation**. Poll `GET /v1/operations/{operationId}` until `status` is `succeeded`, `failed` or `cancelled`, honouring `Retry-After` between polls. There are no webhooks, so polling is the only completion signal. The five statuses are `queued`, `running`, `succeeded`, `failed`, `cancelled`, and there is no sixth: every capability reports through the same envelope. Send an `Idempotency-Key` on any launch. A retry with the same key and the same body returns the FIRST operation rather than starting a second billable job, which is what makes recovering from a timeout free. ## Identifiers Every public id is `_<32 lowercase hex>`, for example `mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6`. The prefix names the resource type. Ids are opaque: take them from responses rather than building them, and never pass a bare database uuid. ## Lists Every collection answers `{data, pagination}`, never a bare array. Page with `limit` and `offset`, and read `pagination.total` to size a job before running it. `pagination.hasMore` is the reliable signal that rows remain. ## Errors Errors are RFC 9457 problem documents (`application/problem+json`), including for a wrong path and a wrong method. Branch on `type`; it is the stable identifier and it resolves to a page describing the failure. `title` and `detail` are written for people and may be reworded at any time. Every response carries `X-Request-ID`, and every error repeats it as `requestId`: quote it when contacting support. A `404` is returned identically for a resource that does not exist, one belonging to another organization, and one outside your installation's matter allowlist. That is deliberate, so the status code cannot be used to discover which ids exist elsewhere. ## Rate limits Limits are per credential and are set by what an operation COSTS rather than by its HTTP method, so a `GET` that runs a retrieval is not a read. Each operation's tier is fixed; a `429` carries `Retry-After`. | Tier | Per minute | Per hour | Per day | |---|---|---|---| | `poll` | 120 | 3000 | 30000 | | `read` | 60 | 1200 | 15000 | | `write` | 30 | 600 | 5000 | | `launch` | 10 | 200 | 2000 | | `download` | 20 | 300 | 3000 | | `upload` | 5 | 100 | 500 | ## Scopes A credential carries an explicit scope set, chosen when it is issued. A call outside them is `403` with `insufficient-scope`, naming the scopes the operation needed. Read and run are separate throughout, so a credential can be allowed to read results without being allowed to spend money producing them. `chronology:read`, `chronology:write`, `clients:read`, `clients:write`, `compare:read`, `compare:run`, `compliance:read`, `compliance:run`, `credentials:rotate`, `documents:download`, `documents:read`, `documents:write`, `drafting:read`, `drafting:run`, `exports:create`, `exports:read`, `facts:read`, `facts:run`, `matrices:read`, `matrices:run`, `matrices:write`, `matters:read`, `matters:write`, `nda:read`, `nda:run`, `operations:read`, `playbooks:read`, `playbooks:run`, `playbooks:write`, `research:read`, `research:run`, `review:read`, `review:run`, `summaries:read`, `summaries:run`, `webhooks:read`, `webhooks:write`, `workflows:read`, `workflows:run`, `workflows:write` version: 1.0.0 servers: - url: https://api.vaquill.ai/workspace description: Vaquill Legal Workspace API (production) - url: /workspace description: Vaquill Legal Workspace API (relative to the mount) security: - WorkspaceAuth: [] tags: - name: Operations description: >- The one job envelope. Every long-running call answers `202` with an operation, and polling this resource is the only way to learn it finished: there are no webhooks. Five statuses, no synonyms. - name: Clients description: The people and companies matters are filed under. Synchronous CRUD. - name: Matters description: >- The unit of work everything else hangs off. A matter scopes documents, drafts, reviews, comparisons and matrices, and it is what a credential's access is checked against. - name: Folders description: >- Organization inside and across matters. The same folders the web app shows, so one created here appears in the customer's browser. - name: Documents description: >- 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`. - name: Uploads description: >- Getting files in. One presigned multipart flow at every size, with the bytes going straight to storage and never through this API. Initiate, PUT each part, then complete. - name: Research description: >- Asking legal questions and getting grounded, cited answers. This API does NOT stream: an ask answers `202` and you poll the operation, then read the answer off the message it points at. Conversation state is kept here, so you hold a chat id rather than replaying a transcript. Also covers the matter settings behind an answer, the skills you can ask through, and the standalone web-research tools. - name: Drafting description: >- Generating, revising and exporting draft documents. Bodies come out as sections and go in as markdown; the editor's own format is never on the wire. Rendered files come from the export route. - name: Playbooks description: >- 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. - name: Reviews description: >- Reviewing one contract against a playbook: clause analysis, redlines, flags, liability exposure and a reported sign-off gate. Export applies the redlines as native Word tracked changes. - name: Facts description: >- The cross-document fact ledger for a matter: what every document in it asserts, coalesced and cited back to its source passages. - name: Matter summary description: >- A citation-backed summary of everything filed to a matter, generated on demand and readable claim by claim. - name: Chronology description: >- The dated events across a matter's documents, as one timeline, with duplicate and date-conflict flags. - name: NDA triage description: >- Screening one inbound NDA against ten standard criteria and, where you name one, your own NDA playbook. Answers `green`, `yellow` or `red` with the reasoning per criterion, plus a report you can forward. - name: Compliance description: >- Checking one document against one regulation's requirement checklist: a verdict per requirement with the article it comes from, the gaps, and what to do about them. Only regulations with a real checklist behind them are accepted. - name: Comparisons description: >- Diffing two documents in a matter into structural changes, with a substantive-versus-cosmetic judgment and a downloadable redline. - name: Matrices description: >- 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. - name: Workflows description: >- 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. externalDocs: description: Getting started guide and error reference url: https://vaquill.ai/docs/workspace-api paths: /v1/templates/{templateId}: put: tags: - Drafting summary: Replace a template's body description: >- Replace a template's body, re-detecting its variables. A PUT, not a PATCH: `contentMarkdown` is the whole body, so sending one clause replaces the template with that clause. Title and description are left alone when omitted. **This is lossy against a template imported from a `.docx`.** Word formatting the importer preserved cannot be expressed in markdown and is discarded. Duplicate the template first if you want to keep the original. operationId: templates.update parameters: - name: templateId in: path required: true schema: type: string title: Templateid description: >- `tpl_` identifier of one of your uploaded draft templates. Take it from `GET /v1/templates`. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TemplateUpdateRequest' example: contentMarkdown: > # Mutual Non-Disclosure Agreement ## 1. Confidential Information Each party may disclose information that is confidential and proprietary to the other party. title: Mutual NDA description: >- Master services agreement with Acme for the 2026 platform rollout. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TemplateDetail' example: id: tpl_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 title: Master Services Agreement description: >- Master services agreement with Acme for the 2026 platform rollout. category: commercial sourceFilename: msa-acme-v3.docx createdAt: '2026-08-19T14:32:10Z' updatedAt: '2026-08-19T14:32:10Z' variables: - id: party_a_name name: Counterparty name label: Counterparty name kind: matrix hint: value defaultValue: value position: 0 sections: - heading: 8. Limitation of Liability level: 1 text: >- Neither party shall be liable for indirect or consequential damages. '401': description: >- The credential is missing, malformed, unknown, revoked or expired. `type` is `invalid-credential`, or `wrong-product-credential` when a `vq_key_` Data API key was sent to this API. headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 WWW-Authenticate: description: RFC 9110 authentication challenge. schema: type: string content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: >- The credential does not carry a scope this operation requires (`insufficient-scope`), or the organization's installation is suspended (`installation-inactive`). headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 WWW-Authenticate: description: RFC 9110 authentication challenge. schema: type: string content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: >- The resource does not exist, is not this organization's, or is outside this installation's matter allowlist. The three are deliberately indistinguishable, so the status code cannot be used to discover which ids exist in another organization. Each resource has its own `type`. headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '422': description: >- The request does not match the published schema. `errors` names each rejected field and why. The submitted value is never echoed back. headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 content: application/problem+json: schema: $ref: '#/components/schemas/ValidationProblem' '429': description: Too many requests for this credential's tier. Honour `Retry-After`. headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 Retry-After: description: Seconds to wait before retrying. schema: type: integer content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '500': description: >- An unexpected error on our side. The body carries a stable `type` and the request id and nothing else; the cause is in our logs. headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '503': description: >- A dependency this request needs is unavailable, so nothing was done. Retryable. Authentication fails closed rather than admitting the request, so this is never a statement about your credential. headers: X-Request-ID: description: >- The id of this request. The same value appears as `requestId` in the body. Quote it when contacting support. schema: type: string examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 content: application/problem+json: schema: $ref: '#/components/schemas/Problem' components: schemas: TemplateUpdateRequest: properties: contentMarkdown: type: string maxLength: 500000 minLength: 1 title: Contentmarkdown description: >- The COMPLETE new body as markdown. This replaces the whole template: a partial body is not something this format can express. Whitespace alone is refused. examples: - > # Mutual Non-Disclosure Agreement ## 1. Confidential Information Each party may disclose information that is confidential and proprietary to the other party. title: anyOf: - type: string maxLength: 300 minLength: 1 - type: 'null' title: Title description: New display name. Omit to leave it alone. examples: - Mutual NDA description: anyOf: - type: string maxLength: 2000 - type: 'null' title: Description description: New description. Omit to leave it alone. examples: - Master services agreement with Acme for the 2026 platform rollout. additionalProperties: false type: object required: - contentMarkdown title: TemplateUpdateRequest description: >- Replace a template's body, and optionally its title and description. A PUT rather than a PATCH, matching `drafts.update`: `contentMarkdown` is the WHOLE body, so sending one clause replaces the template with that clause. Title and description are left alone when omitted. Variables are re-detected from the new body and the frozen-text hash is recomputed in the same write. That hash is the renderer's integrity baseline over the non-variable segments, so leaving it stale would check the next run against the body the template used to have. **This is lossy against a DOCX-imported template.** The rich converter preserves Word formatting that markdown cannot express, and replacing the body through here discards it. Duplicate the template first if you want to keep the original. TemplateDetail: properties: id: type: string title: Id description: >- Public identifier, `tpl_` followed by 32 hex characters. Name it when starting a run. examples: - tpl_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 title: type: string title: Title description: The template's display name. examples: - Master Services Agreement description: anyOf: - type: string - type: 'null' title: Description description: Free-text description of what the template is for. examples: - Master services agreement with Acme for the 2026 platform rollout. category: type: string title: Category description: The template's category, as the customer classified it on upload. examples: - commercial sourceFilename: anyOf: - type: string - type: 'null' title: Sourcefilename description: >- Filename of the document this template was created from. Published because it is how a person recognizes which template a run used, months later. examples: - msa-acme-v3.docx createdAt: type: string format: date-time title: Createdat description: When the template was created (RFC 3339). examples: - '2026-08-19T14:32:10Z' updatedAt: type: string format: date-time title: Updatedat description: When the template was last modified (RFC 3339). examples: - '2026-08-19T14:32:10Z' variables: items: $ref: '#/components/schemas/TemplateVariable' type: array title: Variables description: >- Every fillable span, in document order. The `id` of each is what `slotOverrides` on a run is keyed by. sections: items: $ref: '#/components/schemas/DraftSection' type: array title: Sections description: >- The template body, section by section, with the placeholder text left in place. Send a replacement as `contentMarkdown`. additionalProperties: false type: object required: - id - title - category - createdAt - updatedAt - variables - sections title: TemplateDetail description: >- One template with everything needed to run it without guessing. `variables` is the reason this model exists at all, and `sections` is here for the same reason a draft publishes them: a caller deciding WHICH template to run needs to read what it says, and the editor's own document model does not cross this boundary in either direction. Problem: type: object title: Problem description: >- 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 (`requiredScopes`, `limit`, `expectedVersion`), which is why this object is open. required: - type - title - status - detail - instance properties: type: type: string format: uri description: >- The stable identifier for this error, and the one field to branch on. Resolves to a page describing it. examples: - https://vaquill.ai/docs/workspace-api/errors/insufficient-scope title: type: string description: A short human-readable summary. examples: - Insufficient scope status: type: integer description: The HTTP status code, repeated. examples: - 403 detail: type: string description: >- What went wrong on this specific request. May be reworded at any time. examples: - >- This credential carries matters:read. This operation needs matters:write. instance: type: string description: The path this problem occurred on. examples: - /workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 requestId: type: string description: >- The id of this request, identical to the `X-Request-ID` response header. Quote it when contacting support. examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 additionalProperties: true ValidationProblem: type: object title: ValidationProblem description: >- 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 failure cannot copy your content into an error response or into either side's logs. required: - type - title - status - detail - instance - errors properties: type: type: string format: uri description: >- The stable identifier for this error, and the one field to branch on. Resolves to a page describing it. examples: - https://vaquill.ai/docs/workspace-api/errors/insufficient-scope title: type: string description: A short human-readable summary. examples: - Insufficient scope status: type: integer description: The HTTP status code, repeated. examples: - 403 detail: type: string description: >- What went wrong on this specific request. May be reworded at any time. examples: - >- This credential carries matters:read. This operation needs matters:write. instance: type: string description: The path this problem occurred on. examples: - /workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 requestId: type: string description: >- The id of this request, identical to the `X-Request-ID` response header. Quote it when contacting support. examples: - req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 errors: type: array description: One entry per rejected field. items: type: object required: - location - message - type properties: location: type: string description: >- Dotted path to the rejected field, for example `body.contentMarkdown`. message: type: string description: Why it was rejected. type: type: string description: The validation rule that failed. additionalProperties: true TemplateVariable: properties: id: type: string title: Id description: >- The variable's `varId`, and the key to use in `slotOverrides` when you run this template. Stable across every run. examples: - party_a_name name: type: string title: Name description: The detected or authored name for this variable. examples: - Counterparty name label: anyOf: - type: string - type: 'null' title: Label description: Display label, when one was set. Falls back to `name`. examples: - Counterparty name kind: type: string title: Kind description: >- What sort of value belongs here: `party`, `date`, `money`, `jurisdiction`, `address`, `number`, `duration`, `text`, `other`. Drives how the extractor is constrained when it fills the slot. examples: - party hint: anyOf: - type: string - type: 'null' title: Hint description: Guidance the extractor was given for this variable. examples: - >- The counterparty's full legal entity name, as it appears on the signature block. defaultValue: anyOf: - type: string - type: 'null' title: Defaultvalue description: Value used when nothing is supplied or extracted. examples: - Acme Corporation position: type: integer title: Position description: Where this variable sits in the template body, counting from zero. examples: - 0 additionalProperties: false type: object required: - id - name - kind - position title: TemplateVariable description: >- One fillable span the template declares. Published because `slotOverrides` on a run is keyed by `id` and **nothing else on this surface publishes one**. Before this model existed, the only way to learn a template's keys was to run it once and read the slots back off the finished run, which is a paid LLM call to discover a schema. DraftSection: properties: heading: anyOf: - type: string - type: 'null' title: Heading description: >- The section's heading. Null for body text preceding the first heading, which is where a parties block or preamble lives. examples: - 8. Limitation of Liability level: anyOf: - type: integer - type: 'null' title: Level description: Heading depth, 1 to 6. Null when there is no heading. examples: - 1 text: type: string title: Text description: The text beneath this heading, as plain text. examples: - >- Neither party shall be liable for indirect or consequential damages. additionalProperties: false type: object required: - text title: DraftSection description: >- One heading and the text beneath it. `heading` is null for body text that precedes the first heading, which is where a parties block or a preamble lives. Dropping it because it has no heading would lose the first paragraph of most contracts. securitySchemes: WorkspaceAuth: type: http scheme: bearer bearerFormat: vq_ws_* description: >- Workspace credential issued from the automation console at `/automation`. Send it as `Authorization: Bearer vq_ws_...`. This is NOT a Data API key: a `vq_key_` credential is refused here and names the other product in the error. ````