> ## 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. # Get a matter summary > One summary, section by section, with its citations. Sections hold claims and claims hold the passages behind them, already joined: there is no `sectionId` or `claimId` to reassemble. **Resolve a citation by finding its `quote` in the document's text**, not by any offset; none is published, because the ones we store index a string this API does not serve. `progress` on the operation moves in a few coarse jumps rather than smoothly: the pipeline writes to the job row only when its stage changes, so `Retry-After` over-waits between stages on a job whose median is five minutes. A `404` covers every reason it is not readable, including a `matter_summaries.id` used in place of the `sum_` id this API publishes. ## OpenAPI ````yaml https://api.vaquill.ai/workspace/openapi/v1.json get /v1/matters/{matterId}/summaries/{summaryId} 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}/summaries/{summaryId}: get: tags: - Matter summary summary: Get a matter summary description: >- One summary, section by section, with its citations. Sections hold claims and claims hold the passages behind them, already joined: there is no `sectionId` or `claimId` to reassemble. **Resolve a citation by finding its `quote` in the document's text**, not by any offset; none is published, because the ones we store index a string this API does not serve. `progress` on the operation moves in a few coarse jumps rather than smoothly: the pipeline writes to the job row only when its stage changes, so `Retry-After` over-waits between stages on a job whose median is five minutes. A `404` covers every reason it is not readable, including a `matter_summaries.id` used in place of the `sum_` id this API publishes. operationId: summaries.get 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: summaryId in: path required: true schema: type: string title: Summaryid description: >- `sum_` identifier of the matter summary. Returned on the operation that generated it. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MatterSummary' example: id: sum_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 matterId: mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 status: succeeded altitude: value title: Acme / Series B Financing matterType: financing isStale: false docCount: 1 docCountUsed: 1 docCountExcluded: 1 warnings: - value createdAt: '2026-08-19T14:32:10Z' completedAt: '2026-08-19T14:32:10Z' sections: - id: 9f2c8b1e-4a7d-43c9-b6e0-f1a2c3d4e5f6 title: Master Services Agreement position: 0 claims: - id: 3d7a1c05-8e64-4b2f-9a1d-7c5e8f0b2a41 text: >- Neither party shall be liable for indirect or consequential damages. position: 0 claimType: value eventDate: '2026-08-19' confidence: 0.92 citations: - label: 1 documentId: doc_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 documentName: value quote: >- in no event shall either party be liable for indirect damages pageStart: 1 pageEnd: 1 sourceAvailable: false '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: MatterSummary: properties: id: type: string title: Id description: >- `sum_` identifier. The same id the operation's resource carries, and the only id this API publishes for a summary. examples: - sum_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 matterId: type: string title: Matterid description: The `mat_` matter this summary covers. examples: - mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 status: $ref: '#/components/schemas/OperationStatus' description: >- The generation's status, in the same five values every operation uses. examples: - succeeded altitude: anyOf: - type: string - type: 'null' title: Altitude description: >- How much detail was synthesized. `executive` or `detailed`; read it as an open string, because the column carries no constraint. Null on the one row shape where it is genuinely unknown: `matter_summary_jobs` does not record the altitude, so a job whose summary row is gone has nothing to report and the commoner answer would be an invention. examples: - executive title: anyOf: - type: string - type: 'null' title: Title description: The title the synthesizer gave the matter. Null until it runs. examples: - Acme / Series B Financing matterType: anyOf: - type: string - type: 'null' title: Mattertype description: What the classifier decided the matter is. examples: - financing isStale: type: boolean title: Isstale description: >- True when the matter's documents have changed since this summary was built. Computed per request, never stored. A summary can also refresh ITSELF: a document change schedules a debounced regeneration for an altitude that already has a completed summary, so `isStale` can flip between two polls with no call from you. examples: - false docCount: type: integer title: Doccount description: Documents in the matter right now. examples: - 1 docCountUsed: anyOf: - type: integer - type: 'null' title: Doccountused description: Documents this generation read. examples: - 1 docCountExcluded: anyOf: - type: integer - type: 'null' title: Doccountexcluded description: Documents this generation skipped. examples: - 1 warnings: items: type: string type: array title: Warnings description: What the pipeline wants you to know about this result, if anything. examples: - - value createdAt: type: string format: date-time title: Createdat description: When the generation was requested. examples: - '2026-08-19T14:32:10Z' completedAt: anyOf: - type: string format: date-time - type: 'null' title: Completedat description: >- When the summary finished, read from the summary itself rather than from the job, which records no completion time. examples: - '2026-08-19T14:32:10Z' sections: anyOf: - items: $ref: '#/components/schemas/MatterSummarySection' type: array - type: 'null' title: Sections description: >- The rendered narrative. Present only on the by-id read; the list omits it rather than sending an empty array, so `null` here means 'not included in this response' and `[]` means 'nothing was written'. additionalProperties: false type: object required: - id - matterId - status - isStale - docCount - createdAt title: MatterSummary description: One generation of a matter summary, and its content once it has one. 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 OperationStatus: type: string enum: - queued - running - succeeded - failed - cancelled title: OperationStatus description: >- The public five. There is no sixth, and there are no synonyms. Internal vocabularies spell terminal success `completed`, `ready`, `extracted`, `succeeded` and `fresh`; terminal failure `failed` and `error`; queued `pending`, `queued` and `draft`. All of that is collapsed here by `app.workspace_api.adapters.status_map`, which refuses to guess. MatterSummarySection: properties: id: type: string title: Id description: Stable within this summary. examples: - 9f2c8b1e-4a7d-43c9-b6e0-f1a2c3d4e5f6 title: type: string title: Title description: The section heading. examples: - Master Services Agreement position: type: integer title: Position description: Reading order within the summary. examples: - 0 claims: items: $ref: '#/components/schemas/SummaryClaim' type: array title: Claims description: The section's claims. additionalProperties: false type: object required: - id - title - position title: MatterSummarySection description: One heading of the narrative. SummaryClaim: properties: id: type: string title: Id description: Stable within this summary. examples: - 3d7a1c05-8e64-4b2f-9a1d-7c5e8f0b2a41 text: type: string title: Text description: The claim, as one sentence. examples: - >- Neither party shall be liable for indirect or consequential damages. position: type: integer title: Position description: Reading order within the section. examples: - 0 claimType: anyOf: - type: string - type: 'null' title: Claimtype description: >- What kind of assertion this is, for example `general` or `event`. Publisher-controlled and open: read it, do not switch on a closed list. examples: - obligation eventDate: anyOf: - type: string format: date - type: 'null' title: Eventdate description: The date the claim is about, when it names one. examples: - '2026-08-19' confidence: anyOf: - type: number - type: 'null' title: Confidence description: 0 to 1. examples: - 0.92 citations: items: $ref: '#/components/schemas/SummaryCitation' type: array title: Citations description: Every passage behind this claim. additionalProperties: false type: object required: - id - text - position title: SummaryClaim description: One assertion inside a section, with the passages that support it. SummaryCitation: properties: label: type: integer title: Label description: >- The bracketed marker this citation carries within its section, numbered from 1 per section. Two sections both start at [1]. examples: - 1 documentId: anyOf: - type: string - type: 'null' title: Documentid description: The `doc_` document this passage came from. examples: - doc_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 documentName: anyOf: - type: string - type: 'null' title: Documentname description: The document's filename when the summary was generated. examples: - msa-acme-v3.docx quote: anyOf: - type: string - type: 'null' title: Quote description: >- The verbatim passage. Locate this string in the document's text to resolve the citation; there is no offset to trust. examples: - in no event shall either party be liable for indirect damages pageStart: anyOf: - type: integer - type: 'null' title: Pagestart description: First page the quote appears on. examples: - 1 pageEnd: anyOf: - type: integer - type: 'null' title: Pageend description: Last page the quote appears on. examples: - 1 sourceAvailable: type: boolean title: Sourceavailable description: >- False when the cited document has since been removed from the workspace. The quote is a snapshot and stays accurate; there is simply nothing left to open. examples: - false additionalProperties: false type: object required: - label - sourceAvailable title: SummaryCitation description: One passage behind a claim, snapshotted when the summary was generated. 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. ````