> ## 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. # Update a chronology event > Correct an event. Omitted fields are left alone. A PATCH, so send only what changes. An explicit null clears `description` or `eventDateEnd`; every other field is backed by a NOT NULL column and a null for one is refused by name. `documentId` is not patchable: which document an event came from is provenance, and re-pointing it would make an extracted event claim a source it was never read from. ## OpenAPI ````yaml https://api.vaquill.ai/workspace/openapi/v1.json patch /v1/matters/{matterId}/chronology/events/{eventId} 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/matters/{matterId}/chronology/events/{eventId}: patch: tags: - Chronology summary: Update a chronology event description: >- Correct an event. Omitted fields are left alone. A PATCH, so send only what changes. An explicit null clears `description` or `eventDateEnd`; every other field is backed by a NOT NULL column and a null for one is refused by name. `documentId` is not patchable: which document an event came from is provenance, and re-pointing it would make an extracted event claim a source it was never read from. operationId: chronologyEvents.update parameters: - name: matterId in: path required: true schema: type: string title: Matterid description: >- `mat_` identifier of the matter to work inside. Everything in this API hangs off a matter, and the matter in the path is what the authorization boundary is checked against. Take it from `GET /v1/matters`. - name: eventId in: path required: true schema: type: string title: Eventid description: >- `evt_` identifier of one chronology event. Take it from the matter's chronology. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ChronologyEventUpdateRequest' example: eventDate: '2026-08-19' eventDateEnd: '2026-08-19' eventDateApproximate: false eventType: signed category: contract_event title: Master Services Agreement description: >- Master services agreement with Acme for the 2026 platform rollout. parties: - value tags: - saas - buyer-side significance: high responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ChronologyEvent' example: id: evt_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 matterId: mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 documentId: doc_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 documentName: value eventDate: '2026-08-19' eventDateEnd: '2026-08-19' eventDateApproximate: false eventType: signed category: commercial significance: high title: Master Services Agreement description: >- Master services agreement with Acme for the 2026 platform rollout. parties: - value tags: - saas - buyer-side sourceText: value sourcePageNumber: 1 isAiExtracted: false confidenceScore: 1 isPrimaryInGroup: false createdAt: '2026-08-19T14:32:10Z' updatedAt: '2026-08-19T14:32:10Z' '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: ChronologyEventUpdateRequest: properties: eventDate: anyOf: - type: string format: date - type: 'null' title: Eventdate description: When it happened. examples: - '2026-08-19' eventDateEnd: anyOf: - type: string format: date - type: 'null' title: Eventdateend description: The end of a date range. Send null to clear it. examples: - '2026-08-19' eventDateApproximate: anyOf: - type: boolean - type: 'null' title: Eventdateapproximate description: True when the date is an estimate rather than a record. examples: - false eventType: anyOf: - type: string enum: - signed - executed - filed - served - effective - expired - terminated - notice_sent - notice_received - payment - hearing - meeting - judgment - order - correspondence - amended - enacted - published - decided - incident - referenced - founded - incorporated - appointed - resigned - acquired - launched - awarded - approved - registered - commenced - completed - transferred - invested - dissolved - announced - renewed - other - type: 'null' title: Eventtype description: What happened. examples: - signed category: anyOf: - type: string enum: - contract_event - court_filing - correspondence - payment_financial - deadline_notice - meeting_hearing - legislative - case_law - historical - corporate - regulatory - employment - milestone - other - type: 'null' title: Category description: Which swim lane it joins. examples: - contract_event title: anyOf: - type: string maxLength: 500 minLength: 1 - type: 'null' title: Title description: A one-line description. examples: - Master Services Agreement description: anyOf: - type: string maxLength: 5000 - type: 'null' title: Description description: The longer account. Send null to clear it. examples: - Master services agreement with Acme for the 2026 platform rollout. parties: anyOf: - items: type: string type: array maxItems: 50 - type: 'null' title: Parties description: Who was involved. Replaces the whole list. examples: - - value tags: anyOf: - items: type: string type: array maxItems: 30 - type: 'null' title: Tags description: Free-form labels. Replaces the whole list. examples: - - saas - buyer-side significance: anyOf: - type: string enum: - high - medium - low - type: 'null' title: Significance description: '`high`, `medium` or `low`.' examples: - high additionalProperties: false type: object title: ChronologyEventUpdateRequest description: >- Fields to change. Omitted fields are left alone. An explicit null clears `description` or `eventDateEnd`. Every other field here is backed by a NOT NULL column, so a null for one is refused by name rather than passed to the database. `documentId` is deliberately not patchable: which document an event came from is provenance, and re-pointing it would make an extracted event claim a source it was never read from. ChronologyEvent: properties: id: type: string title: Id description: '`evt_` identifier.' examples: - evt_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 matterId: type: string title: Matterid description: The `mat_` matter this event belongs to. examples: - mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 documentId: anyOf: - type: string - type: 'null' title: Documentid description: >- The `doc_` document this event was extracted from, or null for an event somebody entered by hand. examples: - doc_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 documentName: anyOf: - type: string - type: 'null' title: Documentname description: That document's filename, resolved at read time. examples: - msa-acme-v3.docx eventDate: type: string format: date title: Eventdate description: When it happened. examples: - '2026-08-19' eventDateEnd: anyOf: - type: string format: date - type: 'null' title: Eventdateend description: The end of the range, for an event that spans days. examples: - '2026-08-19' eventDateApproximate: type: boolean title: Eventdateapproximate description: True when the source dated this loosely ('early 2024'). examples: - false eventType: type: string title: Eventtype description: >- What happened, for example `signed`, `filed` or `hearing`. Read it as an open string: the column carries no constraint, so production can hold a value this API would refuse on a write. examples: - signed category: type: string title: Category description: The swim lane it groups into. Open, as `eventType` is. examples: - commercial significance: type: string title: Significance description: '`high`, `medium` or `low`. Open, as above.' examples: - high title: type: string title: Title description: A one-line description of the event. examples: - Master Services Agreement description: anyOf: - type: string - type: 'null' title: Description description: The longer account, when there is one. examples: - Master services agreement with Acme for the 2026 platform rollout. parties: items: type: string type: array title: Parties description: Who was involved. examples: - - value tags: items: type: string type: array title: Tags description: Free-form labels. examples: - - saas - buyer-side sourceText: anyOf: - type: string - type: 'null' title: Sourcetext description: >- The passage the event was extracted from. Locate this string in the document's text to find it; there is no offset to trust. examples: - >- This Master Services Agreement is entered into as of 19 August 2026 between Acme Corporation, a Delaware corporation, and the Supplier identified on the signature page. sourcePageNumber: anyOf: - type: integer - type: 'null' title: Sourcepagenumber description: The page the passage was found on, when it could be resolved. examples: - 1 isAiExtracted: type: boolean title: Isaiextracted description: >- False for an event created through this API or typed into the product. examples: - false confidenceScore: anyOf: - type: number - type: 'null' title: Confidencescore description: 0 to 1 for an extracted event, null for a manual one. examples: - 1 isPrimaryInGroup: type: boolean title: Isprimaryingroup description: >- False when this event duplicates another and was not chosen as the representative. Pass `primaryOnly=true` to drop the non-primary copies. examples: - false createdAt: type: string format: date-time title: Createdat description: When the row was written. examples: - '2026-08-19T14:32:10Z' updatedAt: type: string format: date-time title: Updatedat description: When it last changed. examples: - '2026-08-19T14:32:10Z' additionalProperties: false type: object required: - id - matterId - eventDate - eventDateApproximate - eventType - category - significance - title - isAiExtracted - isPrimaryInGroup - createdAt - updatedAt title: ChronologyEvent description: One dated event on the matter's timeline. 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 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. ````