Skip to main content
POST
Screen an NDA against ten criteria and a playbook

Authorizations

Authorization
string
header
required

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.

Headers

Idempotency-Key
string | null

A unique value of your choosing, so a retried launch returns the FIRST operation instead of starting a second billable job. Reusing one with a different body is refused. Retrying with the same key and the same body is free and is the intended way to recover from a timeout.

Path Parameters

matterId
string
required

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.

Body

application/json

Screen one inbound NDA, optionally against one of your own playbooks.

documentText
string
required

The full NDA text to screen, 100 to 200,000 characters. Text rather than a document id: a triage reads one agreement end to end and the caller usually has it in hand, having just received it.

Required string length: 100 - 200000
Example:

"MASTER SERVICES AGREEMENT\n\nThis Master Services Agreement is entered into as of 1 September 2026 between Acme Corporation, a Delaware corporation, and the Supplier identified on the signature page.\n\n8. LIMITATION OF LIABILITY. Supplier's total liability shall be unlimited for any claim arising out of this Agreement.\n\n12. GOVERNING LAW. This Agreement is governed by the laws of the State of Delaware."

counterpartyName
string | null

Who sent it. Echoed back on the triage so a queue of screened NDAs is readable without a second lookup.

Maximum string length: 200
Example:

"Acme Corporation"

businessContext
string | null

What the NDA is for, in a sentence. Sharpens the routing recommendation; omitting it costs only specificity.

Maximum string length: 1000
Example:

"Mutual NDA ahead of diligence on a possible platform integration with Acme Corporation."

playbookId
string | null

pbk_ identifier of an NDA playbook to screen against. Must be a playbook whose contractType is nda; any other type is refused. Omit to screen against the built-in default NDA positions for jurisdiction.

Example:

"pbk_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

jurisdiction
string
default:US

Two-letter uppercase jurisdiction code, or INTL. Selects the built-in default NDA positions when no playbook is named, and is ignored when one is.

Pattern: ^([A-Z]{2}|INTL)$
Example:

"US"

Response

Successful Response

One long-running operation, whatever kind of work it is.

Readable for OPERATION_RETENTION_DAYS after creation, per AIP-151.

id
string
required

Public identifier, op_ followed by 32 hex characters. Poll GET /v1/operations/{operationId} with it.

Example:

"op_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

type
string
required

What kind of work this is, for example matrix.run or draft.generate.

Example:

"matrix.run"

status
enum<string>
required

One of five values: queued, running, succeeded, failed, cancelled. There is no sixth and there are no synonyms. Stop polling once it is succeeded, failed or cancelled.

Available options:
queued,
running,
succeeded,
failed,
cancelled
Example:

"succeeded"

createdAt
string<date-time>
required

When the operation was accepted (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

completedAt
string<date-time> | null

When the operation reached a terminal status (RFC 3339). Present if and only if the status is terminal.

Example:

"2026-08-19T14:32:10Z"

matterId
string | null

mat_ identifier of the matter this work belongs to, when it belongs to one.

Example:

"mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

resource
OperationResource · object | null

What the operation produced. Absent until the underlying job row exists, which an idempotent replay can briefly observe, so treat absence as 'not yet' rather than 'never'.

error
OperationError · object | null

Why the work failed. Present only when status is failed. Partial success is succeeded with progress.done < progress.total, never an error.

progress
OperationProgress · object | null

How far along the work is, when the underlying job reports it. Absent does not mean no progress.

requestId
string | null

The X-Request-ID of the request that created this operation. Quote it in a support ticket.

Example:

"req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

Last modified on August 23, 2026