Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Agent Playbooks

Create agent playbook

Creates a reusable agent playbook. Requires a USER API key.

post/public/v1/playbooks

Request body

namestring required
descriptionstring required
instructionsstring required
toolsstring[]
visibility'PRIVATE' | 'ACCOUNT'
isActiveboolean

Example request

{
  "name": "example",
  "description": "example value",
  "instructions": "example value",
  "tools": [
    "example"
  ],
  "visibility": "PRIVATE",
  "connectedAccountConfigs": [
    {
      "connectedAccountId": 1,
      "selectedToolSlugs": [
        "example"
      ]
    }
  ],
  "selectedRecordTypes": [
    {
      "recordTypeId": 1
    }
  ],
  "selectedCustomTools": [
    {
      "id": 1
    }
  ]
}

Response

Created playbook

idnumber required
namestring required
descriptionstring required
isActiveboolean required
instructionsstring required
toolsstring[] required
accountIdnumber required
createdByUserIdnumber nullable required
visibility'PRIVATE' | 'ACCOUNT' required
createdAtstring required
updatedAtstring required

Example response

{
  "id": 1,
  "name": "example",
  "description": "example",
  "instructions": "example",
  "tools": [
    "example"
  ],
  "accountId": 1,
  "createdByUserId": 1,
  "createdBy": {
    "id": 1,
    "firstName": "example",
    "lastName": "example",
    "email": "example",
    "avatar": "example"
  },
  "visibility": "PRIVATE",
  "createdAt": "example",
  "updatedAt": "example",
  "playbookConnectedAccounts": [
    {
      "id": 1,
      "connectedAccountId": 1,
      "selectedToolSlugs": [
        "example"
      ],
      "connectedAccount": {
        "id": 1,
        "toolkit": "example",
        "connectedEmail": "example",
        "alias": "example"
      }
    }
  ],
  "selectedRecordTypes": [
    {
      "recordTypeId": 1
    }
  ],
  "selectedCustomTools": [
    {
      "id": 1
    }
  ]
}