Playbooks API
12 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.
| Method | Path | Description |
|---|---|---|
GET |
/api/playbooks/ |
List Playbooks Query: cta_type, active_only. |
POST |
/api/playbooks/ |
Create Playbook Accepts a JSON body. |
GET |
/api/playbooks/ai/ |
List Playbooks Query: status. |
POST |
/api/playbooks/ai/generate |
Generate Playbook Query: period. |
GET |
/api/playbooks/ai/{playbook_id} |
Get Playbook |
PUT |
/api/playbooks/ai/{playbook_id}/publish |
Publish Playbook |
GET |
/api/playbooks/{playbook_id} |
Get Playbook |
PATCH |
/api/playbooks/{playbook_id} |
Update Playbook Accepts a JSON body. |
DELETE |
/api/playbooks/{playbook_id} |
Delete Playbook |
POST |
/api/playbooks/{playbook_id}/tasks |
Create Playbook Task Accepts a JSON body. |
PATCH |
/api/playbooks/{playbook_id}/tasks/{task_id} |
Update Playbook Task Accepts a JSON body. |
DELETE |
/api/playbooks/{playbook_id}/tasks/{task_id} |
Delete Playbook Task |
Try it
The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.