Max Playbooks are reusable instruction sets for the calling user's personal Max assistant. Two types:
MAIN_AGENT— workflows, procedures, and SOPs for chat (desktop app, WhatsApp, Slack).AUTO_DRAFTING— email-specific playbooks for tone, templates, and drafting instructions.
These steer Max itself. For playbooks on customer-facing agents, see Agent Playbooks.
Requires a USER API key. An unassigned playbook still exists but has no effect on how Max behaves.
| Field | Type | Notes |
|---|---|---|
id | number | Use as playbookId. |
name | string | 1–100 characters. |
description | string? | When to use it. Max 750 characters. |
type | enum | MAIN_AGENT · AUTO_DRAFTING. |
instructions | string | 10–10,000 characters. |
isActive | boolean | Default true. |
visibility | enum | PRIVATE (default) · ACCOUNT. |
isAssigned | boolean? | Whether it is attached to the caller's Max. New playbooks are assigned by default. |
tools | array | System tool names. Tool/resource scoping applies to AUTO_DRAFTING; MAIN_AGENT runs in a sandbox with full access. |
integrations | array? | Toolkit slugs the playbook may use. Discover them with Max Connectors. |
appliesToAllAccounts | boolean | AUTO_DRAFTING only. Default true (every connected mailbox). |
connectedAccountIds | array? | AUTO_DRAFTING only. Scope to specific Gmail/Outlook accounts. |
| Verb | Path | Purpose |
|---|---|---|
GET | /public/v1/max/playbooks | List + account quota |
POST | /public/v1/max/playbooks | Create |
GET | /public/v1/max/playbooks/{playbookId} | Detail |
PATCH | /public/v1/max/playbooks/{playbookId} | Update (partial) |
DELETE | /public/v1/max/playbooks/{playbookId} | Delete |
POST | /public/v1/max/playbooks/{playbookId}/assignment | Assign or unassign |
Only the creator can update or delete a playbook.
Full list in the API Reference under the Max Playbooks tag.
max playbooks list --type MAIN_AGENT --pretty
max playbooks create \
--type MAIN_AGENT \
--name "Weekly status update" \
--instructions "When asked for a status update, pull open deals and summarize by stage."
max playbooks assign 42
max playbooks unassign 42