Skip to main content
POST
Create a playbook from a starter template

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.

Body

application/json

Adopt one of our starter templates as an organization playbook.

The result is an ordinary playbook, owned by the organization and editable. Nothing links it back to the template afterwards: a template is a starting point, and a live link would imply an update path that does not exist.

templateSlug
string
required

slug of the starter template to adopt, from GET /v1/playbook-templates.

Maximum string length: 120
Example:

"msa-buyer-side"

name
string | null

Name for the new playbook. Omit to take the template's own name.

Required string length: 1 - 200
Example:

"Acme Corporation"

description
string | null

Description for the new playbook. Omit to take the template's own.

Maximum string length: 1000
Example:

"Master services agreement with Acme for the 2026 platform rollout."

jurisdiction
string | null

Two-letter uppercase jurisdiction code, or INTL. Selects which default positions the template resolves.

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

"US"

Response

Successful Response

One organization playbook, with every position it holds.

Positions are returned in full rather than summarized. A playbook is the input to a review, so a caller that cannot read the positions cannot tell what its reviews are being measured against, and a separate positions endpoint would make the common case two calls.

id
string
required

Public identifier, pbk_ followed by 32 hex characters.

Example:

"pbk_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

name
string
required

The playbook's display name.

Example:

"MSA, buyer side"

contractType
string
required

Which contract type this playbook governs. Fixed at creation: changing it would silently redirect which reviews resolve it.

Example:

"msa"

description
string | null

Free-text description of what this playbook covers.

Example:

"Master services agreement with Acme for the 2026 platform rollout."

positions
Positions · object

Every negotiating position the playbook holds, keyed by clause-type slug. Returned in full, because a caller that cannot read the positions cannot tell what its reviews are measured against.

isDefault
boolean
default:false

True when reviews of this contract type resolve to this playbook if none is named. Read-only here: exactly one default per contract type is enforced by the database, and this API cannot set it.

Example:

false

sourceFilename
string | null

Filename of the exemplar this playbook was extracted from, when it was imported rather than authored by hand.

Example:

"msa-acme-v3.docx"

createdAt
string<date-time> | null

When the playbook was created (RFC 3339).

Example:

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

updatedAt
string<date-time> | null

When the playbook was last modified (RFC 3339).

Example:

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

Last modified on August 23, 2026