> ## 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 an NDA triage > One triage: its screen, or its progress toward one. 404 covers every reason it is not readable, including a job of a different kind that happens to share the table. ## OpenAPI ````yaml https://api.vaquill.ai/workspace/openapi/v1.json get /v1/matters/{matterId}/nda-triages/{ndaTriageId} 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}/nda-triages/{ndaTriageId}: get: tags: - NDA triage summary: Get an NDA triage description: >- One triage: its screen, or its progress toward one. 404 covers every reason it is not readable, including a job of a different kind that happens to share the table. operationId: ndaTriages.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: ndaTriageId in: path required: true schema: type: string title: Ndatriageid description: >- `ndt_` identifier of the NDA triage. Returned on the operation that launched it. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/NdaTriage' example: id: ndt_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 matterId: mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 status: queued classification: value effectiveClassification: value summary: >- Twelve substantive changes, seven of them in the liability and indemnity sections. ndaType: value counterpartyName: value playbookId: value jurisdiction: US criteria: - criterionId: 1 criterionName: Term and Duration status: pass findings: >- Confidentiality obligations run for ten years from the effective date, with no separate treatment of trade secrets. issues: - value recommendation: value playbookAssessment: verdict: meets_standard playbookPosition: >- Cap liability at fees paid in the preceding twelve months. deviationSummary: value triggeredEscalations: - value passCount: 0 warnCount: 0 failCount: 0 keyIssues: - value routingRecommendation: value estimatedTimeline: value missingCarveouts: - value problematicProvisions: - value parseWarning: >- Two clauses could not be parsed and are omitted from the findings. createdAt: '2026-08-19T14:32:10Z' completedAt: '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: NdaTriage: properties: id: type: string title: Id description: Public identifier, `ndt_` followed by 32 hex characters. examples: - ndt_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 matterId: type: string title: Matterid description: '`mat_` identifier of the matter this triage belongs to.' examples: - mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 status: $ref: '#/components/schemas/OperationStatus' description: >- Triage status, using the same five public values as an operation. While `queued` or `running`, `criteria` is empty and the scalar fields are absent. That is the truthful shape of a screen that has not happened yet, not an error. examples: - queued classification: anyOf: - type: string - type: 'null' title: Classification description: >- The screen's own verdict: `green` (standard approval), `yellow` (counsel review) or `red` (significant issues). examples: - yellow effectiveClassification: anyOf: - type: string - type: 'null' title: Effectiveclassification description: >- The verdict after layering your playbook on top, which is the one to act on. A deal-breaker flips this to `red` even where the screen said `green`. Equal to `classification` when no playbook applied. examples: - red summary: type: string title: Summary description: Overall assessment, in prose. default: '' examples: - >- Twelve substantive changes, seven of them in the liability and indemnity sections. ndaType: anyOf: - type: string - type: 'null' title: Ndatype description: >- Structure of the agreement: `mutual`, `unilateral_disclosing`, `unilateral_receiving`, or `unknown`. examples: - mutual counterpartyName: anyOf: - type: string - type: 'null' title: Counterpartyname description: Counterparty, echoed from the request. examples: - Acme Corporation playbookId: anyOf: - type: string - type: 'null' title: Playbookid description: >- The playbook the triage actually ran against. Absent when it ran against the built-in defaults, so the two cases can be told apart after the fact. examples: - pbk_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6 jurisdiction: anyOf: - type: string - type: 'null' title: Jurisdiction description: Jurisdiction the default positions were drawn from. examples: - US criteria: items: $ref: '#/components/schemas/NdaTriageCriterion' type: array title: Criteria description: The ten screening criteria and their results. passCount: type: integer title: Passcount description: How many criteria passed. default: 0 examples: - 0 warnCount: type: integer title: Warncount description: How many criteria drew a warning. default: 0 examples: - 0 failCount: type: integer title: Failcount description: How many criteria failed. default: 0 examples: - 0 keyIssues: items: type: string type: array title: Keyissues description: The issues that need attention first. examples: - - value routingRecommendation: anyOf: - type: string - type: 'null' title: Routingrecommendation description: What to do next, given the classification. examples: - >- Route to counsel for full review before signature; do not sign as received. estimatedTimeline: anyOf: - type: string - type: 'null' title: Estimatedtimeline description: How long resolution is expected to take, for example `Same day`. examples: - 3-5 business days missingCarveouts: items: type: string type: array title: Missingcarveouts description: >- Standard carve-outs the NDA does not have. The one finding that cannot be expressed as a criterion result, because there is nothing there to assess. examples: - - value problematicProvisions: items: type: string type: array title: Problematicprovisions description: >- Provisions that do not belong in an NDA at all, for example a non-compete or an assignment of IP. examples: - - value parseWarning: anyOf: - type: string - type: 'null' title: Parsewarning description: >- Set when the model's output only partly parsed, which means the screen may be incomplete. Present is the difference between routing on it and asking a human first. examples: - Two clauses could not be parsed and are omitted from the findings. createdAt: type: string format: date-time title: Createdat description: When the triage was created (RFC 3339). examples: - '2026-08-19T14:32:10Z' completedAt: anyOf: - type: string format: date-time - type: 'null' title: Completedat description: When the triage reached a terminal status (RFC 3339). examples: - '2026-08-19T14:32:10Z' additionalProperties: false type: object required: - id - matterId - status - createdAt title: NdaTriage description: 'One NDA triage: its screen, or its progress toward 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. NdaTriageCriterion: properties: criterionId: type: integer title: Criterionid description: Stable number of this criterion, 1 through 10. examples: - 1 criterionName: type: string title: Criterionname description: What the criterion checks. examples: - Term and Duration status: type: string title: Status description: >- The screen's verdict on this criterion: `pass`, `warn`, `fail`, or `not_found` when the NDA is silent. examples: - pass findings: type: string title: Findings description: What the NDA actually says about this criterion. examples: - >- Confidentiality obligations run for ten years from the effective date, with no separate treatment of trade secrets. issues: items: type: string type: array title: Issues description: Specific problems identified. examples: - - value recommendation: anyOf: - type: string - type: 'null' title: Recommendation description: What to do about this criterion. examples: - >- Reduce the confidentiality term to five years and carve out trade secrets, which survive for as long as they remain secret. playbookAssessment: anyOf: - $ref: '#/components/schemas/NdaPlaybookAssessment' - type: 'null' description: >- Verdict against your playbook. Absent when no playbook applied to this criterion. additionalProperties: false type: object required: - criterionId - criterionName - status - findings title: NdaTriageCriterion description: One of the ten screening criteria, and what the NDA said about it. NdaPlaybookAssessment: properties: verdict: type: string title: Verdict description: >- How this criterion measures against the playbook: `meets_standard`, `within_acceptable_range`, `outside_range`, `deal_breaker_hit`, or `not_assessed` when the playbook has no entry for it. examples: - meets_standard playbookPosition: anyOf: - type: string - type: 'null' title: Playbookposition description: The standard position this criterion was measured against. examples: - Cap liability at fees paid in the preceding twelve months. deviationSummary: anyOf: - type: string - type: 'null' title: Deviationsummary description: >- How this NDA differs from the standard, in one line. For example `Your standard: 5y term cap; this NDA: 10y`. examples: - >- Your standard: confidentiality obligations expire five years after disclosure. triggeredEscalations: items: type: string type: array title: Triggeredescalations description: Which of the playbook's escalation triggers fired on this criterion. examples: - - value additionalProperties: false type: object required: - verdict title: NdaPlaybookAssessment description: |- One criterion measured against the organization's own positions. Computed deterministically from the playbook, not by the model: the LLM knows what a market NDA looks like and only the playbook knows what this firm will sign. 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. ````