Skip to main content
GET
Get a playbook extraction

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.

Path Parameters

extractionId
string
required

pex_ identifier of the playbook extraction. Returned on the operation that launched it. It names the extraction JOB, which is what exists from the moment the work is accepted.

Response

Successful Response

What an extraction found, in the shape a playbook takes.

A running extraction is a 200 with an EMPTY positions map and a truthful status, never a 404: a 404 would be indistinguishable from an extraction that never existed. Why one FAILED lives on the operation rather than here, so there is exactly one sanitizer for internal error text on this surface.

id
string
required

Public identifier, pex_ followed by 32 hex characters.

Example:

"pex_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

status
enum<string>
required

Where the extraction got to, in the same five values an operation uses. positions is empty until it reads succeeded.

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

"queued"

createdAt
string<date-time>
required

When the extraction was accepted (RFC 3339).

Example:

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

contractType
string | null

The contract type that was pinned or detected. Pass it to playbooks.create when you adopt these positions: a playbook's type decides which reviews resolve it.

Example:

"msa"

positions
Positions · object

The extracted positions, keyed by clause type. Review them, then send the map you want to keep to playbooks.create. Nothing here has been saved as a playbook.

truncated
boolean
default:false

True when the contract exceeded the extractor's block ceiling and some clauses were not read. The positions returned are correct; they are not complete. Split the contract and extract the remainder separately.

Example:

false

sourceDocumentId
string | null

doc_ identifier of the document this was read from, when one was named. Null for an extraction from contractText, which keeps no file.

Example:

"doc_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

completedAt
string<date-time> | null

When it reached a terminal status (RFC 3339).

Example:

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

Last modified on August 23, 2026