Skip to main content
POST
Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive 403 mcp_not_enabled. See the preview overview.
Creates a playbook. A playbook is a saved set of checks that a playbook review runs against a document. You can send the checks now, or add them later with Add Check. The playbook is created whole or not at all: if saving its description or any check fails, the request fails and no playbook is left behind, so you can retry it. A new playbook is visible only to you. Share it with your team through Update Sharing. You can run a review with it before you share it. To build a playbook from example contracts instead of writing the checks yourself, use Generate Playbook.

Authentication

Requires an API key, or an OAuth token with playbooks:write.

Body parameters

string
required
The playbook name, up to 200 characters.
string
What the playbook is for, such as the contract type and the side it acts for. Up to 2,000 characters.
object[]
default:"[]"
Up to 100 checks, in the order a review runs them. Each check takes the body of Add Check:

Response

Returns 201 with the new playbook. Each check now has an id.

Errors