Skip to main content
POST
/
v1
/
playbooks
/
run
RunPlaybook
curl --request POST \
  --url https://app.textql.com/v1/playbooks/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "playbookId": "<string>",
  "dryRun": true,
  "templateId": "<string>"
}
'
{
  "chatId": "<string>",
  "report": {
    "subject": "<string>",
    "summary": "<string>",
    "blocks": [
      {
        "card": {
          "blocks": "<array>"
        }
      }
    ],
    "htmlPreview": "<string>",
    "chatId": "<string>",
    "reportId": "<string>"
  },
  "assets": [
    {
      "target": "<string>",
      "previewType": "<string>",
      "name": "<string>",
      "url": "<string>",
      "content": "<string>",
      "error": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
playbookId
string

UUID of the playbook to run

Minimum string length: 1
dryRun
boolean

If true, executes the playbook without sending notifications (email/Slack)

templateId
string | null

UUID of the template data row to use. Not currently supported via the platform API.

Response

Success

chatId
string

UUID of the chat created for this run

report
report · object

The generated report from the playbook execution

assets
PreviewCell · object[]

Preview assets (charts, images, etc.) generated during execution